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

    Interface BetterStackConfigOptions

    Options accepted by BetterStackConfig (all optional, but one side must be complete).

    interface BetterStackConfigOptions {
        connectTimeoutMs?: number;
        encoding?: IngestEncoding;
        headers?: Record<string, string>;
        hooks?: Hooks;
        logger?: ClientLogger;
        proxy?: string;
        queryPassword?: string | Secret;
        queryUrl?: string;
        queryUsername?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        sourceTable?: string;
        sourceToken?: string | Secret;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    encoding?: IngestEncoding

    Default ingest body encoding of the exporters: "json" (default), "ndjson" or "msgpack"; each exporter can override it. Env GROW_BETTER_STACK_LOGS_ENCODING.

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    queryPassword?: string | Secret

    Password of the SQL connection (HTTP Basic). Env …_QUERY_PASSWORD, BETTERSTACK_QUERY_PASSWORD.

    queryUrl?: string

    SQL query base URL (ClickHouse HTTP interface, e.g. eu-nbg-2-connect.betterstackdata.com). Env GROW_BETTER_STACK_LOGS_QUERY_URL, BETTERSTACK_QUERY_URL, BETTERSTACK_QUERY_HOST.

    queryUsername?: string

    Username of the SQL connection. Env …_QUERY_USERNAME, BETTERSTACK_QUERY_USERNAME.

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    Retry policy or its options.

    sourceTable?: string

    Default collection (t1234_myapp) used by search, searchLogs and ping. Env GROW_BETTER_STACK_LOGS_SOURCE_TABLE, BETTERSTACK_SOURCE_TABLE.

    sourceToken?: string | Secret

    Source token sent as Authorization: Bearer <token> to the ingest host only. Env GROW_BETTER_STACK_LOGS_SOURCE_TOKEN, BETTERSTACK_SOURCE_TOKEN.

    TLS settings.

    totalTimeoutMs?: number

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

    url?: string

    Ingest base URL: the source's ingesting host (s1234.eu-nbg-2.betterstackdata.com). A value without :// gets https://. Required for sending logs; there is no default host. Env GROW_BETTER_STACK_LOGS_URL, BETTERSTACK_INGESTING_URL, BETTERSTACK_INGESTING_HOST.

    userAgentSuffix?: string

    Appended after the standard User-Agent.