-
Notifications
You must be signed in to change notification settings - Fork 1
Add additional telemetry types to the server live snapshot #827
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mattoni
merged 1 commit into
main
from
mattoni/eng-4609-add-process-disk-and-network-telemetry-types-to-api-spec
Jun 22, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
components/schemas/infrastructure/servers/telemetry/ServerTelemetryDeviceStats.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| type: object | ||
| title: ServerTelemetryDeviceStats | ||
| description: Network interface counters for a single device, as reported by the kernel (/proc/net/dev). All counters are cumulative since boot. | ||
| required: | ||
| - name | ||
| - rx_bytes | ||
| - rx_packets | ||
| - rx_errors | ||
| - rx_drop | ||
| - rx_fifo | ||
| - rx_frame | ||
| - rx_compressed | ||
| - rx_multicast | ||
| - tx_bytes | ||
| - tx_packets | ||
| - tx_errors | ||
| - tx_drop | ||
| - tx_fifo | ||
| - tx_colls | ||
| - tx_carrier | ||
| - tx_compressed | ||
| properties: | ||
| name: | ||
| type: string | ||
| description: The name of the network interface (e.g. "eth0"). | ||
| rx_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total bytes received. | ||
| rx_packets: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total packets received. | ||
| rx_errors: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total receive errors. | ||
| rx_drop: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total received packets dropped. | ||
| rx_fifo: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total receive FIFO buffer errors. | ||
| rx_frame: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total receive framing errors. | ||
| rx_compressed: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total compressed packets received. | ||
| rx_multicast: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total multicast packets received. | ||
| tx_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total bytes transmitted. | ||
| tx_packets: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total packets transmitted. | ||
| tx_errors: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total transmit errors. | ||
| tx_drop: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total transmitted packets dropped. | ||
| tx_fifo: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total transmit FIFO buffer errors. | ||
| tx_colls: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total collisions detected on the interface. | ||
| tx_carrier: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total transmit carrier losses. | ||
| tx_compressed: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total compressed packets transmitted. |
13 changes: 13 additions & 0 deletions
13
components/schemas/infrastructure/servers/telemetry/ServerTelemetryDisk.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| type: object | ||
| title: ServerTelemetryDisk | ||
| description: Disk telemetry for the server. | ||
| required: | ||
| - devices | ||
| properties: | ||
| devices: | ||
| type: | ||
| - object | ||
| - "null" | ||
| description: Per-device disk telemetry, keyed by device name. | ||
| additionalProperties: | ||
| $ref: ./ServerTelemetryDiskDevice.yml |
20 changes: 20 additions & 0 deletions
20
components/schemas/infrastructure/servers/telemetry/ServerTelemetryDiskDevice.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| type: object | ||
| title: ServerTelemetryDiskDevice | ||
| description: Telemetry for a single disk device on the server. | ||
| required: | ||
| - name | ||
| - io | ||
| - usage | ||
| properties: | ||
| name: | ||
| type: string | ||
| description: The name of the disk device (e.g. "vda"). | ||
| mount: | ||
| type: string | ||
| description: The filesystem mount point for the device. | ||
| io: | ||
| $ref: ./ServerTelemetryDiskIo.yml | ||
| description: Block-device I/O counters for the device. | ||
| usage: | ||
| $ref: ./ServerTelemetryDiskUsage.yml | ||
| description: Filesystem usage for the device. | ||
53 changes: 53 additions & 0 deletions
53
components/schemas/infrastructure/servers/telemetry/ServerTelemetryDiskIo.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| type: object | ||
| title: ServerTelemetryDiskIo | ||
| description: Block-device I/O counters for a single disk device, as reported by the kernel (/proc/diskstats). All counters are cumulative since boot. | ||
| required: | ||
| - read_requests | ||
| - read_sectors | ||
| - read_time_ms | ||
| - write_requests | ||
| - write_sectors | ||
| - write_time_ms | ||
| - io_in_progress | ||
| - io_time_ms | ||
| properties: | ||
| read_requests: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total number of completed read requests. | ||
| read_sectors: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total number of sectors read. Multiply by 512 for bytes. | ||
| read_time_ms: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total time spent servicing read requests, in milliseconds. | ||
| write_requests: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total number of completed write requests. | ||
| write_sectors: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total number of sectors written. Multiply by 512 for bytes. | ||
| write_time_ms: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total time spent servicing write requests, in milliseconds. | ||
| io_in_progress: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Number of I/O requests currently in progress. | ||
| io_time_ms: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total time spent performing I/O, in milliseconds. |
29 changes: 29 additions & 0 deletions
29
components/schemas/infrastructure/servers/telemetry/ServerTelemetryDiskUsage.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| type: object | ||
| title: ServerTelemetryDiskUsage | ||
| description: Filesystem usage for a single disk device. Reported as zero for devices without a mounted filesystem. | ||
| required: | ||
| - total_bytes | ||
| - free_bytes | ||
| - available_bytes | ||
| - used_percent | ||
| properties: | ||
| total_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Total size of the filesystem, in bytes. | ||
| free_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Free space on the filesystem, in bytes. | ||
| available_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Free space accessible to unprivileged users, in bytes. | ||
| used_percent: | ||
| type: number | ||
| format: double | ||
| minimum: 0 | ||
| description: Percentage of the filesystem currently in use. |
23 changes: 23 additions & 0 deletions
23
components/schemas/infrastructure/servers/telemetry/ServerTelemetryLoadAvg.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| type: object | ||
| title: ServerTelemetryLoadAvg | ||
| description: System load averages over the last 1, 5, and 15 minutes. | ||
| required: | ||
| - last_1_min | ||
| - last_5_min | ||
| - last_15_min | ||
| properties: | ||
| last_1_min: | ||
| type: number | ||
| format: double | ||
| minimum: 0 | ||
| description: The system load average over the last 1 minute. | ||
| last_5_min: | ||
| type: number | ||
| format: double | ||
| minimum: 0 | ||
| description: The system load average over the last 5 minutes. | ||
| last_15_min: | ||
| type: number | ||
| format: double | ||
| minimum: 0 | ||
| description: The system load average over the last 15 minutes. |
13 changes: 13 additions & 0 deletions
13
components/schemas/infrastructure/servers/telemetry/ServerTelemetryNetwork.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| type: object | ||
| title: ServerTelemetryNetwork | ||
| description: Network telemetry for the server. | ||
| required: | ||
| - devices | ||
| properties: | ||
| devices: | ||
| type: | ||
| - object | ||
| - "null" | ||
| description: Per-interface network counters, keyed by interface name. | ||
| additionalProperties: | ||
| $ref: ./ServerTelemetryDeviceStats.yml |
27 changes: 27 additions & 0 deletions
27
components/schemas/infrastructure/servers/telemetry/ServerTelemetryProcess.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| type: object | ||
| title: ServerTelemetryProcess | ||
| description: Telemetry for a single running process on the server. | ||
| required: | ||
| - pid | ||
| - cmdline | ||
| - fds | ||
| - stat | ||
| - io | ||
| properties: | ||
| pid: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: The process ID. | ||
| cmdline: | ||
| type: string | ||
| description: The full command line the process was started with. | ||
| fds: | ||
| $ref: ./ServerTelemetryProcessFds.yml | ||
| description: A breakdown of the file descriptors the process holds open. | ||
| stat: | ||
| $ref: ./ServerTelemetryProcessStats.yml | ||
| description: Scheduling and memory statistics for the process. | ||
| io: | ||
| $ref: ./ServerTelemetryProcessIo.yml | ||
| description: I/O accounting for the process. |
30 changes: 30 additions & 0 deletions
30
components/schemas/infrastructure/servers/telemetry/ServerTelemetryProcessFds.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| type: object | ||
| title: ServerTelemetryProcessFds | ||
| description: A breakdown of the file descriptors held open by a process. | ||
| required: | ||
| - total | ||
| - files | ||
| - sockets | ||
| - pipes | ||
| - other | ||
| properties: | ||
| total: | ||
| type: integer | ||
| format: int64 | ||
| description: Total number of open file descriptors. | ||
| files: | ||
| type: integer | ||
| format: int64 | ||
| description: Number of descriptors referring to regular files. | ||
| sockets: | ||
| type: integer | ||
| format: int64 | ||
| description: Number of descriptors referring to sockets. | ||
| pipes: | ||
| type: integer | ||
| format: int64 | ||
| description: Number of descriptors referring to pipes. | ||
| other: | ||
| type: integer | ||
| format: int64 | ||
| description: Number of descriptors of other types (e.g. epoll, eventfd, anonymous inodes). |
47 changes: 47 additions & 0 deletions
47
components/schemas/infrastructure/servers/telemetry/ServerTelemetryProcessIo.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| type: object | ||
| title: ServerTelemetryProcessIo | ||
| description: I/O accounting for a process, as reported by the kernel (/proc/[pid]/io). All counters are cumulative over the life of the process. | ||
| required: | ||
| - rchar | ||
| - wchar | ||
| - syscr | ||
| - syscw | ||
| - read_bytes | ||
| - write_bytes | ||
| - cancelled_write_bytes | ||
| properties: | ||
| rchar: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Bytes read by the process via read-like syscalls, whether or not they hit storage. | ||
| wchar: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Bytes written by the process via write-like syscalls, whether or not they hit storage. | ||
| syscr: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Number of read syscalls issued. | ||
| syscw: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Number of write syscalls issued. | ||
| read_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Bytes actually fetched from the storage layer. | ||
| write_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Bytes actually sent to the storage layer. | ||
| cancelled_write_bytes: | ||
| type: integer | ||
| format: int64 | ||
| minimum: 0 | ||
| description: Bytes written but later truncated or cancelled before reaching storage. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if mount is not required it must be nullable