yabeda-sidekiq 0.5.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cc207100137641a1ba2cd7151f411473a003623f4316f470c9cab2734b0c46
-  data.tar.gz: ab292a2728a35ab4ed163f9d77e4260d33944052fb384c93895fceddcdd63876
+  metadata.gz: 7ca3b88de76f5fc2ebb1e495445d25ad5b5de0c9f053bb8ca9dcbb5940ef4d41
+  data.tar.gz: 7be84caa2d3463a41d59606493e7739377ebfa908476b15b60bb16330067b99b
 SHA512:
-  metadata.gz: 225fdd8793b40a5efc4ae7a476e90e142cf2a1b8b790d395262d76f7a7ad8f73d7f9969f7cfe7dcb87359eee272bfa9ab5dac08b7ff477961814f70daa81f676
-  data.tar.gz: 7673942008c4c0b83d57fa681016f6b4238107f3c355165fa616191a9a6f8d339828830d3e7fff03d9f3d80e67a1f657756459d87aecd0681547ba6060b2fe7e
+  metadata.gz: 1f7fc13c744da0aa66ffabd9882b24a43c60038e4b966cc557412c80687ed92848d508e179221e93b15e610f9021415e8a7494dc7cfade3f851d617f304ef4ee
+  data.tar.gz: e026f095d1ba62dd75da0c29d0069c89223bc3cf357ea912c0d1d137cb9b1e7ae7e5223ee7967c2dcd68dd706212553f2840718f52af05240846e965d0be239d

data/.github/workflows/build-release.yml

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
+          echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
+          # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
+          BODY="${BODY}"$'\n'"${changelog}"
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
+      - name: Build gem
+        run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem
+          asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 3.0
+          - ruby: 2.7
+          - ruby: 2.6
+          - ruby: 2.5
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+            bundle-${{ matrix.ruby }}-
+      - name: Upgrade Bundler to 2.0 (for older Rubies)
+        run: gem install bundler -v '~> 2.0'
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+          bundle update
+      - name: Run Rubocop
+        run: bundle exec rubocop
+      - name: Run RSpec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -1,17 +1,18 @@
 ---
 require:
-- rubocop-rspec
+  - rubocop-rspec
 
 AllCops:
   TargetRubyVersion: 2.3
 
 Metrics/BlockLength:
+  Enabled: false
   Exclude:
   - "Gemfile"
   - "spec/**/*"
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
+Layout/LineLength:
+  Max: 160
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -44,3 +45,23 @@ Style/TrailingCommaInHashLiteral:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 17

data/CHANGELOG.md

@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+## 0.8.1 - 2021-08-24
+
+### Fixed
+
+ - Compatibility with Sidekiq 6.2.2+ due to renamings in Sidekiq's undocumented API that yabeda-sidekiq uses. See [mperham/sidekiq#4971](https://github.com/mperham/sidekiq/discussions/4971). [@Envek]
+
+## 0.8.0 - 2021-05-12
+
+### Added
+
+ - `sidekiq_running_job_runtime` metric that tracks maximum runtime of currently running jobs. It may be useful for detection of hung jobs. See [#17](https://github.com/yabeda-rb/yabeda-sidekiq/pull/17). [@dsalahutdinov], [@Envek]
+
+ - Setting `collect_cluster_metrics` allowing to force enable or disable collection of global (whole Sidekiq installaction-wide) metrics. See [#20](https://github.com/yabeda-rb/yabeda-sidekiq/pull/20). [@mrexox]
+
+    By default all sidekiq worker processes (servers) collects global metrics about whole Sidekiq installation.
+    Client processes (everything else that is not Sidekiq worker) by default doesn't.
+
+    With this config you can override this behavior:
+    - force disable if you don't want multiple Sidekiq workers to report the same numbers (that causes excess load to both Redis and monitoring)
+    - force enable if you want non-Sidekiq process to collect them (like dedicated metric exporter process)
+
+## 0.7.0 - 2020-07-15
+
+### Changed
+
+ - Tags from `yabeda_tags` method are applied to all metrics collected inside a job, not only sidekiq-specific. See [#14](https://github.com/yabeda-rb/yabeda-sidekiq/issues/14). @Envek
+
+## 0.6.0 - 2020-07-15
+
+### Added
+
+ - Ability to override or add tags for every job via `yabeda_tags` method. @Envek
+
 ## 0.5.0 - 2020-02-20
 
 ### Added
@@ -49,5 +84,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
  - Initial release of evil-metrics-sidekiq gem. @Envek
 
+[@Envek]: https://github.com/Envek "Andrey Novikov"
 [@dsalahutdinov]: https://github.com/dsalahutdinov "Salahutdinov Dmitry"
 [@asusikov]: https://github.com/asusikov "Alexander Susikov"
+[@mrexox]: https://github.com/mrexox "Valentine Kiselev"

data/Gemfile

@@ -11,6 +11,6 @@ group :development, :test do
   gem "pry"
   gem "pry-byebug", platform: :mri
 
-  gem "rubocop"
+  gem "rubocop", "~> 0.80.0"
   gem "rubocop-rspec"
 end

data/README.md

@@ -1,4 +1,4 @@
-# Yabeda::[Sidekiq]
+# ![Yabeda::Sidekiq](./yabeda-sidekiq-logo.png)
 
 Built-in metrics for [Sidekiq] monitoring out of the box! Part of the [yabeda] suite.
 
@@ -16,6 +16,14 @@ And then execute:
 
     $ bundle
 
+If you're not on Rails then configure Yabeda after your application was initialized:
+
+```ruby
+Yabeda.configure!
+```
+
+_If you're using Ruby on Rails then Yabeda will configure itself automatically!_
+
 **And that is it!** Sidekiq metrics are being collected!
 
 Additionally, depending on your adapter, you may want to setup metrics export. E.g. for [yabeda-prometheus]:
@@ -29,18 +37,61 @@ end
 
 ## Metrics
 
+### Local per-process metrics
+
+Metrics representing state of current Sidekiq worker process and stats of executed or executing jobs:
+
  - Total number of executed jobs: `sidekiq_jobs_executed_total` -  (segmented by queue and class name)
  - Number of jobs have been finished successfully: `sidekiq_jobs_success_total` (segmented by queue and class name)
  - Number of jobs have been failed: `sidekiq_jobs_failed_total` (segmented by queue and class name)
  - Time of job run: `sidekiq_job_runtime` (seconds per job execution, segmented by queue and class name)
- - Time of the queue latency `sidekiq_queue_latency` (the difference in seconds since the oldest job in the queue was enqueued)
  - Time of the job latency `sidekiq_job_latency` (the difference in seconds since the enqueuing until running job)
+ - Maximum runtime of currently executing jobs: `sidekiq_running_job_runtime` (useful for detection of hung jobs, segmented by queue and class name)
+
+### Global cluster-wide metrics
+
+Metrics representing state of the whole Sidekiq installation (queues, processes, etc):
+
  - Number of jobs in queues: `sidekiq_jobs_waiting_count` (segmented by queue)
+ - Time of the queue latency `sidekiq_queue_latency` (the difference in seconds since the oldest job in the queue was enqueued)
  - Number of scheduled jobs:`sidekiq_jobs_scheduled_count`
  - Number of jobs in retry set: `sidekiq_jobs_retry_count`
  - Number of jobs in dead set (“morgue”): `sidekiq_jobs_dead_count`
- - Active workers count: `sidekiq_active_processes`
- - Active processes count: `sidekiq_active_workers_count`
+ - Active processes count: `sidekiq_active_processes`
+ - Active servers count: `sidekiq_active_workers_count`
+
+By default all sidekiq worker processes (servers) collects global metrics about whole Sidekiq installation. This can be overridden by setting `collect_cluster_metrics` config key to `true` for non-Sidekiq processes or to `false` for Sidekiq processes (e.g. by setting `YABEDA_SIDEKIQ_COLLECT_CLUSTER_METRICS` env variable to `no`, see other methods in [anyway_config] docs).
+
+## Custom tags
+
+You can add additional tags to these metrics by declaring `yabeda_tags` method in your worker.
+
+```ruby
+# This block is optional but some adapters (like Prometheus) requires that all tags should be declared in advance
+Yabeda.configure do
+  default_tag :importance, nil
+end
+
+class MyWorker
+  include Sidekiq::Worker
+
+  def yabeda_tags(*params) # This method will be called first, before +perform+
+    { importance: extract_importance(params) }
+  end
+
+  def perform(*params)
+    # Your logic here
+  end
+end
+```
+
+## Configuration
+
+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). |
 
 # Roadmap (TODO or Help wanted)
 
@@ -60,6 +111,38 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-sidekiq.
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/sidekiq/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::Sidekiq::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/sidekiq/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/sidekiq/version.rb -e "puts Gem::Version.new(Yabeda::Sidekiq::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -67,3 +150,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 [Sidekiq]: https://github.com/mperham/sidekiq/ "Simple, efficient background processing for Ruby"
 [yabeda]: https://github.com/yabeda-rb/yabeda
 [yabeda-prometheus]: https://github.com/yabeda-rb/yabeda-prometheus
+[anyway_config]: https://github.com/palkan/anyway_config "Configuration library for Ruby gems and applications"

data/Rakefile

@@ -2,7 +2,10 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/yabeda/sidekiq/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "anyway"
+
+module Yabeda
+  module Sidekiq
+    class Config < ::Anyway::Config
+      config_name :yabeda_sidekiq
+
+      # By default all sidekiq worker processes (servers) collects global metrics about whole Sidekiq installation.
+      # Client processes (everything else that is not Sidekiq worker) by default doesn't.
+      # With this config you can override this behavior:
+      #  - force disable if you don't want multiple Sidekiq workers to report the same numbers (that causes excess load to both Redis and monitoring)
+      #  - force enable if you want non-Sidekiq process to collect them (like dedicated metric exporter process)
+      attr_config collect_cluster_metrics: ::Sidekiq.server?
+    end
+  end
+end

data/lib/yabeda/sidekiq/server_middleware.rb

@@ -4,13 +4,21 @@ module Yabeda
   module Sidekiq
     # Sidekiq worker middleware
     class ServerMiddleware
+      # See https://github.com/mperham/sidekiq/discussions/4971
+      JOB_RECORD_CLASS = defined?(::Sidekiq::JobRecord) ? ::Sidekiq::JobRecord : ::Sidekiq::Job
+
+      # rubocop: disable Metrics/AbcSize, Metrics/MethodLength:
       def call(worker, job, queue)
-        labels = Yabeda::Sidekiq.labelize(worker, job, queue)
-        start = Time.now
+        custom_tags = Yabeda::Sidekiq.custom_tags(worker, job).to_h
+        labels = Yabeda::Sidekiq.labelize(worker, job, queue).merge(custom_tags)
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         begin
-          job_instance = ::Sidekiq::Job.new(job)
+          job_instance = JOB_RECORD_CLASS.new(job)
           Yabeda.sidekiq_job_latency.measure(labels, job_instance.latency)
-          yield
+          Yabeda::Sidekiq.jobs_started_at[labels][job["jid"]] = start
+          Yabeda.with_tags(**custom_tags) do
+            yield
+          end
           Yabeda.sidekiq_jobs_success_total.increment(labels)
         rescue Exception # rubocop: disable Lint/RescueException
           Yabeda.sidekiq_jobs_failed_total.increment(labels)
@@ -18,13 +26,15 @@ module Yabeda
         ensure
           Yabeda.sidekiq_job_runtime.measure(labels, elapsed(start))
           Yabeda.sidekiq_jobs_executed_total.increment(labels)
+          Yabeda::Sidekiq.jobs_started_at[labels].delete(job["jid"])
         end
       end
+      # rubocop: enable Metrics/AbcSize, Metrics/MethodLength:
 
       private
 
       def elapsed(start)
-        (Time.now - start).round(3)
+        (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).round(3)
       end
     end
   end

data/lib/yabeda/sidekiq/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Sidekiq
-    VERSION = "0.5.0"
+    VERSION = "0.8.1"
   end
 end

data/lib/yabeda/sidekiq.rb

@@ -7,43 +7,57 @@ require "yabeda"
 require "yabeda/sidekiq/version"
 require "yabeda/sidekiq/client_middleware"
 require "yabeda/sidekiq/server_middleware"
+require "yabeda/sidekiq/config"
 
 module Yabeda
   module Sidekiq
     LONG_RUNNING_JOB_RUNTIME_BUCKETS = [
       0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
-      30, 60, 120, 300, 1800, 3600, 21_600 # Sidekiq tasks may be very long-running
+      30, 60, 120, 300, 1800, 3600, 21_600, # Sidekiq tasks may be very long-running
     ].freeze
 
     Yabeda.configure do
+      config = Config.new
+
       group :sidekiq
 
       counter :jobs_enqueued_total, tags: %i[queue worker], comment: "A counter of the total number of jobs sidekiq enqueued."
 
-      next unless ::Sidekiq.server?
-
-      counter   :jobs_executed_total,  tags: %i[queue worker], comment: "A counter of the total number of jobs sidekiq executed."
-      counter   :jobs_success_total,   tags: %i[queue worker], comment: "A counter of the total number of jobs successfully processed by sidekiq."
-      counter   :jobs_failed_total,    tags: %i[queue worker], comment: "A counter of the total number of jobs failed in sidekiq."
-
-      gauge     :jobs_waiting_count,   tags: %i[queue], comment: "The number of jobs waiting to process in sidekiq."
-      gauge     :active_workers_count, tags: [],        comment: "The number of currently running machines with sidekiq workers."
-      gauge     :jobs_scheduled_count, tags: [],        comment: "The number of jobs scheduled for later execution."
-      gauge     :jobs_retry_count,     tags: [],        comment: "The number of failed jobs waiting to be retried"
-      gauge     :jobs_dead_count,      tags: [],        comment: "The number of jobs exceeded their retry count."
-      gauge     :active_processes,     tags: [],        comment: "The number of active Sidekiq worker processes."
-      gauge     :queue_latency,        tags: %i[queue], comment: "The queue latency, the difference in seconds since the oldest job in the queue was enqueued"
-
-      histogram :job_latency, comment: "The job latency, the difference in seconds between enqueued and running time",
-                              unit: :seconds, per: :job,
-                              tags: %i[queue worker],
-                              buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
-      histogram :job_runtime, comment: "A histogram of the job execution time.",
-                              unit: :seconds, per: :job,
-                              tags: %i[queue worker],
-                              buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+      if ::Sidekiq.server?
+        counter   :jobs_executed_total,  tags: %i[queue worker], comment: "A counter of the total number of jobs sidekiq executed."
+        counter   :jobs_success_total,   tags: %i[queue worker], comment: "A counter of the total number of jobs successfully processed by sidekiq."
+        counter   :jobs_failed_total,    tags: %i[queue worker], comment: "A counter of the total number of jobs failed in sidekiq."
+
+        gauge     :running_job_runtime,  tags: %i[queue worker], aggregation: :max, unit: :seconds,
+                                         comment: "How long currently running jobs are running (useful for detection of hung jobs)"
+
+        histogram :job_latency, comment: "The job latency, the difference in seconds between enqueued and running time",
+                                unit: :seconds, per: :job,
+                                tags: %i[queue worker],
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+        histogram :job_runtime, comment: "A histogram of the job execution time.",
+                                unit: :seconds, per: :job,
+                                tags: %i[queue worker],
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+      end
+
+      # Metrics not specific for current Sidekiq process, but representing state of the whole Sidekiq installation (queues, processes, etc)
+      # You can opt-out from collecting these by setting YABEDA_SIDEKIQ_COLLECT_CLUSTER_METRICS to falsy value (+no+ or +false+)
+      if config.collect_cluster_metrics # defaults to +::Sidekiq.server?+
+        gauge     :jobs_waiting_count,   tags: %i[queue], comment: "The number of jobs waiting to process in sidekiq."
+        gauge     :active_workers_count, tags: [],        comment: "The number of currently running machines with sidekiq workers."
+        gauge     :jobs_scheduled_count, tags: [],        comment: "The number of jobs scheduled for later execution."
+        gauge     :jobs_retry_count,     tags: [],        comment: "The number of failed jobs waiting to be retried"
+        gauge     :jobs_dead_count,      tags: [],        comment: "The number of jobs exceeded their retry count."
+        gauge     :active_processes,     tags: [],        comment: "The number of active Sidekiq worker processes."
+        gauge     :queue_latency,        tags: %i[queue], comment: "The queue latency, the difference in seconds since the oldest job in the queue was enqueued"
+      end
 
       collect do
+        Yabeda::Sidekiq.track_max_job_runtime if ::Sidekiq.server?
+
+        next unless config.collect_cluster_metrics
+
         stats = ::Sidekiq::Stats.new
 
         stats.queues.each do |k, v|
@@ -93,10 +107,34 @@ module Yabeda
 
       def worker_class(worker, job)
         if defined?(ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper)
-          return job["wrapped"] if worker.is_a?(ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper)
+          if worker.is_a?(ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper) || worker == ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper
+            return job["wrapped"].to_s
+          end
+        end
+        (worker.is_a?(String) || worker.is_a?(Class) ? worker : worker.class).to_s
+      end
+
+      def custom_tags(worker, job)
+        return {} unless worker.respond_to?(:yabeda_tags)
+
+        worker.method(:yabeda_tags).arity.zero? ? worker.yabeda_tags : worker.yabeda_tags(*job["args"])
+      end
+
+      # Hash of hashes containing all currently running jobs' start timestamps
+      # to calculate maximum durations of currently running not yet completed jobs
+      # { { queue: "default", worker: "SomeJob" } => { "jid1" => 100500, "jid2" => 424242 } }
+      attr_accessor :jobs_started_at
+
+      def track_max_job_runtime
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        ::Yabeda::Sidekiq.jobs_started_at.each do |labels, jobs|
+          oldest_job_started_at = jobs.values.min
+          oldest_job_duration = oldest_job_started_at ? (now - oldest_job_started_at).round(3) : 0
+          Yabeda.sidekiq.running_job_runtime.set(labels, oldest_job_duration)
         end
-        (worker.is_a?(String) ? worker : worker.class).to_s
       end
     end
+
+    self.jobs_started_at = Concurrent::Hash.new { |hash, key| hash[key] = Concurrent::Hash.new }
   end
 end

data/yabeda-sidekiq.gemspec

@@ -22,10 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "yabeda", "~> 0.2"
+  spec.add_dependency "anyway_config", ">= 1.3", "< 3"
   spec.add_dependency "sidekiq"
+  spec.add_dependency "yabeda", "~> 0.6"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activejob", ">= 6.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yabeda
+  name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -38,34 +44,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,10 +122,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -101,8 +136,10 @@ files:
 - bin/setup
 - lib/yabeda/sidekiq.rb
 - lib/yabeda/sidekiq/client_middleware.rb
+- lib/yabeda/sidekiq/config.rb
 - lib/yabeda/sidekiq/server_middleware.rb
 - lib/yabeda/sidekiq/version.rb
+- yabeda-sidekiq-logo.png
 - yabeda-sidekiq.gemspec
 homepage: https://github.com/yabeda-rb/yabeda-sidekiq
 licenses:
@@ -123,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Extensible Prometheus exporter for monitoring your Sidekiq

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1