Skip to content

Commit

Permalink
Remove docs changes and added changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
raz-amir committed Apr 25, 2023
1 parent 13cb725 commit 418d0a8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
10 changes: 10 additions & 0 deletions changelog/unreleased/workflow-run-created-metric.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Enhancement: New metrics and configurations for the workflow collector

1. Added a new metric for the duration, in minutes, of the time since the run was created:
github_workflow_duration_run_created_minutes
2. Added 2 optional configuration options for the workflows exporter:
1. Query workflows with a specific status (Default to any)
2. Set the window history (defaults to 12 hours)
3. Added run_id label

https://github.com/promhippie/github_exporter/pull/200
6 changes: 0 additions & 6 deletions docs/partials/envvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,5 @@ GITHUB_EXPORTER_COLLECTOR_BILLING
GITHUB_EXPORTER_COLLECTOR_WORKFLOWS
: Enable collector for workflows, defaults to `false`

GITHUB_EXPORTER_WORKFLOWS_STATUS
: Query workflows with specific status, defaults to `""` (any status)

GITHUB_EXPORTER_WORKFLOWS_HISTORY_WINDOW
: Duration for querying workflows since the time they were created, defaults to `12h`

GITHUB_EXPORTER_COLLECTOR_RUNNERS
: Enable collector for runners, defaults to `false`
5 changes: 1 addition & 4 deletions docs/partials/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,4 @@ github_workflow_duration_ms{<prometheus.ConstrainedLabel Value>, <prometheus.Con
: Duration of workflow runs

github_workflow_status{<prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>}
: Status of workflow runs

github_workflow_duration_run_created_minutes{<prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>, <prometheus.ConstrainedLabel Value>}
: Duration since the workflow run creation time in minutes
: Status of workflow runs

0 comments on commit 418d0a8

Please sign in to comment.