Send data from JavaScript app to Axiom

• @axiomhq/js
• @axiomhq/logging

​

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.

​

Use @axiomhq/js

​

Install @axiomhq/js

npm install @axiomhq/js

​

Configure environment variables

• Export the API token as AXIOM_TOKEN.
• Pass the API token to the constructor of the client:
  import { Axiom } from '@axiomhq/js';
  
  const axiom = new Axiom({
    token: process.env.AXIOM_TOKEN,
  });
  
• Install the Axiom CLI, and then run the following command:
  eval $(axiom config export -f)
  

​

Configure region

import { Axiom } from '@axiomhq/js';

const axiom = new Axiom({
  token: process.env.AXIOM_TOKEN,
  edge: 'eu-central-1.aws.edge.axiom.co',
});

import { Axiom } from '@axiomhq/js';

const axiom = new Axiom({
  token: process.env.AXIOM_TOKEN,
  edge: 'us-east-1.aws.edge.axiom.co',
});

​

Client options

​

Send data to Axiom

axiom.ingest('DATASET_NAME', [{ foo: 'bar' }]);
await axiom.flush();

​

Query data

const res = await axiom.query(`['DATASET_NAME'] | where foo == 'bar' | limit 100`);
console.log(res);

​

Capture errors

let client = new Axiom({
  token: '',
  ...,
  onError: (err) => {
    console.error('ERROR:', err);
  }
});

​

Create annotations

import { annotations } from '@axiomhq/js';

const client = new annotations.Service({ token: process.env.AXIOM_TOKEN });

await annotations.create({
  type: 'deployment',
  datasets: ['DATASET_NAME'],
  title: 'New deployment',
  description: 'Deployed version 1.0.0',
})

​

Use @axiomhq/logging

​

Install @axiomhq/logging

npm install @axiomhq/logging

​

Send data to Axiom

import { Logger, AxiomJSTransport, ConsoleTransport } from "@axiomhq/logging";
import { Axiom } from "@axiomhq/js";

const axiom = new Axiom({
  token: process.env.AXIOM_TOKEN,
});

const logger = new Logger(
  {
    transports: [
      new AxiomJSTransport({ 
        axiom,
        dataset: process.env.AXIOM_DATASET,
      }),
      new ConsoleTransport(),
    ],
  }
);

logger.info("Hello, world!");

​

Transports

• ConsoleTransport: Logs to the console.
  import { ConsoleTransport } from "@axiomhq/logging";
  
  const transport = new ConsoleTransport({
    logLevel: "warn",
    prettyPrint: true,
  });
  
• AxiomJSTransport: Sends logs to Axiom using the @axiomhq/js library.
  import { Axiom } from "@axiomhq/js";
  import { AxiomJSTransport } from "@axiomhq/logging";
  
  const axiom = new Axiom({
    token: process.env.AXIOM_TOKEN,
  });
  
  const transport = new AxiomJSTransport({
    axiom,
    dataset: process.env.AXIOM_DATASET,
    logLevel: "warn",
  });
  
• ProxyTransport: Sends logs the proxy server function that acts as a proxy between your application and Axiom. It’s particularly useful when your application runs on top of a server-enabled framework like Next.js or Remix.
  import { ProxyTransport } from "@axiomhq/logging";
  
  const transport = new ProxyTransport({
    url: "/proxy",
    logLevel: "warn",
    autoFlush: { durationMs: 1000 },
  });
  

import { Transport } from "@axiomhq/logging";

class MyTransport implements Transport {
  log(log: Transport['log']) {
    console.log(log);
  }

  flush() {
    console.log("Flushing logs");
  }
}

​

Logging levels

• debug: Debug-level logs.
• info: Informational logs.
• warn: Warning logs.
• error: Error logs.

​

Formatters

import { Logger, LogEvent } from "@axiomhq/logging";

const myCustomFormatter = (event: LogEvent) => {
  const upperCaseKeys = {
    ...event,
    fields: Object.fromEntries(
      Object.entries(event.fields).map(([key, value]) => [key.toUpperCase(), value])
    ),
  };

  return upperCaseKeys;
};

const logger = new Logger({
  formatters: [myCustomFormatter],
});

logger.info("Hello, world!");

​

Related logging options

​

Send data from JavaScript libraries and frameworks

• Send data from React app
• Send data from Next.js app

​

Send data from Node.js

• Pino
• Winston