@grow-codes/signoz - v0.1.1
    Preparing search index...

    Interface SignozConfigOptions

    Options accepted by SignozConfig (all optional).

    interface SignozConfigOptions {
        apiKey?: string | Secret;
        connectTimeoutMs?: number;
        headers?: Record<string, string>;
        hooks?: Hooks;
        ingestionKey?: string | Secret;
        logger?: ClientLogger;
        otlpEndpoint?: string;
        otlpProtocol?: OtlpProtocol;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    apiKey?: string | Secret

    Query API key, sent as SIGNOZ-API-KEY (env GROW_SIGNOZ_API_KEY, then SIGNOZ_API_KEY). Required only for query calls and ping(); an ingest-only client does not need it.

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    ingestionKey?: string | Secret

    SigNoz Cloud ingestion key, sent as the signoz-ingestion-key header / gRPC metadata on every OTLP export (env GROW_SIGNOZ_INGESTION_KEY, then SIGNOZ_INGESTION_KEY). Self-hosted collectors ignore it.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    otlpEndpoint?: string

    OTLP endpoint of the SigNoz collector (env GROW_SIGNOZ_OTLP_ENDPOINT, then SIGNOZ_OTLP_ENDPOINT, then OTEL_EXPORTER_OTLP_ENDPOINT). Default http://127.0.0.1:4318 for http/protobuf, http://127.0.0.1:4317 for grpc.

    otlpProtocol?: OtlpProtocol

    OTLP protocol (env GROW_SIGNOZ_OTLP_PROTOCOL, then OTEL_EXPORTER_OTLP_PROTOCOL). Default http/protobuf.

    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).

    Retry policy or its options.

    TLS settings.

    totalTimeoutMs?: number

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

    url?: string

    Endpoint base URL.

    userAgentSuffix?: string

    Appended after the standard User-Agent.