Skip to content

Commit 85038f0

Browse files
committed
configure custom prometheus metrics adoc
1 parent c21d206 commit 85038f0

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,8 @@ Topics:
192192
File: managing-preview-features
193193
- Name: Configuring and integrating the RHACS plugin with Red Hat Developer Hub
194194
File: configuring-and-integrating-the-rhacs-plugin-with-red-hat-developer-hub
195+
- Name: Configuring Custom Prometheus metrics
196+
File: configure-custom-prometheus-metrics
195197
---
196198
Name: Operating
197199
Dir: operating
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
[id="configure-custom-prometheus-metrics"]
2+
= Configuring custom Prometheus metrics
3+
include::modules/common-attributes.adoc[]
4+
:context: configure-custom-prometheus-metrics
5+
6+
toc::[]
7+
8+
[role="_abstract"]
9+
With {product-title}, you can enable some Prometheus metrics to be exposed on the `/metrics` path of the central API endpoint.
10+
11+
The available metric categories include:
12+
13+
* Image vulnerabilities.
14+
15+
Each category is configured with a data gathering period and a list of metrics. A metric is associated with a set of labels.
16+
17+
[NOTE]
18+
====
19+
The `/metrics` path is accessible for API tokens with Administration resource view permissions. The values of the labels are subject to Scoped Access Control.
20+
====
21+
22+
The currently enabled metrics, if any, are shown on the *System Configuration* page of the *Platform Configuration* section of the {product-title} UI. In edit mode, the UI allows you to enable or disable one of the predefined metrics.
23+
24+
The `/v1/config` API allows for configuring metrics with custom metric names and a custom set of labels.
25+
26+
Accepted image vulnerability labels:
27+
28+
* Cluster
29+
* Namespace
30+
* Deployment
31+
* IsPlatformWorkload
32+
* ImageID
33+
* ImageRegistry
34+
* ImageRemote
35+
* ImageTag
36+
* Component
37+
* ComponentVersion
38+
* OperatingSystem
39+
* CVE
40+
* CVSS
41+
* Severity
42+
* SeverityV2
43+
* SeverityV3
44+
* IsFixable
45+
46+
[role="_additional-resources"]
47+
.Additional resources
48+
* xref:modules/rbac-resource-definitions.adoc[Resource definitions]

0 commit comments

Comments
 (0)