@dxos/observability 0.6.3-main.e6314a6 → 0.6.3-main.fe243fc

package/src/otel/logs.ts

@@ -1,86 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { SeverityNumber } from '@opentelemetry/api-logs';
-import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';
-import { Resource } from '@opentelemetry/resources';
-import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-
-import {
-  getContextFromEntry,
-  getRelativeFilename,
-  type LogConfig,
-  type LogEntry,
-  LogLevel,
-  type LogProcessor,
-  shouldLog,
-} from '@dxos/log';
-import { jsonlogify } from '@dxos/util';
-
-import { type OtelOptions, setDiagLogger } from './otel';
-
-export class OtelLogs {
-  private _loggerProvider: LoggerProvider;
-  constructor(private readonly options: OtelOptions) {
-    setDiagLogger(options.consoleDiagLogLevel);
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-    const logExporter = new OTLPLogExporter({
-      url: this.options.endpoint + '/v1/logs',
-      headers: {
-        Authorization: this.options.authorizationHeader,
-      },
-      concurrencyLimit: 10, // an optional limit on pending requests
-    });
-    this._loggerProvider = new LoggerProvider({ resource });
-    this._loggerProvider.addLogRecordProcessor(new BatchLogRecordProcessor(logExporter));
-  }
-
-  public readonly logProcessor: LogProcessor = (config: LogConfig, entry: LogEntry) => {
-    const logger = this._loggerProvider.getLogger('dxos-observability', this.options.serviceVersion);
-
-    if (!shouldLog(entry, config.captureFilters) || entry.meta?.S?.remoteSessionId) {
-      return;
-    }
-    const record = {
-      ...entry,
-      ...(entry.meta ? { meta: { file: getRelativeFilename(entry.meta.F), line: entry.meta.L } } : {}),
-      context: jsonlogify(getContextFromEntry(entry)),
-    };
-
-    logger.emit({
-      severityNumber: convertLevel(entry.level),
-      body: JSON.stringify(record),
-      attributes: this.options.getTags(),
-    });
-  };
-
-  flush() {
-    return this._loggerProvider.forceFlush();
-  }
-
-  close() {
-    return this._loggerProvider.shutdown();
-  }
-}
-
-const convertLevel = (level: LogLevel): SeverityNumber => {
-  switch (level) {
-    case LogLevel.DEBUG:
-      return SeverityNumber.DEBUG;
-    case LogLevel.INFO:
-      return SeverityNumber.INFO;
-    case LogLevel.WARN:
-      return SeverityNumber.WARN;
-    case LogLevel.ERROR:
-      return SeverityNumber.ERROR;
-    default:
-      return SeverityNumber.ERROR;
-  }
-};

package/src/otel/metrics.ts

@@ -1,111 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { type Attributes, type Meter, type ObservableGauge } from '@opentelemetry/api';
-import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
-import { Resource } from '@opentelemetry/resources';
-import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-
-import { log } from '@dxos/log';
-import { TRACE_PROCESSOR, type MetricData } from '@dxos/tracing';
-
-import { type OtelOptions, setDiagLogger } from './otel';
-
-const EXPORT_INTERVAL = 60 * 1000;
-
-type SynchronousGauge = {
-  gauge: ObservableGauge<Attributes>;
-  nextValue: number;
-  nextTags?: any;
-};
-
-export class OtelMetrics {
-  private _meterProvider: MeterProvider;
-  private _meter: Meter;
-  private _gauges = new Map<string, SynchronousGauge>();
-
-  constructor(private readonly options: OtelOptions) {
-    // TODO: improve error handling/logging
-    //  https://github.com/open-telemetry/opentelemetry-js/issues/4823
-    setDiagLogger(options.consoleDiagLogLevel);
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-
-    const grafanaMetricReader = new PeriodicExportingMetricReader({
-      exporter: new OTLPMetricExporter({
-        url: this.options.endpoint + '/v1/metrics',
-        headers: {
-          Authorization: this.options.authorizationHeader,
-        },
-      }),
-      exportIntervalMillis: EXPORT_INTERVAL,
-    });
-
-    this._meterProvider = new MeterProvider({
-      resource,
-      readers: [grafanaMetricReader],
-    });
-    this._meter = this._meterProvider.getMeter('dxos-observability');
-
-    const metrics = {
-      // TODO: update metrics names and remove prefix?
-      increment: (name: string, value?: number, data?: MetricData) => {
-        this.increment(name, value, convertTags(data));
-      },
-      distribution: (name: string, value: number, data?: MetricData) => {
-        this.distribution(name, value, convertTags(data));
-      },
-      set: (name: string, value: number | string, data?: MetricData) => {
-        // Not implemented, not part of Otel spec.
-      },
-      gauge: (name: string, value: number, data?: MetricData) => {
-        this.gauge(name, value, convertTags(data));
-      },
-    };
-
-    TRACE_PROCESSOR.remoteMetrics.registerProcessor(metrics);
-  }
-
-  gauge(name: string, value: number, tags?: any) {
-    const gauge = this._meter.createGauge(name);
-    log('otel gauge', { name, value, tags: { ...this.options.getTags(), ...tags } });
-    gauge.record(value, { ...this.options.getTags(), ...tags });
-  }
-
-  increment(name: string, value?: number, tags?: any) {
-    const counter = this._meter.createCounter(name);
-    log('otel counter', { name, value, tags: { ...this.options.getTags(), ...tags } });
-    counter.add(value ?? 1, { ...this.options.getTags(), ...tags });
-  }
-
-  distribution(name: string, value: number, tags?: any) {
-    const distribution = this._meter.createHistogram(name);
-    log('otel distribution', { name, value, tags: { ...this.options.getTags(), ...tags } });
-    distribution.record(value, { ...this.options.getTags(), ...tags });
-  }
-
-  flush() {
-    return this._meterProvider.forceFlush();
-  }
-
-  close() {
-    return this._meterProvider.shutdown();
-  }
-}
-
-const convertTags = (data?: MetricData) => {
-  if (data && data.tags) {
-    return Object.entries(data.tags).reduce<{ [key: string]: any }>((obj, [key, value]) => {
-      obj[key] = value;
-      return obj;
-    }, {});
-  } else {
-    return {};
-  }
-};

package/src/otel/otel.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
-
-export type OtelOptions = {
-  endpoint: string;
-  authorizationHeader: string;
-  serviceName: string; // For the Otel API, the name of the entity for which signals (metrics or trace) are collected.
-  serviceVersion: string; // For the Otel API, The name of the entity for which signals (metrics or trace) are collected.
-  getTags: () => { [key: string]: string };
-  consoleDiagLogLevel?: string;
-};
-
-export const setDiagLogger = (level?: string) => {
-  const logLevel = DiagLogLevel[level as keyof typeof DiagLogLevel];
-  if (logLevel) {
-    diag.setLogger(new DiagConsoleLogger(), logLevel);
-  }
-};

package/src/otel/traces-browser.ts

@@ -1,59 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { trace, type Tracer } from '@opentelemetry/api';
-import { getWebAutoInstrumentations } from '@opentelemetry/auto-instrumentations-web';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { registerInstrumentations } from '@opentelemetry/instrumentation';
-import { Resource } from '@opentelemetry/resources';
-import { ConsoleSpanExporter, SimpleSpanProcessor, BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
-import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-
-import { log } from '@dxos/log';
-import { TRACE_PROCESSOR, type StartSpanOptions } from '@dxos/tracing';
-
-import { type OtelOptions } from './otel';
-
-export class OtelTraces {
-  private _tracer: Tracer;
-  constructor(private readonly options: OtelOptions) {
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-
-    const tracerProvider = new WebTracerProvider({ resource });
-    tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
-    tracerProvider.addSpanProcessor(
-      new BatchSpanProcessor(
-        new OTLPTraceExporter({
-          url: this.options.endpoint + '/v1/traces',
-          headers: {
-            Authorization: this.options.authorizationHeader,
-          },
-          concurrencyLimit: 10, // an optional limit on pending requests
-        }),
-      ),
-    );
-    // TODO(nf): ContextManager? Propogator?
-    tracerProvider.register({});
-    this._tracer = trace.getTracer('dxos-observability', this.options.serviceVersion);
-  }
-
-  public start() {
-    registerInstrumentations({
-      instrumentations: [getWebAutoInstrumentations()],
-    });
-    log('trace processor registered');
-    TRACE_PROCESSOR.remoteTracing.registerProcessor({
-      startSpan: (options: StartSpanOptions) => {
-        log('begin otel trace', { options });
-        return this._tracer.startSpan(options.name, options);
-      },
-    });
-  }
-}

package/src/otel/traces.ts

@@ -1,57 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { trace, type Tracer } from '@opentelemetry/api';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { Resource } from '@opentelemetry/resources';
-import {
-  BasicTracerProvider,
-  BatchSpanProcessor,
-  ConsoleSpanExporter,
-  SimpleSpanProcessor,
-} from '@opentelemetry/sdk-trace-base';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-import { log } from 'debug';
-
-import { TRACE_PROCESSOR, type StartSpanOptions } from '@dxos/tracing';
-
-import { type OtelOptions } from './otel';
-
-export class OtelTraces {
-  private _tracer: Tracer;
-  constructor(private readonly options: OtelOptions) {
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-
-    const tracerProvider = new BasicTracerProvider({ resource });
-    tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
-    tracerProvider.addSpanProcessor(
-      new BatchSpanProcessor(
-        new OTLPTraceExporter({
-          url: this.options.endpoint + '/v1/traces',
-          headers: {
-            Authorization: this.options.authorizationHeader,
-          },
-          concurrencyLimit: 10, // an optional limit on pending requests
-        }),
-      ),
-    );
-    tracerProvider.register();
-    this._tracer = trace.getTracer('dxos-observability', this.options.serviceVersion);
-  }
-
-  public start() {
-    log('trace processor registered');
-    TRACE_PROCESSOR.remoteTracing.registerProcessor({
-      startSpan: (options: StartSpanOptions) => {
-        log('begin otel trace', { options });
-        return this._tracer.startSpan(options.name, options);
-      },
-    });
-  }
-}