SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias MetricsSnapshot

    MetricsSnapshot: Message<"soulfire.v1.MetricsSnapshot"> & {
        avgFoodLevel: number;
        avgHealth: number;
        avgTickDurationMs: number;
        botsOnline: number;
        botsTotal: number;
        bytesReceivedPerSecond: number;
        bytesReceivedTotal: bigint;
        bytesSentPerSecond: number;
        bytesSentTotal: bigint;
        connections: number;
        disconnections: number;
        maxTickDurationMs: number;
        packetsReceivedPerSecond: number;
        packetsReceivedTotal: bigint;
        packetsSentPerSecond: number;
        packetsSentTotal: bigint;
        timestamp?: Timestamp;
        totalLoadedChunks: number;
        totalTrackedEntities: number;
    }

    A single time-series data point sampled at a fixed interval.

    Type Declaration

    • avgFoodLevel: number

      Average food level across all online bots with player data. Range: 0 to 20 (Minecraft food points).

      from field: double avg_food_level = 15;

    • avgHealth: number

      Average health across all online bots with player data. Range: 0 to 20 (Minecraft health points).

      from field: double avg_health = 14;

    • avgTickDurationMs: number

      Average tick duration across all bots in milliseconds.

      from field: double avg_tick_duration_ms = 12;

    • botsOnline: number

      Number of bots currently connected to the Minecraft server.

      from field: uint32 bots_online = 2;

    • botsTotal: number

      Total number of bots configured in the instance (online + offline).

      from field: uint32 bots_total = 3;

    • bytesReceivedPerSecond: number

      Current rate of bytes received per second (computed from counter deltas).

      from field: double bytes_received_per_second = 11;

    • bytesReceivedTotal: bigint

      Cumulative bytes received across all bots since the server started.

      from field: uint64 bytes_received_total = 7;

    • bytesSentPerSecond: number

      Current rate of bytes sent per second (computed from counter deltas).

      from field: double bytes_sent_per_second = 10;

    • bytesSentTotal: bigint

      Cumulative bytes sent across all bots since the server started.

      from field: uint64 bytes_sent_total = 6;

    • connections: number

      Connection events since the previous snapshot.

      from field: uint32 connections = 18;

    • disconnections: number

      Disconnection events since the previous snapshot.

      from field: uint32 disconnections = 19;

    • maxTickDurationMs: number

      Maximum tick duration observed across all bots in milliseconds. Reset each sampling interval.

      from field: double max_tick_duration_ms = 13;

    • packetsReceivedPerSecond: number

      Current rate of packets received per second (computed from counter deltas).

      from field: double packets_received_per_second = 9;

    • packetsReceivedTotal: bigint

      Cumulative packets received across all bots since the server started.

      from field: uint64 packets_received_total = 5;

    • packetsSentPerSecond: number

      Current rate of packets sent per second (computed from counter deltas).

      from field: double packets_sent_per_second = 8;

    • packetsSentTotal: bigint

      Cumulative packets sent across all bots since the server started.

      from field: uint64 packets_sent_total = 4;

    • Optionaltimestamp?: Timestamp

      When this snapshot was taken.

      from field: google.protobuf.Timestamp timestamp = 1;

    • totalLoadedChunks: number

      Total number of loaded chunks across all online bots.

      from field: uint32 total_loaded_chunks = 16;

    • totalTrackedEntities: number

      Total number of tracked entities across all online bots.

      from field: uint32 total_tracked_entities = 17;

    from message soulfire.v1.MetricsSnapshot

    Settings
    Member Visibility