Skip to content

Commit

Permalink
Control plane metrics FAQ (#664)
Browse files Browse the repository at this point in the history
* metrics faq

* Apply suggestions from code review

Co-authored-by: Jay Shaughnessy <jshaughn@users.noreply.github.com>

* fix details

---------

Co-authored-by: Jay Shaughnessy <jshaughn@users.noreply.github.com>
  • Loading branch information
leandroberetta and jshaughn committed Jun 22, 2023
1 parent bc835ef commit 4f84de1
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion content/en/docs/FAQ/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,10 @@ Kiali currently requires the following metrics and attributes:

|Metric |Notes|
|--------------------------------------------|-----|
|process_cpu_seconds_total |used to graph cpu usage in the control plane overview card |
|container_cpu_usage_seconds_total |used to graph cpu usage in the control plane overview card|
|container_memory_working_set_bytes |used to graph memory usage in the control plane overview card |
|process_cpu_seconds_total |used to graph cpu usage in the control plane overview card (if the container metric is not available)|
|process_resident_memory_bytes |used to graph memory usage in the control plane overview card (if the container metric is not available)|

<br />

Expand Down Expand Up @@ -225,3 +227,17 @@ protocols to communicate. For these cases, Istio logs the traffic as raw TCP
possible to know if any traffic have failed or succeeded and reports Health as
unavailable.

### Why are the control plane metrics missing from the control plane card?

The control plane metrics are fetched from the Prometheus configured in Kiali.

Kiali will fetch the memory and the CPU metrics related to the Istiod container (discovery) first and will fallback to the metrics related to the istiod process if it couldn't find the container metrics. If the required metrics are not found then Kiali can not display the related charts or data.

The metrics used are:

|Metric |Notes|
|--------------------------------------------|-----|
|container_cpu_usage_seconds_total |used for Istiod's discovery container CPU metric |
|container_memory_working_set_bytes |used for Istiod's discovery container memory metric|
|process_cpu_seconds_total |used for Istiod process CPU metric|
|process_resident_memory_bytes |used for Istiod process memory metric|

0 comments on commit 4f84de1

Please sign in to comment.