You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/monitoring-querying-metrics-for-all-projects-as-an-administrator.adoc
+22-20Lines changed: 22 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,8 @@ Only dedicated administrators have access to the third-party UIs provided with {
23
23
====
24
24
endif::openshift-dedicated,openshift-rosa[]
25
25
26
+
The Metrics UI includes predefined queries, for example, CPU, memory, bandwidth, or network packet for all projects. You can also run custom Prometheus Query Language (PromQL) queries.
. From the *Administrator* perspective in the {product-title} web console, select*Observe*->*Metrics*.
40
+
. In the *Administrator* perspective of the {product-title} web console, click*Observe*and go to the *Metrics* tab.
39
41
40
-
. To add one or more queries, do any of the following:
42
+
. To add one or more queries, perform any of the following actions:
41
43
+
42
44
|===
43
45
|Option |Description
44
46
47
+
|Select an existing query.
48
+
|From the *Select query* drop-down list, select an existing query.
49
+
45
50
|Create a custom query.
46
51
|Add your Prometheus Query Language (PromQL) query to the *Expression* field.
47
52
48
53
As you type a PromQL expression, autocomplete suggestions appear in a drop-down list. These suggestions include functions, metrics, labels, and time tokens.
49
-
You can use the keyboard arrows to select one of these suggested items and then press Enter to add the item to your expression. You can also move your mouse pointer over a suggested item to view a brief description of that item.
54
+
Use the keyboard arrows to select one of these suggested items and then press Enter to add the item to your expression. Move your mouse pointer over a suggested item to view a brief description of that item.
50
55
51
-
|Add multiple queries. |Select*Add query*.
56
+
|Add multiple queries. |Click*Add query*.
52
57
53
-
|Duplicate an existing query. |Select the Options menu {kebab} next to the query, then choose *Duplicate query*.
58
+
|Duplicate an existing query. |Click the options menu {kebab} next to the query, then choose *Duplicate query*.
54
59
55
-
|Disable a query from being run. |Select the Options menu {kebab} next to the query and choose *Disable query*.
60
+
|Disable a query from being run. |Click the options menu {kebab} next to the query and choose *Disable query*.
56
61
|===
57
62
58
-
. To run queries that you created, select*Run queries*. The metrics from the queries are visualized on the plot. If a query is invalid, the UI shows an error message.
63
+
. To run queries that you created, click*Run queries*. The metrics from the queries are visualized on the plot. If a query is invalid, the UI shows an error message.
59
64
+
60
65
[NOTE]
61
66
====
62
-
Queries that operate on large amounts of data might time out or overload the browser when drawing time series graphs. To avoid this, select *Hide graph* and calibrate your query using only the metrics table. Then, after finding a feasible query, enable the plot to draw the graphs.
63
-
====
64
-
+
65
-
[NOTE]
66
-
====
67
-
By default, the query table shows an expanded view that lists every metric and its current value. You can select *˅* to minimize the expanded view for a query.
67
+
* When drawing time series graphs, queries that operate on large amounts of data might time out or overload the browser. To avoid this, click *Hide graph* and calibrate your query by using only the metrics table. Then, after finding a feasible query, enable the plot to draw the graphs.
68
+
69
+
* By default, the query table shows an expanded view that lists every metric and its current value. Click the *˅* down arrowhead to minimize the expanded view for a query.
68
70
====
69
71
70
72
. Optional: The page URL now contains the queries you ran. To use this set of queries again in the future, save this URL.
71
73
72
-
. Explore the visualized metrics. Initially, all metrics from all enabled queries are shown on the plot. You can select which metrics are shown by doing any of the following:
74
+
. Explore the visualized metrics. Initially, all metrics from all enabled queries are shown on the plot. Select which metrics are shown by performing any of the following actions:
73
75
+
74
76
|===
75
77
|Option |Description
76
78
77
-
|Hide all metrics from a query. |Click the Options menu {kebab} for the query and click *Hide all series*.
79
+
|Hide all metrics from a query. |Click the options menu {kebab} for the query and click *Hide all series*.
78
80
79
81
|Hide a specific metric. |Go to the query table and click the colored square near the metric name.
80
82
81
83
|Zoom into the plot and change the time range.
82
-
a|Either:
84
+
a|Perform one of the following actions:
83
85
84
86
* Visually select the time range by clicking and dragging on the plot horizontally.
85
-
* Use the menu in the left upper corner to select the time range.
87
+
* Use the menu to select the time range.
86
88
87
-
|Reset the time range. |Select*Reset zoom*.
89
+
|Reset the time range. |Click*Reset zoom*.
88
90
89
-
|Display outputs for all queries at a specific point in time. |Hold the mouse cursor on the plot at that point. The query outputs will appear in a pop-up box.
91
+
|Display outputs for all queries at a specific point in time. |Hover over the plot at the point you are interested in. The query outputs appear in a pop-up box.
Copy file name to clipboardExpand all lines: modules/monitoring-querying-metrics-for-user-defined-projects-as-a-developer.adoc
+40-9Lines changed: 40 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
You can access metrics for a user-defined project as a developer or as a user with view permissions for the project.
11
11
12
-
In the *Developer* perspective, the Metrics UI includes some predefined CPU, memory, bandwidth, and network packetqueries for the selected project. You can also run custom Prometheus Query Language (PromQL) queries for CPU, memory, bandwidth, network packet and application metrics for the project.
12
+
The Metrics UI includes predefined queries, for example, CPU, memory, bandwidth, or network packet. These queries are restricted to the selected project. You can also run custom Prometheus Query Language (PromQL) queries for the project.
. From the *Developer* perspective in the {product-title} web console, select*Observe*->*Metrics*.
31
+
. In the *Developer* perspective of the {product-title} web console, click*Observe*and go to the *Metrics* tab.
32
32
33
33
. Select the project that you want to view metrics for in the *Project:* list.
34
34
35
-
. Select a query from the *Select query* list, or create a custom PromQL query based on the selected query by selecting *Show PromQL*. The metrics from the queries are visualized on the plot.
35
+
. To add one or more queries, perform any of the following actions:
36
+
+
37
+
|===
38
+
|Option |Description
39
+
40
+
|Select an existing query.
41
+
|From the *Select query* drop-down list, select an existing query.
42
+
43
+
|Create a custom query.
44
+
|Add your Prometheus Query Language (PromQL) query to the *Expression* field.
45
+
46
+
As you type a PromQL expression, autocomplete suggestions appear in a drop-down list. These suggestions include functions, metrics, labels, and time tokens.
47
+
Use the keyboard arrows to select one of these suggested items and then press Enter to add the item to your expression. Move your mouse pointer over a suggested item to view a brief description of that item.
48
+
49
+
|Add multiple queries. |Click *Add query*.
50
+
51
+
|Duplicate an existing query. |Click the options menu {kebab} next to the query, then choose *Duplicate query*.
52
+
53
+
|Disable a query from being run. |Click the options menu {kebab} next to the query and choose *Disable query*.
54
+
|===
55
+
56
+
. To run queries that you created, click *Run queries*. The metrics from the queries are visualized on the plot. If a query is invalid, the UI shows an error message.
36
57
+
37
58
[NOTE]
38
59
====
39
-
In the Developer perspective, you can only run one query at a time.
60
+
* When drawing time series graphs, queries that operate on large amounts of data might time out or overload the browser. To avoid this, click *Hide graph* and calibrate your query by using only the metrics table. Then, after finding a feasible query, enable the plot to draw the graphs.
61
+
62
+
* By default, the query table shows an expanded view that lists every metric and its current value. Click the *˅* down arrowhead to minimize the expanded view for a query.
40
63
====
41
64
42
-
. Explore the visualized metrics by doing any of the following:
65
+
. Optional: The page URL now contains the queries you ran. To use this set of queries again in the future, save this URL.
66
+
67
+
. Explore the visualized metrics. Initially, all metrics from all enabled queries are shown on the plot. Select which metrics are shown by performing any of the following actions:
43
68
+
44
69
|===
45
70
|Option |Description
46
71
72
+
|Hide all metrics from a query. |Click the options menu {kebab} for the query and click *Hide all series*.
73
+
74
+
|Hide a specific metric. |Go to the query table and click the colored square near the metric name.
75
+
47
76
|Zoom into the plot and change the time range.
48
-
a|Either:
77
+
a|Perform one of the following actions:
49
78
50
79
* Visually select the time range by clicking and dragging on the plot horizontally.
51
-
* Use the menu in the left upper corner to select the time range.
80
+
* Use the menu to select the time range.
81
+
82
+
|Reset the time range. |Click *Reset zoom*.
52
83
53
-
|Reset the time range. |Select *Reset zoom*.
84
+
|Display outputs for all queries at a specific point in time. |Hover over the plot at the point you are interested in. The query outputs appear in a pop-up box.
54
85
55
-
|Display outputs for all queries at a specific point in time. |Hold the mouse cursor on the plot at that point. The query outputs appear in a pop-up box.
Copy file name to clipboardExpand all lines: observability/monitoring/reviewing-monitoring-dashboards.adoc
+1-11Lines changed: 1 addition & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -26,21 +26,11 @@ Use the *Administrator* perspective to access dashboards for the core {product-t
26
26
.Example dashboard in the Administrator perspective
27
27
image::monitoring-dashboard-administrator.png[]
28
28
29
-
Use the *Developer* perspective to access Kubernetes compute resources dashboards that provide the following application metrics for a selected project:
30
-
31
-
* CPU usage
32
-
* Memory usage
33
-
* Bandwidth information
34
-
* Packet rate information
29
+
In the *Developer* perspective, you can access only the Kubernetes compute resources dashboards:
35
30
36
31
.Example dashboard in the Developer perspective
37
32
image::observe-dashboard-developer.png[]
38
33
39
-
[NOTE]
40
-
====
41
-
In the *Developer* perspective, you can view dashboards for only one project at a time.
42
-
====
43
-
44
34
// Reviewing monitoring dashboards as a cluster administrator
0 commit comments