From fadae40f1970dc0094cc35bbe788b509c7dd9151 Mon Sep 17 00:00:00 2001 From: Andrey Novikov Date: Fri, 8 Mar 2024 23:53:33 +0900 Subject: [PATCH] 0.12.0: Optional error class label in failed jobs counter --- CHANGELOG.md | 15 +++++++++++++++ README.md | 11 ++++++----- lib/yabeda/sidekiq/version.rb | 2 +- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d92bb5c..36e7671 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## Unreleased +## 0.12.0 - 2024-03-08 + +### Added + +- Optional capture of error class for failed jobs counter. + + Set `label_for_error_class_on_sidekiq_jobs_failed` to `true` to add `error` label to `sidekiq_jobs_failed_total` metric. + + Pull request [#34](https://github.com/yabeda-rb/yabeda-sidekiq/pull/34) by [@niborg] + +### Changed + +- Stop including development-related files into packaged gem to avoid confusing users or software tools. [@Envek] + ## 0.11.0 - 2024-02-07 ### Added @@ -130,3 +144,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. [@mrexox]: https://github.com/mrexox "Valentine Kiselev" [@LukinEgor]: https://github.com/LukinEgor "Egor Lukin" [@SxDx]: https://github.com/SxDx "René Koller" +[@niborg]: https://github.com/niborg "Nick Knipe" diff --git a/README.md b/README.md index 831990f..16c66d1 100644 --- a/README.md +++ b/README.md @@ -99,11 +99,12 @@ end Configuration is handled by [anyway_config] gem. With it you can load settings from environment variables (upcased and prefixed with `YABEDA_SIDEKIQ_`), YAML files, and other sources. See [anyway_config] docs for details. -Config key | Type | Default | Description | ----------------------------- | -------- | ------------------------------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------| -`collect_cluster_metrics` | boolean | Enabled in Sidekiq worker processes, disabled otherwise | Defines whether this Ruby process should collect and expose metrics representing state of the whole Sidekiq installation (queues, processes, etc). | -`declare_process_metrics` | boolean | Enabled in Sidekiq worker processes, disabled otherwise | Declare metrics that are only tracked inside worker process even outside of them. Useful for multiprocess metric collection. | -`retries_segmented_by_queue` | boolean | Disabled | Defines wheter retries are segemented by queue or reported as a single metric | +| Config key | Type | Default | Description | +|------------------------------------------------|---------|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| `collect_cluster_metrics` | boolean | Enabled in Sidekiq worker processes, disabled otherwise | Defines whether this Ruby process should collect and expose metrics representing state of the whole Sidekiq installation (queues, processes, etc). | +| `declare_process_metrics` | boolean | Enabled in Sidekiq worker processes, disabled otherwise | Declare metrics that are only tracked inside worker process even outside of them. Useful for multiprocess metric collection. | +| `retries_segmented_by_queue` | boolean | Disabled | Defines wheter retries are segemented by queue or reported as a single metric | +| `label_for_error_class_on_sidekiq_jobs_failed` | boolean | Disabled | Defines whether `error` label should be added to `sidekiq_jobs_failed_total` metric. | # Roadmap (TODO or Help wanted) diff --git a/lib/yabeda/sidekiq/version.rb b/lib/yabeda/sidekiq/version.rb index 30e013b..81e3f50 100644 --- a/lib/yabeda/sidekiq/version.rb +++ b/lib/yabeda/sidekiq/version.rb @@ -2,6 +2,6 @@ module Yabeda module Sidekiq - VERSION = "0.11.0" + VERSION = "0.12.0" end end