evOo-local/packages/logging/src/axiom.ts

import { Axiom } from "@axiomhq/js";
import { createServiceLogger } from "./env.js";
import { installLogger } from "./logger.js";
import { guardedFlush, guardedWrite, reportSinkError } from "./sink-guard.js";
import type { LogEvent, Logger, LogSink } from "./types.js";

export interface AxiomIngestClient {
  ingest(dataset: string, events: object[]): void;
  flush(): Promise<void>;
}

export interface AxiomSinkOptions {
  dataset: string;
  token?: string;
  edge?: string;
  edgeUrl?: string;
  client?: AxiomIngestClient;
}

const EDGE_HOST = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$/i;

export function createAxiomSink(options: AxiomSinkOptions): LogSink {
  const client =
    options.client ??
    new Axiom({
      token: options.token ?? "",
      ...(options.edge ? { edge: options.edge } : {}),
      ...(options.edgeUrl ? { edgeUrl: options.edgeUrl } : {}),
      onError: reportSinkError,
    });
  const dataset = options.dataset;
  return {
    write(event: LogEvent) {
      guardedWrite(() => {
        client.ingest(dataset, [event]);
      });
    },
    flush() {
      return guardedFlush(() => client.flush());
    },
  };
}

export function createAxiomSinkFromEnv(
  source: NodeJS.ProcessEnv = process.env,
  client?: AxiomIngestClient,
): { sink?: LogSink; warning?: string } {
  const token = source.AXIOM_TOKEN?.trim();
  const dataset = source.AXIOM_DATASET?.trim();
  const edge = source.AXIOM_EDGE?.trim() || undefined;
  const edgeUrl = source.AXIOM_EDGE_URL?.trim() || undefined;
  const partial = Boolean(token || dataset || edge || edgeUrl);
  if (token && dataset) {
    const resolved = resolveAxiomEdge(edge, edgeUrl);
    if (resolved.warning) return { warning: resolved.warning };
    return {
      sink: createAxiomSink({
        token,
        dataset,
        edge: resolved.edge,
        edgeUrl: resolved.edgeUrl,
        client,
      }),
    };
  }
  if (partial) {
    return {
      warning: "Axiom logging is disabled; AXIOM_TOKEN and AXIOM_DATASET must both be set.",
    };
  }
  return {};
}

export function createRootLogger(service: string, env: NodeJS.ProcessEnv = process.env): Logger {
  const axiom = createAxiomSinkFromEnv(env);
  const logger = createServiceLogger({
    service,
    env,
    extraSinks: axiom.sink ? [axiom.sink] : [],
  });
  if (axiom.warning) logger.warn(axiom.warning);
  installLogger(logger);
  return logger;
}

function resolveAxiomEdge(
  edge?: string,
  edgeUrl?: string,
): { edge?: string; edgeUrl?: string; warning?: string } {
  if (edgeUrl) {
    let url: URL;
    try {
      url = new URL(edgeUrl);
    } catch {
      return { warning: "Axiom logging is disabled; AXIOM_EDGE_URL is not a valid URL." };
    }
    if (url.protocol !== "https:") {
      return { warning: "Axiom logging is disabled; AXIOM_EDGE_URL must use https." };
    }
    if (url.username || url.password) {
      return { warning: "Axiom logging is disabled; AXIOM_EDGE_URL must not include credentials." };
    }
    return { edgeUrl: url.toString().replace(/\/$/, "") };
  }
  if (edge) {
    if (edge.includes("://") || edge.includes("/") || edge.includes("@") || !EDGE_HOST.test(edge)) {
      return {
        warning:
          "Axiom logging is disabled; AXIOM_EDGE must be a hostname such as eu-central-1.aws.edge.axiom.co.",
      };
    }
    return { edge };
  }
  return {};
}