Skip to content

Commit

Permalink
docs: Added host prefix to host-based metrics (vectordotdev#3637)
Browse files Browse the repository at this point in the history
Signed-off-by: James Turnbull <[email protected]>
  • Loading branch information
jamtur01 authored Aug 30, 2020
1 parent 3cbf4af commit 60c7af9
Showing 1 changed file with 43 additions and 43 deletions.
86 changes: 43 additions & 43 deletions rfcs/2020-08-26-3191-host-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,46 +41,46 @@ For this implementation we're recommending the Heim crate based on platform and

We'd use one of these to collect the following metrics:

- `cpu_seconds_total` tagged with mode (idle, nice, system, user) and CPU. (counter)
- `disk_read_bytes_total` tagged with the disk (counter)
- `disk_read_errors_total` tagged with the disk (counter)
- `disk_read_retries_total` tagged with the disk (counter)
- `disk_read_sectors_total` tagged with the disk (counter)
- `disk_read_time_seconds_total` tagged with the disk (counter)
- `disk_reads_completed_total` tagged with the disk (counter)
- `disk_write_errors_total` tagged with the disk (counter)
- `disk_write_retries_total` tagged with the disk (counter)
- `disk_write_time_seconds_total` tagged with the disk (counter)
- `disk_writes_completed_total` tagged with the disk (counter)
- `disk_written_bytes_total` tagged with the disk (counter)
- `disk_written_sectors_total` tagged with the disk (counter)
- `filesystem_avail_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `filesystem_device_error` tagged with the device, filesystem type, and mountpoint (gauge)
- `filesystem_free_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `filesystem_size_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `filesystem_total_file_nodes` tagged with the device, filesystem type, and mountpoint (gauge)
- `filesystem_free_file_nodes` tagged with the device, filesystem type, and mountpoint (gauge)
- `load1` (gauge)
- `load5` (gauge)
- `load15` (gauge)
- `memory_active_bytes` (gauge)
- `memory_compressed_bytes` (gauge)
- `memory_free_bytes` (gauge)
- `memory_inactive_bytes` (gauge)
- `memory_swap_total_bytes` (gauge)
- `memory_swap_used_bytes` (gauge)
- `memory_swapped_in_bytes_total` (gauge)
- `memory_swapped_out_bytes_total` (gauge)
- `memory_total_bytes` (gauge)
- `memory_wired_bytes` (gauge)
- `network_receive_bytes_total` tagged with device (counter)
- `network_receive_errs_total` tagged with device (counter)
- `network_receive_multicast_total` tagged with device (counter)
- `network_receive_packets_total` tagged with device (counter)
- `network_transmit_bytes_total` tagged with device (counter)
- `network_transmit_errs_total` tagged with device (counter)
- `network_transmit_multicast_total` tagged with device (counter)
- `network_transmit_packets_total` tagged with device (counter)
- `host_cpu_seconds_total` tagged with mode (idle, nice, system, user) and CPU. (counter)
- `host_disk_read_bytes_total` tagged with the disk (counter)
- `host_disk_read_errors_total` tagged with the disk (counter)
- `host_disk_read_retries_total` tagged with the disk (counter)
- `host_disk_read_sectors_total` tagged with the disk (counter)
- `host_disk_read_time_seconds_total` tagged with the disk (counter)
- `host_disk_reads_completed_total` tagged with the disk (counter)
- `host_disk_write_errors_total` tagged with the disk (counter)
- `host_disk_write_retries_total` tagged with the disk (counter)
- `host_disk_write_time_seconds_total` tagged with the disk (counter)
- `host_disk_writes_completed_total` tagged with the disk (counter)
- `host_disk_written_bytes_total` tagged with the disk (counter)
- `host_disk_written_sectors_total` tagged with the disk (counter)
- `host_filesystem_avail_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_filesystem_device_error` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_filesystem_free_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_filesystem_size_bytes` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_filesystem_total_file_nodes` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_filesystem_free_file_nodes` tagged with the device, filesystem type, and mountpoint (gauge)
- `host_load1` (gauge)
- `host_load5` (gauge)
- `host_load15` (gauge)
- `host_memory_active_bytes` (gauge)
- `host_memory_compressed_bytes` (gauge)
- `host_memory_free_bytes` (gauge)
- `host_memory_inactive_bytes` (gauge)
- `host_memory_swap_total_bytes` (gauge)
- `host_memory_swap_used_bytes` (gauge)
- `host_memory_swapped_in_bytes_total` (gauge)
- `host_memory_swapped_out_bytes_total` (gauge)
- `host_memory_total_bytes` (gauge)
- `host_memory_wired_bytes` (gauge)
- `host_network_receive_bytes_total` tagged with device (counter)
- `host_network_receive_errs_total` tagged with device (counter)
- `host_network_receive_multicast_total` tagged with device (counter)
- `host_network_receive_packets_total` tagged with device (counter)
- `host_network_transmit_bytes_total` tagged with device (counter)
- `host_network_transmit_errs_total` tagged with device (counter)
- `host_network_transmit_multicast_total` tagged with device (counter)
- `host_network_transmit_packets_total` tagged with device (counter)

Users should be able to limit the collection of metrics to specific classes, here: `cpu`, `memory`, `disk`, `filesystem`, `load`, and `network`.

Expand All @@ -99,9 +99,9 @@ And `collector` for type of metric:

Specific explanation of some of the filesystem metrics:

- `filesystem_avail_bytes` = Filesystem space available to non-root users in bytes (including reserved blocks).
- `filesystem_free_bytes` = Filesystem free space in bytes (excluding reserved blocks).
- `filesystem_size_bytes` = Filesystem size in bytes.
- `host_filesystem_avail_bytes` = Filesystem space available to non-root users in bytes (including reserved blocks).
- `host_filesystem_free_bytes` = Filesystem free space in bytes (excluding reserved blocks).
- `host_filesystem_size_bytes` = Filesystem size in bytes.


## Doc-level Proposal
Expand Down

0 comments on commit 60c7af9

Please sign in to comment.