RTCForge API Reference v1.1.1
    Preparing search index...

    Variable MetricConst

    Metric: {
        ActivePeers: "active_peers";
        ActiveRooms: "active_rooms";
        AuthErrors: "auth_errors";
        BroadcastsRelayed: "broadcasts_relayed";
        PeersConnected: "peers_connected";
        PeersDisconnected: "peers_disconnected";
        PeersKicked: "peers_kicked";
        RoomsClosed: "rooms_closed";
        RoomsCreated: "rooms_created";
        SignalsRelayed: "signals_relayed";
    } = ...

    Canonical names for the operational metrics RTCForge emits.

    Type Declaration

    • ReadonlyActivePeers: "active_peers"

      Gauge: current number of active peers.

    • ReadonlyActiveRooms: "active_rooms"

      Gauge: current number of active rooms.

    • ReadonlyAuthErrors: "auth_errors"

      Counter: an authentication or authorization error occurred.

    • ReadonlyBroadcastsRelayed: "broadcasts_relayed"

      Counter: a broadcast message was relayed to room members.

    • ReadonlyPeersConnected: "peers_connected"

      Counter: a peer connected.

    • ReadonlyPeersDisconnected: "peers_disconnected"

      Counter: a peer disconnected.

    • ReadonlyPeersKicked: "peers_kicked"

      Counter: a peer was forcibly removed from a room.

    • ReadonlyRoomsClosed: "rooms_closed"

      Counter: a room was closed.

    • ReadonlyRoomsCreated: "rooms_created"

      Counter: a room was created.

    • ReadonlySignalsRelayed: "signals_relayed"

      Counter: a signaling message was relayed between peers.

    Pass these values as the metric argument to a MetricsCollector for consistent metric naming across components. The type alias Metric is the union of these values.

    Settings

    Member Visibility