@axiomhq/logging/src/transports/axiom-js.ts

The official logging package for Axiom

import { Axiom, AxiomWithoutBatching } from '@axiomhq/js';
import { LogLevel, LogLevelValue } from '../logger';
import { Version } from '../runtime';
import { Transport } from './transport';

interface AxiomJSTransportConfig {
  axiom: Axiom | AxiomWithoutBatching;
  dataset: string;
  logLevel?: LogLevel;
  /**
   * Additional product tokens to append to the X-Axiom-Client header.
   * Use product/version tokens separated by spaces.
   *
   * @example "axiom-react/1.2.3 my-app/4.5.6"
   */
  axiomClient?: string;
}

type AxiomClientClient = {
  appendAxiomClient?: (axiomClient: string) => void;
};

export const axiomClient = `axiom-logging/${Version ?? 'unknown'}`;

export class AxiomJSTransport implements Transport {
  private config: AxiomJSTransportConfig;
  private promises: Promise<any>[] = [];

  constructor(config: AxiomJSTransportConfig) {
    this.config = config;
    this.appendAxiomClient(config.axiomClient ? `${axiomClient} ${config.axiomClient}` : axiomClient);
  }

  appendAxiomClient(axiomClient: string) {
    (this.config.axiom as AxiomClientClient).appendAxiomClient?.(axiomClient);
  }

  log(logs: any[]) {
    const filteredLogs = logs.filter(
      (log) =>
        LogLevelValue[(log.level as LogLevel) ?? LogLevel.info] >= LogLevelValue[this.config.logLevel ?? LogLevel.info],
    );

    if (filteredLogs.length === 0) {
      return;
    }

    if (this.config.axiom instanceof Axiom) {
      this.config.axiom.ingest(this.config.dataset, filteredLogs);
    } else if (this.config.axiom instanceof AxiomWithoutBatching) {
      this.promises.push(this.config.axiom.ingest(this.config.dataset, filteredLogs));
    }
  }

  async flush() {
    if (this.config.axiom instanceof Axiom) {
      await this.config.axiom.flush();
    } else {
      await Promise.allSettled(this.promises);
    }
    this.promises = [];
  }
}