diff --git a/README.md b/README.md index 4acac9e..50d6faa 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,21 @@ The `promgithub` service is a lightweight service designed to receive and proces The `promgithub` service exports the following Prometheus metrics: -| Name | Type | Labels | Description | -|------------------------------------|-----------|------------------------------------------------------------------------------------------------|-------------------------------------------| -| `promgithub_workflow_status` | Counter | `repository`, `branch`, `workflow_name`, `workflow_status`, `conclusion` | Total number of workflow runs with status | -| `promgithub_workflow_duration` | Histogram | `repository`, `branch`, `workflow_name`, `workflow_status`, `conclusion` | Duration of workflow runs | -| `promgithub_workflow_queued` | Gauge | `repository`, `branch`, `workflow_name` | Number of workflow runs queued | -| `promgithub_workflow_in_progress` | Gauge | `repository`, `branch`, `workflow_name` | Number of workflow runs in progress | -| `promgithub_workflow_completed` | Gauge | `repository`, `branch`, `workflow_conclusion`,`workflow_name` | Number of workflow runs completed | -| `promgithub_job_status` | Counter | `runner`, `repository`, `branch`, `workflow_name`, `job_name`, `job_status`, `job_conclusion`, | Total number of jobs with status | -| `promgithub_job_duration` | Histogram | `runner`, `repository`, `branch`, `workflow_name`, `job_name`, `job_status`, `job_conclusion` | Duration of jobs runs in seconds | -| `promgithub_job_queued` | Gauge | `runner`, `repository`, `branch`, `workflow_name`, `job_name` | Number of jobs queued | -| `promgithub_job_in_progress` | Gauge | `runner`, `repository`, `branch`, `workflow_name`, `job_name` | Number of jobs in progress | -| `promgithub_job_completed` | Gauge | `runner`, `repository`, `branch`, `job_conclusion`, `workflow_name`, `job_name` | Number of jobs completed | -| `promgithub_commit_pushed` | Counter | `repository`, `branch`, `commit_author`, `commit_author_email` | Total number of commits pushed | -| `promgithub_pull_request` | Counter | `repository`, `base_branch`, `pull_request_author`, `pull_request_status` | Total number of pull requests | +| Name | Type | Labels | Description | +|------------------------------------|-----------|---------------------------------------------------------------|-------------------------------------------| +| `promgithub_workflow_status` | Counter | `repository`, `branch`, `workflow_name`, `workflow_status`, `conclusion`| Total number of workflow runs with status | +| `promgithub_workflow_duration` | Histogram | `repository`, `branch`, `workflow_name`, `workflow_status`, `conclusion`| Duration of workflow runs | +| `promgithub_workflow_queued` | Gauge | `repository`, `branch`, `workflow_name` | Number of workflow runs queued | +| `promgithub_workflow_in_progress` | Gauge | `repository`, `branch`, `workflow_name` | Number of workflow runs in progress | +| `promgithub_workflow_completed` | Gauge | `repository`, `branch`, `workflow_conclusion`,`workflow_name` | Number of workflow runs completed | +| `promgithub_job_status` | Counter | `repository`, `branch`, `workflow_name`, `job_status`, `job_conclusion` | Total number of jobs with status | +| `promgithub_job_duration` | Histogram | `repository`, `branch`, `workflow_name`, `job_status`, `job_conclusion` | Duration of jobs runs in seconds | +| `promgithub_job_queued` | Gauge | `repository`, `branch`, `workflow_name` | Number of jobs queued | +| `promgithub_job_in_progress` | Gauge | `repository`, `branch`, `workflow_name` | Number of jobs in progress | +| `promgithub_job_completed` | Gauge | `repository`, `branch`, `job_conclusion`, `workflow_name` | Number of jobs completed | +| `promgithub_commit_pushed` | Counter | `repository` | Total number of commits pushed | +| `promgithub_pull_request` | Counter | `repository`, `base_branch`, `pull_request_status` | Total number of pull requests | + ## Using `promgithub` service @@ -27,4 +28,4 @@ For usage information see [Usage documentation](./docs/usage.md) ## Contributing to `promgithub` service -For contributing guidelines see [Contributing documentation](./docs/contributing.md) \ No newline at end of file +For contributing guidelines see [Contributing documentation](./docs/contributing.md) diff --git a/docs/usage.md b/docs/usage.md index e791042..8c158fe 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -123,7 +123,7 @@ PROMGITHUB_WEBHOOK_SECRET="" PROMGITHUB_SERVICE_PORT="