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

    Interface GraylogConfigOptions

    Options accepted by GraylogConfig (all optional).

    interface GraylogConfigOptions {
        apiToken?: string | Secret;
        connectTimeoutMs?: number;
        gelfHost?: string;
        gelfHttpUrl?: string;
        gelfPort?: number;
        gelfProtocol?: GelfProtocol;
        gelfTls?: boolean;
        headers?: Record<string, string>;
        hooks?: Hooks;
        logger?: ClientLogger;
        otlpEndpoint?: string;
        password?: string | Secret;
        proxy?: string;
        requestedBy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    apiToken?: string | Secret

    REST API access token (env GROW_GRAYLOG_API_TOKEN, GRAYLOG_API_TOKEN). Sent as HTTP Basic <token>:token. Wins over username/password when both are set.

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    gelfHost?: string

    GELF host (env GROW_GRAYLOG_GELF_HOST, GRAYLOG_GELF_HOST, GRAYLOG_HOST). Default: host of url.

    gelfHttpUrl?: string

    Full GELF HTTP endpoint (env GROW_GRAYLOG_GELF_HTTP_URL, GRAYLOG_GELF_HTTP_URL). Default http(s)://<gelfHost>:<gelfPort>/gelf.

    gelfPort?: number

    GELF port (env GROW_GRAYLOG_GELF_PORT, GRAYLOG_GELF_PORT, GRAYLOG_PORT). Default 12201 for UDP/TCP and 12202 for HTTP.

    gelfProtocol?: GelfProtocol

    Default GELF transport (env GROW_GRAYLOG_GELF_PROTOCOL, GRAYLOG_GELF_PROTOCOL, GRAYLOG_TRANSPORT). Default tcp.

    gelfTls?: boolean

    Use TLS for GELF TCP (and https for the default GELF HTTP URL); env GROW_GRAYLOG_GELF_TLS. Uses the tls options.

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    otlpEndpoint?: string

    OTLP gRPC endpoint of a Graylog OpenTelemetry input (env GROW_GRAYLOG_OTLP_ENDPOINT, GRAYLOG_OTLP_GRPC_ENDPOINT). Default http://<gelfHost>:4317.

    password?: string | Secret

    REST password (env GROW_GRAYLOG_PASSWORD, GRAYLOG_PASSWORD).

    proxy?: string

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

    requestedBy?: string

    Value of the X-Requested-By header on non-GET requests. Default grow-codes-graylog.

    requestTimeoutMs?: number

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

    Retry policy or its options.

    TLS settings.

    totalTimeoutMs?: number

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

    url?: string

    Endpoint base URL.

    userAgentSuffix?: string

    Appended after the standard User-Agent.

    username?: string

    REST user name for HTTP Basic auth (env GROW_GRAYLOG_USER, GRAYLOG_USER).