Skip to content
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

Update doc to note a hostnetwork pods' metrics known behavior #3316

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/storage/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
`container_memory_usage_bytes` | Gauge | Current memory usage, including all memory regardless of when it was accessed | bytes | memory |
`container_memory_working_set_bytes` | Gauge | Current working set | bytes | memory |
`container_network_advance_tcp_stats_total` | Gauge | advanced tcp connections statistic for container | | advtcp |
`container_network_receive_bytes_total` | Counter | Cumulative count of bytes received | bytes | network |
`container_network_receive_errors_total` | Counter | Cumulative count of errors encountered while receiving | | network |
`container_network_receive_packets_dropped_total` | Counter | Cumulative count of packets dropped while receiving | | network |
`container_network_receive_packets_total` | Counter | Cumulative count of packets received | | network |
`container_network_receive_bytes_total` | Counter | Cumulative count of bytes received* | bytes | network |
`container_network_receive_errors_total` | Counter | Cumulative count of errors encountered while receiving* | | network |
`container_network_receive_packets_dropped_total` | Counter | Cumulative count of packets dropped while receiving* | | network |
`container_network_receive_packets_total` | Counter | Cumulative count of packets received* | | network |
`container_network_tcp6_usage_total` | Gauge | tcp6 connection usage statistic for container | | tcp |
`container_network_tcp_usage_total` | Gauge | tcp connection usage statistic for container | | tcp |
`container_network_transmit_bytes_total` | Counter | Cumulative count of bytes transmitted | bytes | network |
Expand Down Expand Up @@ -98,6 +98,8 @@ Metric name | Type | Description | Unit (where applicable) | option parameter |
`container_threads_max` | Gauge | Maximum number of threads allowed inside the container | | process |
`container_ulimits_soft` | Gauge | Soft ulimit values for the container root process. Unlimited if -1, except priority and nice | | process |

* `*`This metrics can be misleading for pod with `hostNetwork: true` ([Details](https://github.com/google/cadvisor/issues/2615)).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use footnote notation instead?


## Prometheus hardware metrics

The table below lists the Prometheus hardware metrics exposed by cAdvisor (in alphabetical order by metric name) and corresponding `-disable_metrics` / `-enable_metrics` option parameter:
Expand Down
Loading