Skip to content

Commit 65120ac

Browse files
jasonnovichRunAIjasonnovichRunAI
authored
Merge pull request #768 from run-ai/natasha/RUN-17720-rename-metrics
rename some emtrics
2 parents cff5093 + 600b996 commit 65120ac

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

‎docs/developer/metrics/metrics.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The purpose of this document is to detail the structure and purpose of metrics e
1515
Run:ai uses [Prometheus](https://prometheus.io){target=_blank} for collecting and querying metrics.
1616

1717
!!! Note
18-
From cluster version 2.17 onwards, Run:ai will support metrics via the Run:ai API and direct metrics queries (metrics that are queried directly from Prometheus) will be deprecated.
18+
From cluster version 2.17 and onwards, Run:ai will support metrics via the Run:ai API and direct metrics queries (metrics that are queried directly from Prometheus) will be deprecated.
1919

2020
## Published Run:ai Metrics
2121

@@ -114,35 +114,35 @@ For additional information, see Kubernetes [kube-state-metrics](https://github.c
114114

115115
Starting in cluster version 2.17, some of the metrics names have been changed. In addition some Run:ai metrics are available as API endpoints. Using the API endpoints is more efficient and provides an easier way of retrieving metrics in any application. The following table lists the metrics that were changed.
116116

117-
| Metric name in version 2.16 | 2.17 Change Description | 2.17 API Endpoint |
118-
| --- |-------------------------------------------------------------------------------------------------------| --- |
119-
| runai\_active\_job\_cpu\_requested\_cores | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_REQUEST" metricType |
120-
| runai\_active\_job\_memory\_requested\_bytes | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_REQUEST" metricType |
121-
| runai\_cluster\_cpu\_utilization | available also via API | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics ; with "CPU\_UTILIZATION" metricType |
122-
| runai\_cluster\_memory\_utilization | available also via API | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics ; with "CPU\_MEMORY\_UTILIZATION" metricType |
123-
| runai\_gpu\_utilization\_non\_fractional\_jobs | no longer available | |
124-
| runai\_allocated\_gpu\_count\_per\_workload | labels changed | |
125-
| runai\_gpu\_utilization\_per\_pod\_per\_gpu | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/pods/{podId}/metrics ; with "GPU\_UTILIZATION\_PER\_GPU" metricType |
126-
| runai\_gpu\_utilization\_per\_workload | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_UTILIZATION" metricType |
127-
| runai\_job\_image | no longer available | |
128-
| runai\_job\_requested\_gpu\_memory | available also via API + renamed to: "runai\_requested\_gpu\_memory\_mb\_per\_workload" with different labels | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_MEMORY\_REQUEST" metricType |
129-
| runai\_job\_requested\_gpus | renamed to: "runai\_requested\_gpus\_per\_workload" with different labels | |
130-
| runai\_job\_total\_runtime | renamed to: "runai\_run\_time\_seconds\_per\_workload" with different labels | |
131-
| runai\_job\_total\_wait\_time | renamed to: "runai\_wait\_time\_seconds\_per\_workload" with different labels | |
132-
| runai\_gpu\_memory\_used\_mebibytes\_per\_workload | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_MEMORY\_USAGE" metricType |
133-
| runai\_gpu\_memory\_used\_mebibytes\_per\_pod\_per\_gpu | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/pods/{podId}/metrics ; with "GPU\_MEMORY\_USAGE\_PER\_GPU" metricType |
134-
| runai\_node\_gpu\_used\_memory\_bytes | renamed and changed units: "runai\_gpu\_memory\_used\_mebibytes\_per\_node" | |
135-
| runai\_node\_total\_memory\_bytes | renamed and changed units: "runai\_gpu\_memory\_total\_mebibytes\_per\_node" | |
136-
| runai\_project\_info | labels changed | |
137-
| runai\_active\_job\_cpu\_limits | available also via + renamed to: "runai\_cpu\_limits\_per\_active\_workload" | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_LIMIT" metricType |
138-
| runai\_job\_cpu\_usage | available also via + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_USAGE" metricType |
139-
| runai\_active\_job\_memory\_limits | available also via + renamed to: "runai\_memory\_limits\_per\_active\_workload" | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_LIMIT" metricType |
140-
| runai\_running\_job\_memory\_requested\_bytes | was a duplication of "runai\_active\_job\_memory\_requested\_bytes", see above | |
141-
| runai\_job\_memory\_used\_bytes | available also via + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_USAGE" metricType |
142-
| runai\_job\_swap\_memory\_used\_bytes | no longer available | |
143-
| runai\_gpu\_count\_per\_node | added labels | |
144-
| runai\_last\_gpu\_utilization\_time\_per\_workload | labels changed | |
145-
| runai\_gpu\_idle\_time\_per\_workload | renamed to: "runai\_gpu\_idle\_seconds\_per\_workload" with different labels | |
117+
| Metric name in version 2.16 | 2.17 Change Description | 2.17 API Endpoint |
118+
| --- |-------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
119+
| runai\_active\_job\_cpu\_requested\_cores | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_REQUEST\_CORES" metricType |
120+
| runai\_active\_job\_memory\_requested\_bytes | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_REQUEST\_BYTES" metricType |
121+
| runai\_cluster\_cpu\_utilization | available also via API | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics ; with "CPU\_UTILIZATION" metricType |
122+
| runai\_cluster\_memory\_utilization | available also via API | https://app.run.ai/api/v2/clusters/{clusterUuid}/metrics ; with "CPU\_MEMORY\_UTILIZATION" metricType |
123+
| runai\_gpu\_utilization\_non\_fractional\_jobs | no longer available | |
124+
| runai\_allocated\_gpu\_count\_per\_workload | labels changed | |
125+
| runai\_gpu\_utilization\_per\_pod\_per\_gpu | available also via API | https://app.run.ai/api/v1/workloads/{workloadId}/pods/{podId}/metrics ; with "GPU\_UTILIZATION\_PER\_GPU" metricType |
126+
| runai\_gpu\_utilization\_per\_workload | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_UTILIZATION" metricType |
127+
| runai\_job\_image | no longer available | |
128+
| runai\_job\_requested\_gpu\_memory | available also via API + renamed to: "runai\_requested\_gpu\_memory\_mb\_per\_workload" with different labels | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_MEMORY\_REQUEST\_BYTES" metricType |
129+
| runai\_job\_requested\_gpus | renamed to: "runai\_requested\_gpus\_per\_workload" with different labels | |
130+
| runai\_job\_total\_runtime | renamed to: "runai\_run\_time\_seconds\_per\_workload" with different labels | |
131+
| runai\_job\_total\_wait\_time | renamed to: "runai\_wait\_time\_seconds\_per\_workload" with different labels | |
132+
| runai\_gpu\_memory\_used\_mebibytes\_per\_workload | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "GPU\_MEMORY\_USAGE\_BYTES" metricType |
133+
| runai\_gpu\_memory\_used\_mebibytes\_per\_pod\_per\_gpu | available also via API + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/pods/{podId}/metrics ; with "GPU\_MEMORY\_USAGE\_BYTES\_PER\_GPU" metricType |
134+
| runai\_node\_gpu\_used\_memory\_bytes | renamed and changed units: "runai\_gpu\_memory\_used\_mebibytes\_per\_node" | |
135+
| runai\_node\_total\_memory\_bytes | renamed and changed units: "runai\_gpu\_memory\_total\_mebibytes\_per\_node" | |
136+
| runai\_project\_info | labels changed | |
137+
| runai\_active\_job\_cpu\_limits | available also via + renamed to: "runai\_cpu\_limits\_per\_active\_workload" | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_LIMIT\_CORES" metricType |
138+
| runai\_job\_cpu\_usage | available also via + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_USAGE\_CORES" metricType |
139+
| runai\_active\_job\_memory\_limits | available also via + renamed to: "runai\_memory\_limits\_per\_active\_workload" | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_LIMIT\_BYTES" metricType |
140+
| runai\_running\_job\_memory\_requested\_bytes | was a duplication of "runai\_active\_job\_memory\_requested\_bytes", see above | |
141+
| runai\_job\_memory\_used\_bytes | available also via + labels changed | https://app.run.ai/api/v1/workloads/{workloadId}/metrics ; with "CPU\_MEMORY\_USAGE\_BYTES" metricType |
142+
| runai\_job\_swap\_memory\_used\_bytes | no longer available | |
143+
| runai\_gpu\_count\_per\_node | added labels | |
144+
| runai\_last\_gpu\_utilization\_time\_per\_workload | labels changed | |
145+
| runai\_gpu\_idle\_time\_per\_workload | renamed to: "runai\_gpu\_idle\_seconds\_per\_workload" with different labels | |
146146

147147
## Create custom dashboards
148148

0 commit comments

Comments
 (0)