Skip to content

Commit

Permalink
Updating docs (#669)
Browse files Browse the repository at this point in the history
  • Loading branch information
Waschndolos authored May 22, 2024
1 parent d7d9acf commit e5e758d
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 32 deletions.
Binary file added docs/assets/metrics_per_build.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/prometheus_configuration_namespace.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 49 additions & 32 deletions docs/metrics/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Metrics collected by [prometheus-plugin](../../README.md)

Metrics collected by this Plugin are prefixed with "default_jenkins".
You can change the "default" prefix either via configuration page:
You can change the "default" prefix either via configuration page (Default Namespace):

"default" -> default namespace
![prometheus_configuration_namespace.png](../assets/prometheus_configuration_namespace.png)

or an environment variable ```PROMETHEUS_NAMESPACE```.
If the environment variable is defined this value will be taken.
Expand Down Expand Up @@ -43,33 +43,50 @@ Required Plugin:

## JobCollector

Note: Metrics in the table below containing <buildname><build_no:last> need to be enabled via Jenkins
Configuration
page. Per Build Metrics. The default Metrics
will just return the last build. You can enable per build metrics in the configuration page (Attention: Performance)

| metric | description | Prometheus Type |
|-----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| default_jenkins_builds_duration_milliseconds_summary | Summary of Jenkins build times in milliseconds by Job | summary |
| default_jenkins_builds_success_build_count | Successful build count | counter |
| default_jenkins_builds_failed_build_count | Failed build count | counter |
| default_jenkins_builds_unstable_build_count | Unstable build count | counter |
| default_jenkins_builds_total_build_count | Total build count (excluding not_built statuses) | counter |
| default_jenkins_builds_aborted_build_count | Aborted build count | counter |
| default_jenkins_builds_health_score | Health score of a job | gauge |
| default_jenkins_builds_<buildname>_last_build_result_ordinal | Build status of a job (0=SUCCESS,1=UNSTABLE,2=FAILURE,3=NOT_BUILT,4=ABORTED) | gauge |
| default_jenkins_builds_<buildname>_last_build_result | Build status of a job as a boolean value (1 or 0). <br/>Where 1 stands for the build status SUCCESS or UNSTABLE and 0 for the build states FAILURE,NOT_BUILT or ABORTED | gauge |
| default_jenkins_builds_<buildname>_last_build_duration_milliseconds | Build times in milliseconds of last build | gauge |
| default_jenkins_builds_<buildname>_last_build_start_time_milliseconds | Last build start timestamp in milliseconds | gauge |
| default_jenkins_builds_<buildname>_last_build_tests_total | Number of total tests during the last build | gauge |
| default_jenkins_builds_<buildname>_last_last_build_tests_skipped | Number of skipped tests during the last build | gauge |
| default_jenkins_builds_<buildname>_last_build_tests_failing | Number of failing tests during the last build | gauge |
| default_jenkins_builds_<buildname>_last_stage_duration_milliseconds_summary | Summary of Jenkins build times by Job and Stage in the last build | summary |
| default_jenkins_builds_available_builds_count | Gauge which indicates how many builds are available for the given job | gauge |
| default_jenkins_builds_discard_active | Gauge which indicates if the build discard feature is active for the job. | gauge |
| default_jenkins_builds_running_build_duration_milliseconds | Gauge which indicates the runtime of the current build. | gauge |
| default_jenkins_builds_<buildname>_last_logfile_size_bytes | Gauge which shows the log file size in bytes. | gauge |




The JobCollector provides metrics about the Job and build specific metrics.

| metric | description | Prometheus Type |
|------------------------------------------------------------|---------------------------------------------------------------------------|-----------------|
| default_jenkins_builds_duration_milliseconds_summary | Summary of Jenkins build times in milliseconds by Job | summary |
| default_jenkins_builds_success_build_count | Successful build count | counter |
| default_jenkins_builds_failed_build_count | Failed build count | counter |
| default_jenkins_builds_unstable_build_count | Unstable build count | counter |
| default_jenkins_builds_total_build_count | Total build count (excluding not_built statuses) | counter |
| default_jenkins_builds_aborted_build_count | Aborted build count | counter |
| default_jenkins_builds_health_score | Health score of a job | gauge |
| default_jenkins_builds_available_builds_count | Gauge which indicates how many builds are available for the given job | gauge |
| default_jenkins_builds_discard_active | Gauge which indicates if the build discard feature is active for the job. | gauge |
| default_jenkins_builds_running_build_duration_milliseconds | Gauge which indicates the runtime of the current build. | gauge |

There are additional build specific metrics returning stats for the last build of a job if you don't enable build
specific metrics over the configuration page:

| metric | description | Prometheus Type |
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| default_jenkins_builds_last_build_result_ordinal | Build status of a job (last build) (0=SUCCESS,1=UNSTABLE,2=FAILURE,3=NOT_BUILT,4=ABORTED) | gauge |
| default_jenkins_builds_last_build_result | Build status of a job as a boolean value (1 or 0). <br/>Where 1 stands for the build status SUCCESS or UNSTABLE and 0 for the build states FAILURE,NOT_BUILT or ABORTED | gauge |
| default_jenkins_builds_last_build_duration_milliseconds | Build times in milliseconds of last build | gauge |
| default_jenkins_builds_last_build_start_time_milliseconds | Last build start timestamp in milliseconds | gauge |
| default_jenkins_builds_last_build_tests_total | Number of total tests during the last build | gauge |
| default_jenkins_builds_last_last_build_tests_skipped | Number of skipped tests during the last build | gauge |
| default_jenkins_builds_last_build_tests_failing | Number of failing tests during the last build | gauge |
| default_jenkins_builds_last_stage_duration_milliseconds_summary | Summary of Jenkins build times by Job and Stage in the last build | summary |
| default_jenkins_builds_last_logfile_size_bytes | Gauge which shows the log file size in bytes. | gauge |

If you enable the per build metrics, there will be additional metrics for every build, additionally to the metrics for
the `last_build`. They will be created for every build available in the UI so be careful if you have many jobs with many
builds. The metrics will have a new label called `number` containing the build number of the given build.

![metrics_per_build.png](..%2Fassets%2Fmetrics_per_build.png)

| metric | description | Prometheus Type |
|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| default_jenkins_builds_build_result_ordinal | Build status of a job (last build) (0=SUCCESS,1=UNSTABLE,2=FAILURE,3=NOT_BUILT,4=ABORTED) | gauge |
| default_jenkins_builds_build_result | Build status of a job as a boolean value (1 or 0). <br/>Where 1 stands for the build status SUCCESS or UNSTABLE and 0 for the build states FAILURE,NOT_BUILT or ABORTED | gauge |
| default_jenkins_builds_build_duration_milliseconds | Build times in milliseconds of last build | gauge |
| default_jenkins_builds_build_start_time_milliseconds | Last build start timestamp in milliseconds | gauge |
| default_jenkins_builds_build_tests_total | Number of total tests during the last build | gauge |
| default_jenkins_builds_build_tests_skipped | Number of skipped tests during the last build | gauge |
| default_jenkins_builds_build_tests_failing | Number of failing tests during the last build | gauge |
| default_jenkins_builds_stage_duration_milliseconds_summary | Summary of Jenkins build times by Job and Stage in the last build | summary |
| default_jenkins_builds_logfile_size_bytes | Gauge which shows the log file size in bytes. | gauge |

0 comments on commit e5e758d

Please sign in to comment.