Skip to content

Commit 516ee51

Browse files
zakiskchmouel
authored andcommitted
docs: Add tags available for every metric in PaC
added tags/keys in documentation availabe for every metric in Pipelines as Code. this helps users to filter out metric based on specific tag. Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>
1 parent accff8e commit 516ee51

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/content/docs/install/metrics.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Metrics
33
weight: 16
4+
BookToC: false
45
---
56

67
# Metrics Overview
@@ -10,12 +11,12 @@ The metrics for pipelines-as-code can be accessed through the `pipelines-as-code
1011
pipelines-as-code supports various exporters, such as Prometheus, Google Stackdriver, and more.
1112
You can configure these exporters by referring to the [observability configuration](../config/config-observability.yaml).
1213

13-
| Name | Type | Description |
14-
|------------------------------------------------------|---------|--------------------------------------------------------------------|
15-
| `pipelines_as_code_git_provider_api_request_count` | Counter | Number of API requests submitted to git providers |
16-
| `pipelines_as_code_pipelinerun_count` | Counter | Number of pipelineruns created by pipelines-as-code |
17-
| `pipelines_as_code_pipelinerun_duration_seconds_sum` | Counter | Number of seconds all pipelineruns have taken in pipelines-as-code |
18-
| `pipelines_as_code_running_pipelineruns_count` | Gauge | Number of running pipelineruns in pipelines-as-code |
14+
| Name | Type | Labels/Tags | Description |
15+
|-------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
16+
| `pipelines_as_code_git_provider_api_request_count` | Counter | `provider`=&lt;git_provider&gt; <br> `event-type`=&lt;event_type&gt; <br> `namespace`=&lt;pipelinerun_namespace&gt; <br> `repository`=&lt;repository_cr_name&gt; | Number of API requests submitted to git providers |
17+
| `pipelines_as_code_pipelinerun_count` | Counter | `provider`=&lt;git_provider&gt; <br> `event-type`=&lt;event_type&gt; <br> `namespace`=&lt;pipelinerun_namespace&gt; <br> `repository`=&lt;repository_cr_name&gt; | Number of pipelineruns created by pipelines-as-code |
18+
| `pipelines_as_code_pipelinerun_duration_seconds_sum` | Counter | `namespace`=&lt;pipelinerun_namespace&gt; <br> `repository`=&lt;repository_cr_name&gt; <br> `status`=&lt;pipelinerun_status&gt; <br> `reason`=&lt;pipelinerun_status_reason&gt; | Number of seconds all pipelineruns have taken in pipelines-as-code |
19+
| `pipelines_as_code_running_pipelineruns_count` | Gauge | `namespace`=&lt;pipelinerun_namespace&gt; <br> `repository`=&lt;repository_cr_name&gt; | Number of running pipelineruns in pipelines-as-code |
1920

2021
**Note:** The metric `pipelines_as_code_git_provider_api_request_count`
2122
is emitted by both the Controller and the Watcher, since both services

0 commit comments

Comments
 (0)