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

    Interface OtelCollectorConfigOptions

    Options accepted by OtelCollectorConfig (all optional).

    interface OtelCollectorConfigOptions {
        compression?: "none" | "gzip";
        connectTimeoutMs?: number;
        environment?: string;
        exportTimeoutMs?: number;
        grpcUrl?: string;
        headers?: Record<string, string>;
        healthUrl?: string;
        hooks?: Hooks;
        logger?: ClientLogger;
        logs?: boolean;
        logsBatch?: BatchOptions;
        logsHeaders?: Record<string, string>;
        logsUrl?: string;
        metricExportIntervalMs?: number;
        metrics?: boolean;
        metricsHeaders?: Record<string, string>;
        metricsUrl?: string;
        propagators?: readonly string[];
        protocol?: OtlpProtocol;
        proxy?: string;
        requestTimeoutMs?: number;
        resourceAttributes?: SpanAttributes;
        resourceDetectors?: readonly ResourceDetectorName[];
        retry?: RetryPolicyOptions | RetryPolicy;
        runtimeMetrics?: boolean;
        sampler?: SamplerName;
        samplerRatio?: number;
        serviceName?: string;
        serviceVersion?: string;
        telemetryUrl?: string;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        traces?: boolean;
        tracesBatch?: TracingBatchConfig;
        tracesHeaders?: Record<string, string>;
        tracesUrl?: string;
        url?: string;
        userAgentSuffix?: string;
        zpagesUrl?: string;
    }

    Hierarchy (View Summary)

    Index
    compression?: "none" | "gzip"

    Payload compression of OTLP exports. Default gzip.

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    environment?: string

    deployment.environment.name.

    exportTimeoutMs?: number

    Deadline of one OTLP export including the exporter's own retries, in ms. Default 10 000.

    grpcUrl?: string

    OTLP/gRPC target (port 4317). Default: scheme and host of url, port 4317 (http://127.0.0.1:4317); https:// enables TLS.

    headers?: Record<string, string>

    Extra request headers.

    healthUrl?: string

    health_check extension URL. Default: host of url, port 13133, path /.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    logs?: boolean

    Export logs. Default true.

    logsBatch?: BatchOptions

    Log batch processor settings.

    logsHeaders?: Record<string, string>

    Extra headers for log exports only (merged over headers). Redacted.

    logsUrl?: string

    Full logs endpoint, used as-is: overrides url + /v1/logs for HTTP and grpcUrl for gRPC.

    metricExportIntervalMs?: number

    Interval of the periodic metric reader in ms. Default 60 000.

    metrics?: boolean

    Export metrics. Default true.

    metricsHeaders?: Record<string, string>

    Extra headers for metric exports only (merged over headers). Redacted.

    metricsUrl?: string

    Full metrics endpoint, used as-is: overrides url + /v1/metrics for HTTP and grpcUrl for gRPC.

    propagators?: readonly string[]

    Propagators. Default ["tracecontext", "baggage"].

    protocol?: OtlpProtocol

    Export protocol. Default http/protobuf. native is rejected with ConfigError.

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    resourceAttributes?: SpanAttributes

    Resource attributes; explicit keys win over environment keys.

    resourceDetectors?: readonly ResourceDetectorName[]

    Resource detectors run by initTelemetry. Default: all (RESOURCE_DETECTORS).

    Retry policy or its options.

    runtimeMetrics?: boolean

    Report Node.js runtime metrics (memory, CPU, event loop, uptime). Default false.

    sampler?: SamplerName

    Trace sampler. Default parentbased_always_on.

    samplerRatio?: number

    Ratio of the *traceidratio samplers (0..1). Default 1.

    serviceName?: string

    service.name. Default unknown_service:<process>.

    serviceVersion?: string

    service.version.

    telemetryUrl?: string

    Internal telemetry (Prometheus) URL such as http://collector:8888/metrics. Optional.

    TLS settings.

    totalTimeoutMs?: number

    Whole-call timeout in ms including retries and backoff (default 120 000).

    traces?: boolean

    Export traces. Default true.

    tracesBatch?: TracingBatchConfig

    Batch span processor settings.

    tracesHeaders?: Record<string, string>

    Extra headers for trace exports only (merged over headers). Redacted.

    tracesUrl?: string

    Full traces endpoint, used as-is: overrides url + /v1/traces for HTTP and grpcUrl for gRPC.

    url?: string

    OTLP/HTTP base URL (port 4318); signal paths /v1/traces, /v1/logs, /v1/metrics are appended. Default http://127.0.0.1:4318.

    userAgentSuffix?: string

    Appended after the standard User-Agent.

    zpagesUrl?: string

    zpages extension base URL. Default: host of url, port 55679.