docs/generated/http/nodes-other.md
<a name="cockroach.server.status.statuspb.NodeStatus"></a>
NodeStatus records the most recent values of metrics for a node.
Support status: alpha
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| desc | cockroach.roachpb.NodeDescriptor | desc is the node descriptor. | reserved | |
| build_info | cockroach.build.Info | build_info describes the cockroach executable file. | alpha | |
| started_at | int64 | started_at is the unix timestamp at which the node process was last started. | alpha | |
| updated_at | int64 | updated_at is the unix timestamp at which the node status record was last updated. | alpha | |
| metrics | NodeStatus.MetricsEntry | repeated | metrics contains the last sampled values for the node metrics. | reserved |
| store_statuses | StoreStatus | repeated | store_statuses provides the store status payloads for all the stores on that node. | reserved |
| args | string | repeated | args is the list of command-line arguments used to last start the node. | reserved |
| env | string | repeated | env is the list of environment variables that influenced the node's configuration. | reserved |
| latencies | NodeStatus.LatenciesEntry | repeated | latencies is a map of nodeIDs to nanoseconds which is the latency between this node and the other node. |
NOTE: this is deprecated and is only set if the min supported cluster version is >= VersionRPCNetworkStats. | reserved |
| activity | NodeStatus.ActivityEntry | repeated | activity is a map of nodeIDs to network statistics from this node to other nodes. | reserved |
| total_system_memory | int64 | | total_system_memory is the total RAM available to the system (or, if detected, the memory available to the cgroup this process is in) in bytes. | alpha |
| num_cpus | int32 | | num_cpus is the number of logical CPUs as reported by the operating system on the host where the cockroach process is running. This reflects the physical CPU count and does not account for container/cgroup limits. See num_vcpus for container-aware CPU allocation. | alpha |
| num_vcpus | double | | num_vcpus is the number of vCPUs allocated to the process by the container orchestrator (e.g., Kubernetes, Docker) based on cgroup CPU quota/period. This represents the platform CPU allocation and is independent of GOMAXPROCS runtime tuning. Falls back to num_cpus if no container limits are configured. Supports fractional values (e.g., 1.5 for Kubernetes CPU limits like "1500m"). | alpha |
<a name="cockroach.server.status.statuspb.NodeStatus.MetricsEntry"></a>
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| key | string | |||
| value | double |
<a name="cockroach.server.status.statuspb.StoreStatus"></a>
StoreStatus records the most recent values of metrics for a store.
Support status: reserved
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| desc | cockroach.roachpb.StoreDescriptor | desc is the store descriptor. | reserved | |
| metrics | StoreStatus.MetricsEntry | repeated | metrics contains the last sampled values for the node metrics. | reserved |
<a name="cockroach.server.status.statuspb.StoreStatus.MetricsEntry"></a>
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| key | string | |||
| value | double |
<a name="cockroach.server.status.statuspb.NodeStatus.LatenciesEntry"></a>
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| key | int32 | |||
| value | int64 |
<a name="cockroach.server.status.statuspb.NodeStatus.ActivityEntry"></a>
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| key | int32 | |||
| value | NodeStatus.NetworkActivity |
<a name="cockroach.server.status.statuspb.NodeStatus.NetworkActivity"></a>
Support status: reserved
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| latency | int64 | in nanoseconds | reserved |
<a name="cockroach.server.serverpb.NodesResponse.LivenessByNodeIdEntry"></a>
| Field | Type | Label | Description | Support status |
|---|---|---|---|---|
| key | int32 | |||
| value | cockroach.kv.kvserver.liveness.livenesspb.NodeLivenessStatus |