@grow-codes/datadog-apm - v0.1.1
    Preparing search index...

    Interface DatadogApmConfigOptions

    Options accepted by DatadogApmConfig (all optional).

    interface DatadogApmConfigOptions {
        apiKey?: string | Secret;
        apiUrl?: string;
        appKey?: string | Secret;
        connectTimeoutMs?: number;
        environment?: string;
        headers?: Record<string, string>;
        hooks?: Hooks;
        logger?: ClientLogger;
        otlpEndpoint?: string;
        protocol?: DatadogOtlpProtocol;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        serviceName?: string;
        serviceVersion?: string;
        site?: string;
        tags?: Record<string, string>;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    apiKey?: string | Secret

    Datadog API key: needed only by the query API (DatadogSpansQuery).

    apiUrl?: string

    Query API base URL. Default https://api.<site>.

    appKey?: string | Secret

    Datadog application key with apm_read: needed only by the query API.

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    environment?: string

    Unified service tagging: env (resource deployment.environment.name).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    otlpEndpoint?: string

    OTLP endpoint of the Agent. HTTP: a base URL (http://agent:4318, /v1/traces is appended when the URL has no path) or the full traces URL; gRPC: http://agent:4317. Default: the host of url with port 4318 (HTTP) or 4317 (gRPC).

    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.

    serviceName?: string

    Unified service tagging: service (resource service.name).

    serviceVersion?: string

    Unified service tagging: version (resource service.version).

    site?: string

    Datadog site, e.g. datadoghq.com (default) or datadoghq.eu.

    tags?: Record<string, string>

    Extra resource attributes (DD_TAGS).

    TLS settings.

    totalTimeoutMs?: number

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

    url?: string

    Datadog Agent trace intake base URL, used by health(), ping() and serverVersion() (GET /info). Default http://127.0.0.1:8126.

    userAgentSuffix?: string

    Appended after the standard User-Agent.