feat: add conclusion label to generated metrics (#165)

* feat: add conclusion label to generated metrics * push to GAR * Add aborted job status (#166) * make generate * Remove parentheses * Add more job conclusions * add basic logging for debugging * add run_id, id, name & workflow_name to log * rename metric * Fix tests * Revert "push to GAR" This reverts commit 1f12b1a. --------- Co-authored-by: dsotirakis <[email protected]>
grafana · Nov 19, 2024 · 4c33125 · 4c33125
1 parent f796444
commit 4c33125
Show file tree

Hide file tree

Showing 9 changed files with 154 additions and 62 deletions.
diff --git a/receiver/githubactionsreceiver/documentation.md b/receiver/githubactionsreceiver/documentation.md
@@ -12,7 +12,7 @@ metrics:
     enabled: false
 ```
 
-### workflow_jobs_total
+### workflow.jobs.count
 
 Number of jobs.
 
@@ -26,4 +26,5 @@ Number of jobs.
 | ---- | ----------- | ------ |
 | vcs.repository.name | Repository name | Any Str |
 | ci.github.workflow.job.labels | Job labels. | Any Str |
-| ci.github.workflow.job.status | Job status | Str: ``completed``, ``in_progress``, ``queued``, ``waiting`` |
+| ci.github.workflow.job.status | Job status | Str: ``completed``, ``in_progress``, ``queued``, ``waiting``, ``aborted`` |
+| ci.github.workflow.job.conclusion | Job Conclusion | Str: ``success``, ``failure``, ``cancelled``, ``neutral``, ``null``, ``skipped``, ``timed_out``, ``action_required`` |
diff --git a/receiver/githubactionsreceiver/internal/metadata/generated_config.go b/receiver/githubactionsreceiver/internal/metadata/generated_config.go
diff --git a/receiver/githubactionsreceiver/internal/metadata/generated_config_test.go b/receiver/githubactionsreceiver/internal/metadata/generated_config_test.go
diff --git a/receiver/githubactionsreceiver/internal/metadata/generated_metrics.go b/receiver/githubactionsreceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/githubactionsreceiver/internal/metadata/generated_metrics_test.go b/receiver/githubactionsreceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/githubactionsreceiver/internal/metadata/testdata/config.yaml b/receiver/githubactionsreceiver/internal/metadata/testdata/config.yaml
@@ -1,9 +1,9 @@
 default:
 all_set:
   metrics:
-    workflow_jobs_total:
+    workflow.jobs.count:
       enabled: true
 none_set:
   metrics:
-    workflow_jobs_total:
+    workflow.jobs.count:
       enabled: false
diff --git a/receiver/githubactionsreceiver/metadata.yaml b/receiver/githubactionsreceiver/metadata.yaml
@@ -28,10 +28,23 @@ attributes:
       - in_progress
       - queued
       - waiting
+      - aborted
+    type: string
+  ci.github.workflow.job.conclusion:
+    description: Job Conclusion
+    enum:
+      - success
+      - failure
+      - cancelled
+      - neutral
+      - "null"
+      - skipped
+      - timed_out
+      - action_required
     type: string
 
 metrics:
-  workflow_jobs_total:
+  workflow.jobs.count:
     enabled: true
     description: Number of jobs.
     unit: "{job}"
@@ -44,4 +57,5 @@ metrics:
         vcs.repository.name,
         ci.github.workflow.job.labels,
         ci.github.workflow.job.status,
+        ci.github.workflow.job.conclusion,
       ]