magiclogger - v0.1.0
    Preparing search index...

    Interface HTTPTransportOptions

    Configuration options for HTTPWorkerTransport.

    HTTPTransportOptions

    interface HTTPTransportOptions {
        batchSize?: number;
        circuitBreakerResetTimeout?: number;
        circuitBreakerThreshold?: number;
        compress?: boolean;
        enabled?: boolean;
        endpoint?: string;
        flushInterval?: number;
        headers?: Record<string, string>;
        maxBufferSize?: number;
        maxRetries?: number;
        method?: "POST" | "PUT" | "PATCH";
        name?: string;
        retryDelay?: number;
        timeout?: number;
        url?: string;
    }
    Index

    Properties

    batchSize? circuitBreakerResetTimeout? circuitBreakerThreshold? compress? enabled? endpoint? flushInterval? headers? maxBufferSize? maxRetries? method? name? retryDelay? timeout? url?

    Properties

    batchSize?: number

    Number of logs to batch before sending. Higher values reduce network overhead but increase latency.

    100
    circuitBreakerResetTimeout?: number

    Circuit breaker reset timeout in milliseconds. Time to wait before attempting to close circuit.

    60000
    circuitBreakerThreshold?: number

    Circuit breaker threshold. Opens circuit after this many consecutive failures.

    5
    compress?: boolean

    Enable gzip compression for request body. Reduces bandwidth but adds CPU overhead in worker.

    false
    enabled?: boolean

    Whether the transport is enabled.

    true
    endpoint?: string

    HTTP endpoint URL for log submission.

    'https://logs.example.com/api/logs'
    flushInterval?: number

    Maximum time to wait before flushing batch (milliseconds). Ensures logs are sent even if batch size isn't reached.

    5000
    headers?: Record<string, string>

    Custom HTTP headers.

    { 'Authorization': 'Bearer token', 'X-API-Key': 'key' }
    maxBufferSize?: number

    Maximum size of the internal buffer in worker. Older entries are dropped when exceeded.

    10000
    maxRetries?: number

    Maximum retries for failed requests. Uses exponential backoff between retries.

    3
    method?: "POST" | "PUT" | "PATCH"

    HTTP method to use.

    'POST'
    name?: string

    Transport name for identification.

    'http-worker'
    retryDelay?: number

    Initial retry delay in milliseconds. Doubles with each retry (exponential backoff).

    1000
    timeout?: number

    Request timeout in milliseconds.

    30000
    url?: string

    Alias for endpoint for backward compatibility.

    'https://logs.example.com/api/logs'

    Settings

    Member Visibility

    On This Page

    Properties