bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface ConnectionHealth

    Connection health metrics

    interface ConnectionHealth {
        avgLatencyMs: number;
        consecutiveCommandTimeouts: number;
        consecutivePingFailures: number;
        healthy: boolean;
        lastErrorAt: number | null;
        lastSuccessAt: number | null;
        state: "connected" | "connecting" | "disconnected" | "closed";
        totalCommands: number;
        totalErrors: number;
        uptimeMs: number;
    }
    Index
    avgLatencyMs consecutiveCommandTimeouts consecutivePingFailures healthy lastErrorAt lastSuccessAt state totalCommands totalErrors uptimeMs
    avgLatencyMs: number

    Average latency of last 10 commands in ms

    consecutiveCommandTimeouts: number

    Consecutive command timeouts with no intervening success

    consecutivePingFailures: number

    Consecutive ping failures

    healthy: boolean

    Whether connection is currently healthy

    lastErrorAt: number | null

    Timestamp of last error

    lastSuccessAt: number | null

    Timestamp of last successful command

    state: "connected" | "connecting" | "disconnected" | "closed"

    Current connection state

    totalCommands: number

    Total commands sent

    totalErrors: number

    Total errors

    uptimeMs: number

    Uptime since last connect in ms

    Settings
    Member Visibility

    On This Page
    Properties