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

    Class DatadogApmConfig

    Immutable configuration of DatadogApmClient and initTracing.

    Implements

    Index
    apiKey?: Secret

    Datadog API key (query API only).

    apiUrl: string

    Query API base URL.

    appKey?: Secret

    Datadog application key (query API only).

    connectTimeoutMs: number
    environment?: string

    env of unified service tagging.

    headers: Readonly<Record<string, string>>
    hooks?: Hooks
    logger?: ClientLogger
    otlpEndpoint?: string

    OTLP endpoint as configured (see otlpTracesEndpoint for the resolved URL).

    OTLP protocol.

    proxy?: string
    requestTimeoutMs: number
    serviceName?: string

    service of unified service tagging.

    serviceVersion?: string

    version of unified service tagging.

    site: string

    Datadog site.

    tags: Readonly<Record<string, string>>

    Extra resource attributes.

    tls: Readonly<TlsOptions>
    totalTimeoutMs: number
    url: string
    userAgentSuffix?: string
    DEFAULT_URL: "http://127.0.0.1:8126" = ...

    Default Agent trace intake URL.

    ENV_PREFIX: "GROW_DATADOG_APM_"

    Prefix of every environment variable.

    • get hasQueryCredentials(): boolean

      True when both the API key and the application key are set (query API usable).

      Returns boolean

    • Credential values to redact from error messages and logs.

      Returns string[]

    • Debug form with every credential redacted.

      Returns Record<string, unknown>

    • Returns a string representation of an object.

      Returns string

    • Builds a config from the environment. Precedence per field: explicit overrides > GROW_DATADOG_APM_<NAME> > vendor variables > defaults.

      Field GROW_DATADOG_APM_* Vendor variables
      url URL DD_TRACE_AGENT_URL, else http://${DD_AGENT_HOST}:${DD_TRACE_AGENT_PORT}
      otlpEndpoint OTLP_HTTP_ENDPOINT / OTLP_GRPC_ENDPOINT (by protocol), OTLP_ENDPOINT OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_ENDPOINT
      protocol OTLP_PROTOCOL OTEL_EXPORTER_OTLP_TRACES_PROTOCOL, OTEL_EXPORTER_OTLP_PROTOCOL
      serviceName SERVICE DD_SERVICE, OTEL_SERVICE_NAME
      serviceVersion VERSION DD_VERSION
      environment ENV DD_ENV
      tags TAGS DD_TAGS
      apiKey API_KEY DD_API_KEY
      appKey APP_KEY DD_APP_KEY, DD_APPLICATION_KEY
      site SITE DD_SITE
      apiUrl API_URL —

      Parameters

      Returns DatadogApmConfig