FP-Devicer - v1.6.1
    Preparing search index...

    Interface Metrics

    Metrics sink interface consumed by DeviceManager. Implementations can emit to Prometheus, StatsD, OpenTelemetry, or any other backend. The built-in defaultMetrics keeps values in memory.

    interface Metrics {
        getSummary?(): Record<string, any>;
        incrementCounter(name: string, value?: number): void;
        recordGauge(name: string, value: number): void;
        recordHistogram(name: string, value: number): void;
        recordIdentify(
            durationMs: number,
            confidence: number,
            isNewDevice: boolean,
            candidatesCount: number,
            matched: boolean,
        ): void;
    }
    Index

    Methods

    getSummary? incrementCounter recordGauge recordHistogram recordIdentify

    Methods

    • Return an arbitrary summary object for reporting. Optional.

      Returns Record<string, any>

    • Increment a named counter by value (default 1). e.g. "matches_total"

      Parameters

      • name: string
      • Optionalvalue: number

      Returns void

    • Set a named gauge to an absolute value. e.g. "avg_confidence"

      Parameters

      • name: string
      • value: number

      Returns void

    • Record a single observation into a named histogram. e.g. "identify_latency_ms"

      Parameters

      • name: string
      • value: number

      Returns void

    • Convenience helper called by DeviceManager after each identify() call. Aggregates latency, confidence, and device lifecycle counters in one shot.

      Parameters

      • durationMs: number

        Wall-clock time taken by the identify call.

      • confidence: number

        Final confidence score (0–100).

      • isNewDevice: boolean

        true when no existing device was matched.

      • candidatesCount: number

        Number of pre-filter candidates evaluated.

      • matched: boolean

        true when an existing device was matched above threshold.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods