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

    Interface JaegerConfigOptions

    Options accepted by JaegerConfig (all optional).

    interface JaegerConfigOptions {
        connectTimeoutMs?: number;
        headers?: Record<string, string>;
        healthUrl?: string;
        hooks?: Hooks;
        logger?: ClientLogger;
        metricsUrl?: string;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        samplingUrl?: string;
        tls?: TlsOptions;
        token?: string | Secret;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    headers?: Record<string, string>

    Extra request headers.

    healthUrl?: string

    Optional healthcheckv2 URL (port 13133, /status); when set, health() adds its detail. Env GROW_JAEGER_HEALTH_URL.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    metricsUrl?: string

    Optional Prometheus metrics URL (port 8888, /metrics); serverVersion() falls back to its target_info series. Env GROW_JAEGER_METRICS_URL.

    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.

    samplingUrl?: string

    Remote sampling endpoint (port 5778, path /sampling). Env GROW_JAEGER_SAMPLING_URL, then JAEGER_SAMPLING_ENDPOINT. Default http://127.0.0.1:5778/sampling.

    TLS settings.

    token?: string | Secret

    Optional bearer token sent as Authorization: Bearer <token> to the query API (stock Jaeger has no auth; use it for a reverse proxy or bearer_token_propagation). Env GROW_JAEGER_TOKEN.

    totalTimeoutMs?: number

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

    url?: string

    Query API base URL (port 16686). A reverse-proxy base path is kept (https://host/jaeger → https://host/jaeger/api/v3/...). Env GROW_JAEGER_URL, then JAEGER_QUERY_URL. Default http://127.0.0.1:16686.

    userAgentSuffix?: string

    Appended after the standard User-Agent.