@grow-codes/opentelemetry-collector - v0.1.1
    Preparing search index...

    Interface TelemetryHandle

    A running telemetry setup (all three signals).

    interface TelemetryHandle {
        config: OtelCollectorConfig;
        logClient?: LogClient;
        meterProvider?: MeterProvider;
        resource: Resource;
        resourceAttributes: Readonly<SpanAttributes>;
        tracerProvider?: NodeTracerProvider;
        tracing?: TracingHandle;
        counter(name: string, options?: InstrumentOptions): Counter;
        forceFlush(timeoutMs?: number): Promise<void>;
        gauge(name: string, options?: InstrumentOptions): Gauge;
        histogram(name: string, options?: HistogramOptions): Histogram;
        logger(name?: string, attributes?: Attributes): Logger;
        meter(name?: string, version?: string): Meter;
        shutdown(): Promise<void>;
        tracer(name?: string, version?: string): Tracer;
        upDownCounter(name: string, options?: InstrumentOptions): UpDownCounter;
    }

    Hierarchy (View Summary)

    Index

    The collector config in use.

    logClient?: LogClient

    The OTLP log client, when logs are enabled.

    meterProvider?: MeterProvider

    The meter provider, when metrics are enabled.

    resource: Resource

    The shared resource (with the SDK default attributes).

    resourceAttributes: Readonly<SpanAttributes>

    Attributes of the shared resource (detected < env < explicit < service fields).

    tracerProvider?: NodeTracerProvider

    The tracer provider, when traces are enabled.

    tracing?: TracingHandle

    The tracing handle, when traces are enabled.

    • Exports everything buffered in every enabled signal; TimeoutError after timeoutMs.

      Parameters

      • OptionaltimeoutMs: number

      Returns Promise<void>

    • A meter from this provider.

      Parameters

      • Optionalname: string
      • Optionalversion: string

      Returns Meter

    • Flushes and shuts every provider down; idempotent. Unregisters the globals it set.

      Returns Promise<void>

    • A tracer (no-op when traces are disabled).

      Parameters

      • Optionalname: string
      • Optionalversion: string

      Returns Tracer