examples

package

v0.9.0-rc.2 Latest Latest Go to latest Published: Feb 17, 2022 License: MIT Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/axiomhq/axiom-go

README ¶

Examples

Before you start

Axiom Go and the Adapters automatically pick up their configuration from the environment, if not otherwise specified. To learn more about configuration, check the Documentation.

To quickstart, export the environment variables below.

When using Axiom Cloud

AXIOM_TOKEN: API or Personal Access token. Can be created under Settings > API Tokens or Profile. For security reasons it is advised to use an API token with minimal privileges only.
AXIOM_ORG_ID: Organization identifier of the organization to use on Axiom Cloud (when using a personal access token).
AXIOM_DATASET: Dataset to use. Must exist prior to using it.

When using Axiom Selfhost

AXIOM_URL: URL of the Axiom deployment to use.
AXIOM_TOKEN: API or Personal Access token. Can be created under Settings > API Tokens or Profile. For security reasons it is advised to use an API token with minimal privileges only.
AXIOM_DATASET: Dataset to use. Must exist prior to using it.

Package usage

apl: How to query a dataset using the Kusto-like Axiom Processing Language (APL).
ingestfile: How to ingest the contents of a file into Axiom and compress them on the fly.
query: How to query a dataset using the datatypes provided by Axiom Go.

Adapter usage

apex: How to ship logs to Axiom using the popular Apex logging package.
logrus: How to ship logs to Axiom using the popular Logrus logging package.
zap: How to ship logs to Axiom using the popular Zap logging package.

Documentation ¶

Overview ¶

Package examples contains code examples on how to use Axiom Go.

Source Files ¶

View all Source files

doc.go

Directories ¶

Path	Synopsis
apex The purpose of this example is to show how to integrate with apex.	The purpose of this example is to show how to integrate with apex.
apl The purpose of this example is to show how to query a dataset using the Axiom Processing Language (APL).	The purpose of this example is to show how to query a dataset using the Axiom Processing Language (APL).
ingestfile The purpose of this example is to show how to stream the contents of a JSON logfile and gzip them on the fly.	The purpose of this example is to show how to stream the contents of a JSON logfile and gzip them on the fly.
logrus The purpose of this example is to show how to integrate with logrus.	The purpose of this example is to show how to integrate with logrus.
query The purpose of this example is to show how to query a dataset.	The purpose of this example is to show how to query a dataset.
zap The purpose of this example is to show how to integrate with zap.	The purpose of this example is to show how to integrate with zap.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL