Send data from Python app to Axiom

Prerequisites#

• Create an Axiom account.
• Create a dataset in Axiom where you send your data.
• Create an API token in Axiom with permissions to ingest data to the dataset you have created.

Install SDK#

python3 -m pip install axiom-py

py -m pip install axiom-py

pip3 install axiom-py

If you use the Axiom CLI, run eval $(axiom config export -f) to configure your environment variables. Otherwise, create an API token and export it as AXIOM_TOKEN.

You can also configure the client using options passed to the client constructor:

import axiom_py
 
client = axiom_py.Client("API_TOKEN")

Use client#

import axiom_py
 
client = axiom_py.Client()
 
client.ingest_events(
    dataset="DATASET_NAME",
    events=[
        {"foo": "bar"},
        {"bar": "baz"},
    ])
client.query(r"['DATASET_NAME'] | where foo == 'bar' | limit 100")

For more examples, see the examples in GitHub.

Configure region#

By default, the client sends data to api.axiom.co. To target a specific edge region, pass the edge argument with the edge domain that matches the region your dataset lives in:

import axiom_py
 
client = axiom_py.Client(
    token="xaat-your-api-token",
    edge="eu-central-1.aws.edge.axiom.co",
)

import axiom_py
 
client = axiom_py.Client(
    token="xaat-your-api-token",
    edge="us-east-1.aws.edge.axiom.co",
)

The following edge domains are available:

For more information about edge deployments, see Edge deployments.

To point at a custom edge endpoint such as a proxy or load balancer, use edge_url="https://your-edge-host" instead. edge_url takes precedence over edge if both are set.

Example with AxiomHandler#

The example below uses AxiomHandler to send logs from the logging module to Axiom:

import axiom_py
from axiom_py.logging import AxiomHandler
import logging
 
def setup_logger():
    client = axiom_py.Client()
    handler = AxiomHandler(client, "DATASET_NAME")
    logging.getLogger().addHandler(handler)

For a full example, see GitHub.

Example with structlog#

The example below uses structlog to send logs to Axiom. structlog isn't a dependency of the Axiom Python SDK, so install it separately with pip install structlog.

AxiomProcessor passes the event dictionary on unchanged so that later processors can run. Place a renderer such as structlog.dev.ConsoleRenderer() after it as the last processor. Without a renderer, structlog's logger receives a dictionary and raises a TypeError.

from axiom_py import Client
from axiom_py.structlog import AxiomProcessor
import structlog
 
def setup_logger():
    client = Client()
 
    structlog.configure(
        processors=[
            structlog.processors.add_log_level,
            structlog.processors.TimeStamper(fmt="iso", key="_time"),
            AxiomProcessor(client, "DATASET_NAME"),
            structlog.dev.ConsoleRenderer(),
        ]
    )

For a full example, see GitHub.