yabeda-sidekiq 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8acaec8b59c1c088c6c924d5bbc777b1c87c346b56389045e4609b3920af11
-  data.tar.gz: 26e87dbce002e1053eb6f5c709a78642b002691cad1f69e7d1d02722dd692790
+  metadata.gz: 3a429f27fdff4c0295a99045e54af89fac47d0ed6bcae3e13988c1c1b811e8b0
+  data.tar.gz: 6508f78bfc9d19697b688fef975c82de7be3177ee05df1aceea9befc0e271b6f
 SHA512:
-  metadata.gz: 880a85b150e20c3b78a330d7fa9a2ae578d7fba140adaf9d01e8fdae467c57f746607efa601404b9b9f20d8bbf0fb98b560177ef198095fa48176f79ccc5ce10
-  data.tar.gz: 720157c2e892d40ddd776e186055403d79162a8554c36a080003678f1f73d69a9cf924c5ef17bab42235b309506ef620eca80c6311e9af90f83b5c9460585d5a
+  metadata.gz: 127a4ffc2ad85ac7f472dc4de218df07be1612b05c145ceb8edc14c14cbb31390e45c1608a676c03bcfa927fe2a1398f7d2855731ee4d42a547388e8f45d975c
+  data.tar.gz: 362af4e3b0058f6d8453a0f8fc19ee81ce2963f285a5a82aafbfc4e7f09ae5a73ce5b73ccdfe044b60c83c31a9ce5a9408b9a07852d57c0dd5e51cb671abd642

data/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"

data/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)
 

data/lib/yabeda/sidekiq/config.rb

@@ -20,6 +20,9 @@ module Yabeda
       # Retries are tracked by default as a single metric. If you want to track them separately for each queue, set this to +true+
       # Disabled by default because it is quite slow if the retry set is large
       attr_config retries_segmented_by_queue: false
+
+      # If set to true, an `:error` label will be added with name of the error class to all failed jobs
+      attr_config label_for_error_class_on_sidekiq_jobs_failed: false
     end
   end
 end

data/lib/yabeda/sidekiq/server_middleware.rb

@@ -20,8 +20,10 @@ module Yabeda
             yield
           end
           Yabeda.sidekiq_jobs_success_total.increment(labels)
-        rescue Exception # rubocop: disable Lint/RescueException
-          Yabeda.sidekiq_jobs_failed_total.increment(labels)
+        rescue Exception => e # rubocop: disable Lint/RescueException
+          jobs_failed_labels = labels.dup
+          jobs_failed_labels[:error] = e.class.name if Yabeda::Sidekiq.config.label_for_error_class_on_sidekiq_jobs_failed
+          Yabeda.sidekiq_jobs_failed_total.increment(jobs_failed_labels)
           raise
         ensure
           Yabeda.sidekiq_job_runtime.measure(labels, elapsed(start))

data/lib/yabeda/sidekiq/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Sidekiq
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end
 end

data/lib/yabeda/sidekiq.rb

@@ -29,9 +29,11 @@ module Yabeda
       counter :jobs_rerouted_total, tags: %i[from_queue to_queue worker], comment: "A counter of the total number of rerouted jobs sidekiq enqueued."
 
       if config.declare_process_metrics # defaults to +::Sidekiq.server?+
+        failed_total_tags = config.label_for_error_class_on_sidekiq_jobs_failed ? %i[queue worker error] : %i[queue worker]
+
         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."
+        counter   :jobs_failed_total,    tags: failed_total_tags, 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)"

data/yabeda-sidekiq.gemspec

@@ -15,8 +15,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/yabeda-rb/yabeda-sidekiq"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(\.|bin/|spec/|tmp/|Gemfile|Rakefile|yabeda-sidekiq-logo\.png)})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -122,30 +122,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/lint.yml"
-- ".github/workflows/release.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- 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:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/yabeda-rb/yabeda-sidekiq
+  source_code_uri: https://github.com/yabeda-rb/yabeda-sidekiq
+  changelog_uri: https://github.com/yabeda-rb/yabeda-sidekiq/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/yabeda-rb/yabeda-sidekiq/issues
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.github/workflows/lint.yml

@@ -1,25 +0,0 @@
-name: Lint
-
-on:
-  pull_request:
-  push:
-    branches:
-      - '**'
-    tags-ignore:
-      - 'v*'
-
-jobs:
-  rubocop:
-    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
-    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
-    name: RuboCop
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-      - name: Lint Ruby code with RuboCop
-        run: |
-          bundle exec rubocop

data/.github/workflows/release.yml

@@ -1,86 +0,0 @@
-name: Build and release gem
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-      packages: write
-    steps:
-      - uses: actions/checkout@v4
-        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: "3.3"
-      - 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: Configure RubyGems Credentials
-        uses: rubygems/configure-rubygems-credentials@main
-      - name: Publish to RubyGems
-        run: |
-          gem push yabeda-sidekiq-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -1,43 +0,0 @@
-name: Tests
-
-on:
-  pull_request:
-  push:
-    branches:
-      - '**'
-    tags-ignore:
-      - 'v*'
-
-jobs:
-  test:
-    name: 'Ruby ${{ matrix.ruby }} × Sidekiq v${{ matrix.sidekiq }} × ActiveJob v${{ matrix.activejob }}'
-    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
-    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - ruby: '3.3'
-            sidekiq: '7'
-            activejob: '7.1'
-          - ruby: '3.2'
-            sidekiq: '7'
-            activejob: '7.0'
-          - ruby: '3.1'
-            sidekiq: '6'
-            activejob: '6.1'
-          - ruby: '3.0'
-            sidekiq: '5'
-            activejob: '6.0'
-    env:
-      SIDEKIQ_VERSION: '${{ matrix.sidekiq }}'
-      ACTIVEJOB_VERSION: '${{ matrix.activejob }}'
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run RSpec
-        run: bundle exec rspec

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,79 +0,0 @@
----
-require:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.5
-
-Metrics/BlockLength:
-  Enabled: false
-  Exclude:
-  - "Gemfile"
-  - "spec/**/*"
-
-Layout/LineLength:
-  Max: 160
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# Allow to use let!
-RSpec/LetSetup:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Style/TrailingCommaInArguments:
-  Description: 'Checks for trailing comma in argument lists.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
-  Enabled: true
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInArrayLiteral:
-  Description: 'Checks for trailing comma in array literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  Enabled: true
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInHashLiteral:
-  Description: 'Checks for trailing comma in hash literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
-  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
-
-Style/SoleNestedConditional:
-  Enabled: false
-
-Style/ExplicitBlockArgument:
-  Enabled: false
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Max: 200

data/Gemfile

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in yabeda-sidekiq.gemspec
-gemspec
-
-# rubocop:disable Bundler/DuplicatedGem
-sidekiq_version = ENV.fetch("SIDEKIQ_VERSION", "~> 7.2")
-case sidekiq_version
-when "HEAD"
-  gem "sidekiq", git: "https://github.com/sidekiq/sidekiq.git"
-else
-  sidekiq_version = "~> #{sidekiq_version}.0" if sidekiq_version.match?(/^\d+(?:\.\d+)?$/)
-  gem "sidekiq", sidekiq_version
-end
-
-activejob_version = ENV.fetch("ACTIVEJOB_VERSION", "~> 7.1")
-case activejob_version
-when "HEAD"
-  git "https://github.com/rails/rails.git" do
-    gem "activejob"
-    gem "activesupport"
-    gem "rails"
-  end
-else
-  activejob_version = "~> #{activejob_version}.0" if activejob_version.match?(/^\d+\.\d+$/)
-  gem "activejob", activejob_version
-  gem "activesupport", activejob_version
-end
-# rubocop:enable Bundler/DuplicatedGem
-
-group :development, :test do
-  gem "pry"
-  gem "pry-byebug", platform: :mri
-
-  gem "yabeda", github: "yabeda-rb/yabeda", branch: "master" # For RSpec matchers
-  gem "rubocop", "~> 1.0"
-  gem "rubocop-rspec"
-end

data/Rakefile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: %i[rubocop spec]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "yabeda/sidekiq"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here