magiclogger - v0.1.0
    Preparing search index...

    Interface S3TransportOptions

    S3 transport specific options.

    interface S3TransportOptions {
        bucket: string;
        circuitBreaker?: {
            enabled: boolean;
            errorThreshold?: number;
            resetTimeout?: number;
        };
        compress?: boolean;
        connectionTimeout?: number;
        credentials?: {
            accessKeyId?: string;
            secretAccessKey?: string;
            sessionToken?: string;
        };
        dlq?: {
            enabled: boolean;
            filepath?: string;
            maxAge?: number;
            maxSize?: number;
        };
        enabled?: boolean;
        encryption?: { kmsKeyId?: string; type: "AES256"
        | "KMS" };
        excludeTags?: string[];
        fallback?: string | Transport;
        fileFormat?: "json" | "jsonl" | "csv" | "parquet";
        filter?: (entry: LogEntry) => boolean;
        format?: "json" | "plain" | "custom";
        formatter?: (entry: LogEntry) => string | Buffer<ArrayBufferLike>;
        headers?: Record<string, string>;
        healthCheckInterval?: number;
        immediate?: boolean;
        keepAliveInterval?: number;
        keyGenerator?: (logs: LogEntry[]) => string;
        keyStrategy?: "custom" | "timestamp" | "date-hierarchy" | "hourly";
        level?: string;
        levels?: string[];
        maxBatchBytes?: number;
        maxBatchSize?: number;
        maxBatchTime?: number;
        maxOfflineQueueSize?: number;
        maxQueueSize?: number;
        maxReconnectAttempts?: number;
        maxRetries?: number;
        name?: string;
        objectTags?: Record<string, string>;
        prefix?: string;
        queueWhenOffline?: boolean;
        reconnectBackoff?: boolean;
        reconnectDelay?: number;
        region?: string;
        requestTimeout?: number;
        retry?: RetryOptions;
        retryDelay?: number;
        retryOnFailure?: boolean;
        silent?: boolean;
        storageClass?:
            | "STANDARD"
            | "STANDARD_IA"
            | "ONEZONE_IA"
            | "INTELLIGENT_TIERING"
            | "GLACIER"
            | "DEEP_ARCHIVE";
        tags?: string[];
        timeout?: number;
        tls?: {
            ca?: string;
            cert?: string;
            key?: string;
            rejectUnauthorized?: boolean;
        };
        url?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bucket circuitBreaker? compress? connectionTimeout? credentials? dlq? enabled? encryption? excludeTags? fallback? fileFormat? filter? format? formatter? headers? healthCheckInterval? immediate? keepAliveInterval? keyGenerator? keyStrategy? level? levels? maxBatchBytes? maxBatchSize? maxBatchTime? maxOfflineQueueSize? maxQueueSize? maxReconnectAttempts? maxRetries? name? objectTags? prefix? queueWhenOffline? reconnectBackoff? reconnectDelay? region? requestTimeout? retry? retryDelay? retryOnFailure? silent? storageClass? tags? timeout? tls? url?

    Properties

    bucket: string

    S3 bucket name.

    circuitBreaker?: {
        enabled: boolean;
        errorThreshold?: number;
        resetTimeout?: number;
    }

    Circuit breaker configuration.

    compress?: boolean

    Compress batches before sending (gzip).

    false
    connectionTimeout?: number

    Connection timeout in milliseconds.

    credentials?: {
        accessKeyId?: string;
        secretAccessKey?: string;
        sessionToken?: string;
    }

    AWS credentials. If not provided, uses default credential chain.

    dlq?: { enabled: boolean; filepath?: string; maxAge?: number; maxSize?: number }

    Dead letter queue configuration for failed logs.

    enabled?: boolean

    Whether this transport is currently active. Allows runtime enabling/disabling of transports.

    true
    encryption?: { kmsKeyId?: string; type: "AES256" | "KMS" }

    Server-side encryption settings.

    excludeTags?: string[]

    Tags that exclude logs from this transport. Logs with any of these tags are skipped.

    fallback?: string | Transport

    Fallback transport to use when this transport fails. Can be 'file', 'console', or a Transport instance.

    fileFormat?: "json" | "jsonl" | "csv" | "parquet"

    File format for S3 objects.

    'jsonl'
    filter?: (entry: LogEntry) => boolean

    Custom filter function for advanced filtering logic. Return true to process the log, false to skip.

    format?: "json" | "plain" | "custom"

    Output format for this transport.

    'json'
    formatter?: (entry: LogEntry) => string | Buffer<ArrayBufferLike>

    Custom formatter function. Used when format is 'custom'.

    headers?: Record<string, string>

    Request headers to include with all requests.

    healthCheckInterval?: number

    Health check interval in milliseconds.

    immediate?: boolean

    Whether to send logs immediately without batching. Overrides other batch settings when true.

    false
    keepAliveInterval?: number

    Keep-alive interval in milliseconds.

    keyGenerator?: (logs: LogEntry[]) => string

    Custom key generator function.

    keyStrategy?: "custom" | "timestamp" | "date-hierarchy" | "hourly"

    Key naming strategy.

    'timestamp'
    level?: string

    Minimum log level this transport will handle. Logs below this level are ignored by this transport.

    'info'
    levels?: string[]

    Custom levels this transport should handle. Allows fine-grained control over what gets logged where.

    maxBatchBytes?: number

    Maximum size in bytes before sending a batch.

    1048576 (1MB)
    maxBatchSize?: number

    Maximum number of logs to batch before sending.

    100
    maxBatchTime?: number

    Maximum time to wait before sending a batch (milliseconds).

    5000 (5 seconds)
    maxOfflineQueueSize?: number

    Maximum offline queue size.

    maxQueueSize?: number

    Maximum queue size.

    10000
    maxReconnectAttempts?: number

    Maximum reconnection attempts.

    maxRetries?: number

    Maximum retry attempts for failed batches.

    3
    name?: string

    Unique name identifier for this transport instance. Used for managing multiple transports.

    objectTags?: Record<string, string>

    Tags to apply to S3 objects.

    prefix?: string

    S3 key prefix for log files.

    'logs/'
    queueWhenOffline?: boolean

    Whether to queue logs when offline.

    reconnectBackoff?: boolean

    Whether to use exponential backoff for reconnects.

    reconnectDelay?: number

    Delay between reconnection attempts.

    region?: string

    AWS region.

    'us-east-1'
    requestTimeout?: number

    Request timeout in milliseconds.

    retry?: RetryOptions

    Retry configuration for failed requests.

    retryDelay?: number

    Initial retry delay in milliseconds.

    1000
    retryOnFailure?: boolean

    Whether to retry on failure.

    true
    silent?: boolean

    Whether to handle errors silently or propagate them.

    true
    storageClass?:
        | "STANDARD"
        | "STANDARD_IA"
        | "ONEZONE_IA"
        | "INTELLIGENT_TIERING"
        | "GLACIER"
        | "DEEP_ARCHIVE"

    S3 storage class.

    'STANDARD'
    tags?: string[]

    Tags that must be present for this transport to handle a log. If specified, only logs with at least one matching tag are processed.

    timeout?: number

    Timeout for transport operations in milliseconds.

    30000 (30 seconds)
    tls?: { ca?: string; cert?: string; key?: string; rejectUnauthorized?: boolean }

    TLS/SSL options for HTTPS connections.

    url?: string

    Network endpoint URL.

    Settings

    Member Visibility

    On This Page

    Properties