@accordkit/tracer - v0.2.1
    Preparing search index...

    Interface FileSinkOptions

    Configuration options for the FileSink.

    interface FileSinkOptions {
        base?: string;
        delivery?: FileDeliveryMode;
        maxBuffer?: number;
        batchSize?: number;
        flushIntervalMs?: number;
        overflowPolicy?: OverflowPolicy;
    }

    Hierarchy (View Summary)

    Index

    Properties

    base?: string

    The base directory where log files will be stored. Each session will have its own .jsonl file inside this directory.

    '~/.accordkit/logs' (resolved via os.homedir())

    delivery?: FileDeliveryMode

    The delivery strategy for events.

    • immediate: Write each event to its file synchronously.
    • buffered: Batch events in memory and flush them periodically.
    'immediate'
    
    maxBuffer?: number

    The maximum total number of events to keep in memory across all session buffers. If the total exceeds this size, the oldest events from the largest buffer will be dropped. This prevents unbounded memory growth. Only applies to buffered delivery mode.

    5000
    
    batchSize?: number

    The number of events to collect in a session's buffer before triggering a flush. Only applies to buffered delivery mode.

    100
    
    flushIntervalMs?: number

    The maximum time in milliseconds to wait before flushing buffers, regardless of their size. Only applies to buffered delivery mode.

    1000
    
    overflowPolicy?: OverflowPolicy

    The policy to apply when the maxBuffer limit is reached. This determines how the sink behaves when it's under heavy load.

    • auto-flush: Immediately triggers a flush.
    • drop-oldest: Discards the oldest events to make room for new ones.
    • error: Throw on overflow (useful for tests).

    OverflowPolicy

    'auto-flush'