Skip to content

Commit 2650e1f

Browse files
gwynnemonahanopenshift-cherrypick-robot
authored andcommitted
POWERMON-579 Visualizing power monitoring metrics doc updates
1 parent 74e8b47 commit 2650e1f

File tree

4 files changed

+22
-39
lines changed

4 files changed

+22
-39
lines changed

modules/power-monitoring-accessing-dashboards-admin.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="power-monitoring-accessing-dashboards-admin_{context}"]
77
= Accessing {PM-shortname} dashboards as a cluster administrator
88

9-
You can access {PM-shortname} dashboards from the *Administrator* perspective of the {product-title} web console.
9+
You can access {PM-shortname} dashboards of the {product-title} web console.
1010

1111
.Prerequisites
1212

@@ -18,8 +18,8 @@ You can access {PM-shortname} dashboards from the *Administrator* perspective of
1818
1919
.Procedure
2020

21-
. In the *Administrator* perspective of the web console, go to *Observe* -> *Dashboards*.
21+
. In the web console, go to *Observe* -> *Dashboards*.
2222

23-
. From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see:
24-
** *Power Monitoring / Overview*
25-
** *Power Monitoring / Namespace*
23+
. From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see:
24+
** *Power Monitor / Overview*
25+
** *Power Monitor / Namespace (Pods)*

modules/power-monitoring-accessing-dashboards-developer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="power-monitoring-accessing-dashboards-developer_{context}"]
77
= Accessing {PM-shortname} dashboards as a developer
88

9-
You can access {PM-shortname} dashboards from the *Developer* perspective of the {product-title} web console.
9+
You can access {PM-shortname} dashboards from {product-title} web console.
1010

1111
.Prerequisites
1212

@@ -19,7 +19,7 @@ You can access {PM-shortname} dashboards from the *Developer* perspective of the
1919
2020
.Procedure
2121

22-
. In the *Developer* perspective of the web console, go to *Observe* -> *Dashboard*.
22+
. In the web console, go to *Observe* -> *Dashboard*.
2323

2424
. From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see:
25-
** *Power Monitoring / Overview*
25+
** *Power Monitor / Overview*

modules/power-monitoring-dashboards-overview.adoc

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,21 @@
88

99
There are two types of {PM-shortname} dashboards. Both provide different levels of details around power consumption metrics for a single cluster:
1010

11-
[discrete]
12-
== Power Monitoring / Overview dashboard
11+
[id="power-monitoring-overview-dashboard_{context}"]
12+
== Power Monitor / Overview dashboard
1313

14-
With this dashboard, you can observe the following information:
14+
This dashboard allows you to view the following information:
1515

16-
* An aggregated view of CPU architecture and its power source (`rapl-sysfs`, `rapl-msr`, or `estimator`) along with total nodes with this configuration
16+
Cluster-wide power consumption:: View current total, active, and idle CPU power consumption, grouped by zones.
17+
Node-level power details:: Analyze historical and current power consumption (total, active, and idle) for individual nodes.
18+
Hardware information:: Display CPU model and core counts for each node in the cluster.
19+
Time-series analysis:: Track power consumption trends over time with graphs that can be filtered by node and zone. This provides a comprehensive view of your cluster's energy usage.
1720

18-
* Total energy consumption by a cluster in the last 24 hours (measured in kilowatt-hour)
21+
[id="power-monitor-namespace-pods-dashboard_{context}"]
22+
== Power Monitor / Namespace (Pods) dashboard
1923

20-
* The amount of power consumed by the top 10 namespaces in a cluster in the last 24 hours
24+
This dashboard allows you to monitor and analyze power consumption for Kubernetes namespaces and pods. It provides the following information:
2125

22-
* Detailed node information, such as its CPU architecture and component power source
23-
24-
These features allow you to effectively monitor the energy consumption of the cluster without needing to investigate each namespace separately.
25-
26-
[WARNING]
27-
====
28-
Ensure that the *Components Source* column does not display `estimator` as the power source.
29-
30-
.The Detailed Node Information table with `rapl-sysfs` as the component power source
31-
image::power-monitoring-component-power-source.png[]
32-
33-
If {PM-kepler} is unable to obtain hardware power consumption metrics, the *Components Source* column displays `estimator` as the power source, which is not supported in Technology Preview. If that happens, then the values from the nodes are not accurate.
34-
====
35-
36-
[discrete]
37-
== Power Monitoring / Namespace dashboard
38-
39-
This dashboard allows you to view metrics by namespace and pod. You can observe the following information:
40-
41-
* The power consumption metrics, such as consumption in DRAM and PKG
42-
43-
* The energy consumption metrics in the last hour, such as consumption in DRAM and PKG for core and uncore components
44-
45-
This feature allows you to investigate key peaks and easily identify the primary root causes of high consumption.
26+
Top ten power consuming namespaces:: A real-time table showing the top ten namespaces based on their current power usage. This helps you quickly identify the most resource-intensive workloads.
27+
Total namespace power consumption:: A historical graph showing the total power consumption of pods within a selected namespace over time, grouped by zone. This helps you see trends and understand an application's or service's total power use.
28+
Individual pod power consumption:: A detailed graph showing the power consumption of individual pods, so you can analyze them in detail.

observability/power_monitoring/visualizing-power-monitoring-metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can visualize {PM-shortname} metrics in the {product-title} web console by a
1414
include::modules/power-monitoring-dashboards-overview.adoc[leveloffset=+1]
1515
include::modules/power-monitoring-accessing-dashboards-admin.adoc[leveloffset=+1]
1616
include::modules/power-monitoring-accessing-dashboards-developer.adoc[leveloffset=+1]
17-
include::modules/power-monitoring-metrics-overview.adoc[leveloffset=+1]
17+
//include::modules/power-monitoring-metrics-overview.adoc[leveloffset=+1]
1818

1919
[role="_additional-resources"]
2020
[id="additional-resources_visualizing-power-monitoring-metrics"]

0 commit comments

Comments
 (0)