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

    Interface DatadogLogsConfigOptions

    Options accepted by DatadogLogsConfig (all optional except apiKey).

    interface DatadogLogsConfigOptions {
        apiKey?: string | Secret;
        apiUrl?: string;
        appKey?: string | Secret;
        connectTimeoutMs?: number;
        env?: string;
        headers?: Record<string, string>;
        hooks?: Hooks;
        hostname?: string;
        intakeUrl?: string;
        logger?: ClientLogger;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        service?: string;
        site?: string;
        source?: string;
        tags?: string | readonly string[];
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
        version?: string;
    }

    Hierarchy (View Summary)

    Index
    apiKey?: string | Secret

    Datadog API key, header DD-API-KEY; required by every call (env GROW_DATADOG_LOGS_API_KEY, DD_API_KEY).

    apiUrl?: string

    API base URL override (env GROW_DATADOG_LOGS_API_URL). Default: url, else derived from the site.

    appKey?: string | Secret

    Datadog application key, header DD-APPLICATION-KEY; needed only by the query API and never sent to the intake (env GROW_DATADOG_LOGS_APP_KEY, DD_APP_KEY, DD_APPLICATION_KEY).

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    env?: string

    Environment, sent as tag env:<v> (env GROW_DATADOG_LOGS_ENV, DD_ENV).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    hostname?: string

    Default hostname of every log (env GROW_DATADOG_LOGS_HOSTNAME, DD_HOSTNAME).

    intakeUrl?: string

    Intake base URL override (env GROW_DATADOG_LOGS_INTAKE_URL). Default: url, else derived from the site.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    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.

    service?: string

    Default service of every log (env GROW_DATADOG_LOGS_SERVICE, DD_SERVICE).

    site?: string

    Datadog site, e.g. datadoghq.eu (env GROW_DATADOG_LOGS_SITE, DD_SITE). Default datadoghq.com.

    source?: string

    ddsource of every log (env GROW_DATADOG_LOGS_SOURCE). Default grow-sdk.

    tags?: string | readonly string[]

    Tags added to every log: a list of key:value strings or one string separated by commas or spaces (env GROW_DATADOG_LOGS_TAGS, DD_TAGS).

    TLS settings.

    totalTimeoutMs?: number

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

    url?: string

    Base URL for both the intake and the API (tests, proxies, fakeintake). Overrides the site (env GROW_DATADOG_LOGS_URL).

    userAgentSuffix?: string

    Appended after the standard User-Agent.

    version?: string

    Version, sent as tag version:<v> (env GROW_DATADOG_LOGS_VERSION, DD_VERSION).