@guard-sdk/otel API

This spec is generated from package entry exports and updates on every website build.

Need package context first? Visit @guard-sdk/otel package docs.

Exported Symbols

Export Declarations

export declare const GUARD_TELEMETRY_SCHEMA_VERSION: "1.0";
export type GuardTelemetrySchemaVersion = typeof GUARD_TELEMETRY_SCHEMA_VERSION;
export declare const GUARD_TELEMETRY_ATTRIBUTE_KEYS: { readonly schemaVersion: "guard.schema_version";
export type GuardTelemetryAttributeKey = (typeof GUARD_TELEMETRY_ATTRIBUTE_KEYS)[keyof typeof GUARD_TELEMETRY_ATTRIBUTE_KEYS];
export type OpenTelemetryAttributeValue = | string | number | boolean | string[] | number[] | boolean[];
export type GuardTelemetryAttributes = Partial< Record<GuardTelemetryAttributeKey, OpenTelemetryAttributeValue> >;
export declare const OPEN_TELEMETRY_SPAN_STATUS_CODE: { readonly UNSET: 0;
export type OpenTelemetrySpanStatusCode = (typeof OPEN_TELEMETRY_SPAN_STATUS_CODE)[keyof typeof OPEN_TELEMETRY_SPAN_STATUS_CODE];
export type OpenTelemetrySpanStatus = { code: OpenTelemetrySpanStatusCode;
export type OpenTelemetrySpan = { setAttributes: (attributes: GuardTelemetryAttributes) => void;
export type OpenTelemetryTracer = { startSpan: ( name: string, options?: { attributes?: GuardTelemetryAttributes }, ) => OpenTelemetrySpan;
export type OpenTelemetryLogRecord = { body: string;
export type OpenTelemetryLogEmitter = { emit: (record: OpenTelemetryLogRecord) => void;
export type OpenTelemetryLoggerConfig = { tracer?: OpenTelemetryTracer;
export declare function createOpenTelemetryLogger(config: OpenTelemetryLoggerConfig): GuardLogger;
export declare function toGuardTelemetryAttributes(usage: GuardUsage): GuardTelemetryAttributes;
export type { GuardStatus, GuardUsage };

JSON Spec

{
  "package": "@guard-sdk/otel",
  "version": "0.5.0",
  "exports": [
    {
      "kind": "unknown",
      "name": "export",
      "source": null
    },
    {
      "kind": "type",
      "name": "GuardTelemetrySchemaVersion",
      "source": null
    },
    {
      "kind": "unknown",
      "name": "export",
      "source": null
    },
    {
      "kind": "type",
      "name": "GuardTelemetryAttributeKey",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetryAttributeValue",
      "source": null
    },
    {
      "kind": "type",
      "name": "GuardTelemetryAttributes",
      "source": null
    },
    {
      "kind": "unknown",
      "name": "export",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetrySpanStatusCode",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetrySpanStatus",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetrySpan",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetryTracer",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetryLogRecord",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetryLogEmitter",
      "source": null
    },
    {
      "kind": "type",
      "name": "OpenTelemetryLoggerConfig",
      "source": null
    },
    {
      "kind": "function",
      "name": "createOpenTelemetryLogger",
      "source": null
    },
    {
      "kind": "function",
      "name": "toGuardTelemetryAttributes",
      "source": null
    },
    {
      "kind": "unknown",
      "name": "export",
      "source": null
    }
  ]
}