SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ServerMetricsSnapshot

    ServerMetricsSnapshot: Message<"soulfire.v1.ServerMetricsSnapshot"> & {
        availableProcessors: number;
        daemonThreadCount: number;
        gcCollectionCount: bigint;
        gcCollectionTimeMs: bigint;
        heapCommittedBytes: bigint;
        heapMaxBytes: bigint;
        heapUsedBytes: bigint;
        instancesWithDesiredBots: number;
        nonHeapUsedBytes: bigint;
        processCpuLoad: number;
        systemCpuLoad: number;
        threadCount: number;
        timestamp?: Timestamp;
        totalBotsDesired: number;
        totalBotsFailed: number;
        totalBotsOnline: number;
        totalBotsRetrying: number;
        totalBotsStarting: number;
        totalBotsTotal: number;
        uptimeMs: bigint;
    }

    A single server-level system metrics data point sampled at a fixed interval.

    Type Declaration

    • availableProcessors: number

      Number of available processors.

      from field: uint32 available_processors = 13;

    • daemonThreadCount: number

      Current daemon thread count.

      from field: uint32 daemon_thread_count = 9;

    • gcCollectionCount: bigint

      Cumulative GC collection count across all collectors.

      from field: uint64 gc_collection_count = 10;

    • gcCollectionTimeMs: bigint

      Cumulative GC collection time in milliseconds across all collectors.

      from field: uint64 gc_collection_time_ms = 11;

    • heapCommittedBytes: bigint

      Heap memory committed (reserved by JVM) in bytes.

      from field: uint64 heap_committed_bytes = 5;

    • heapMaxBytes: bigint

      Maximum heap memory in bytes (-1 if undefined).

      from field: int64 heap_max_bytes = 6;

    • heapUsedBytes: bigint

      Heap memory currently used in bytes.

      from field: uint64 heap_used_bytes = 4;

    • instancesWithDesiredBots: number

      Instances with at least one desired bot.

      from field: uint32 instances_with_desired_bots = 18;

    • nonHeapUsedBytes: bigint

      Non-heap memory currently used in bytes.

      from field: uint64 non_heap_used_bytes = 7;

    • processCpuLoad: number

      JVM process CPU load (0.0 to 1.0, or -1.0 if unavailable).

      from field: double process_cpu_load = 2;

    • systemCpuLoad: number

      System-wide CPU load (0.0 to 1.0, or -1.0 if unavailable).

      from field: double system_cpu_load = 3;

    • threadCount: number

      Current live thread count.

      from field: uint32 thread_count = 8;

    • Optionaltimestamp?: Timestamp

      When this snapshot was taken.

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

    • totalBotsDesired: number

      Total bots desired to be running across all instances.

      from field: uint32 total_bots_desired = 17;

    • totalBotsFailed: number

      Desired bots whose latest connection attempt failed.

      from field: uint32 total_bots_failed = 21;

    • totalBotsOnline: number

      Total bots online across all instances.

      from field: uint32 total_bots_online = 14;

    • totalBotsRetrying: number

      Bots waiting for an automatic reconnect.

      from field: uint32 total_bots_retrying = 20;

    • totalBotsStarting: number

      Bots currently queued or starting.

      from field: uint32 total_bots_starting = 19;

    • totalBotsTotal: number

      Total bots configured across all instances.

      from field: uint32 total_bots_total = 15;

    • uptimeMs: bigint

      JVM uptime in milliseconds.

      from field: uint64 uptime_ms = 12;

    from message soulfire.v1.ServerMetricsSnapshot

    Settings
    Member Visibility