yabeda-shoryuken 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '053931d7159c46e6add4652c91a6c8e110b731c920250bcd4c709c04140738a3'
+  data.tar.gz: 9dc0365fb7ace0ddf80337291940c733fcafac479458a6dae68070d1ea87b36b
+SHA512:
+  metadata.gz: 42c3fdcdefa9e5b3277d1e844aeed86fdb05b7baf8f0dede1b5f329cadd34e027ab76b5ac005d39dbb0516d031425dd349a66306917ccca34ca09c6d732842af
+  data.tar.gz: bfa06257e30369837d521de20e396bd983e77ef559c1e3c12fa01a4b90280072a6fd10488fb950a6d8ac67609cf21480e9f273e99b1f62fb1fb5da610461cd67

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-shoryuken-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-shoryuken-${{ 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-shoryuken-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-shoryuken-${{ 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-shoryuken-${{ 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-shoryuken-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -0,0 +1,46 @@
+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
+    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/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,52 @@
+---
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - "Gemfile"
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Enabled: 150
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  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

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+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).
+
+## 0.1.1 - 2023-01-30
+
+- Fix Shoryuken::ClientMiddleware implementation. @retsef
+- Add missing test. @retsef
+
+## 0.1.0 - 2023-01-25
+
+- Add basic usage of the gem in README. @retsef
+- Initial release of yabeda-shoryuken gem. @retsef
+
+[@retsef]: https://github.com/retsef "Roberto Scinocca"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at scinocca@extendi.it. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,15 @@
+# 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-cloudwatch.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0'
+
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Roberto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Yabeda::Shoryuken
+
+[![Gem Version](https://badge.fury.io/rb/yabeda-shoryuken.svg)](https://rubygems.org/gems/yabeda-cloudwatch)
+
+Yabeda plugin for easy [Shoryuken] gem collect metrics from your application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-shoryuken'
+# Then add monitoring system adapter, e.g.:
+# gem 'yabeda-cloudwatch'
+```
+
+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!** Shoryuken metrics are being collected!
+
+## Metrics
+
+### Local per-process metrics
+
+Metrics representing state of current Shoryuken worker process and stats of executed or executing jobs:
+
+- Total number of executed jobs: `shoryuken_jobs_executed_total` -  (segmented by queue and class name)
+- Number of jobs have been finished successfully: `shoryuken_jobs_success_total` (segmented by queue and class name)
+- Number of jobs have been failed: `shoryuken_jobs_failed_total` (segmented by queue and class name)
+- Time of job run: `shoryuken_job_runtime` (seconds per job execution, segmented by queue and class name)
+- Maximum runtime of currently executing jobs: `shoryuken_running_job_runtime` (useful for detection of hung jobs, segmented by queue and class name)
+
+### Client metrics
+
+Metrics collected where jobs are being pushed to queues (everywhere):
+
+- Total number of enqueued messages: `shoryuken_messages_enqueued_total_count` (segmented by `queue` and `worker` class name)
+
+## 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 Shoryuken::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 Shoryuken worker processes, disabled otherwise | Defines whether this Ruby process should collect and expose metrics representing state of the whole Shoryuken installation (queues, processes, etc). |
+`declare_process_metrics` | boolean  | Enabled in Shoryuken worker processes, disabled otherwise | Declare metrics that are only tracked inside worker process even outside of them. Useful for multiprocess metric collection.                       |
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-shoryuken.
+
+### Releasing
+
+1. Bump version number in `lib/yabeda/shoryuken/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::Shoryuken::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/shoryuken/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/shoryuken/version.rb -e "puts Gem::Version.new(Yabeda::Shoryuken::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).
+
+[Shoryuken]: https://github.com/ruby-shoryuken/shoryuken "A super efficient Amazon SQS thread based message processor 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

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yabeda/shoryuken'
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/lib/yabeda/shoryuken/client_middleware.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Shoryuken
+    # Client middleware to count number of enqueued jobs
+    class ClientMiddleware
+
+      def call(options = {})
+        queue_url = options[:queue_url]
+
+        Yabeda.shoryuken_messages_enqueued_total.increment({ queue: queue_url })
+
+        yield
+      end
+    end
+  end
+end

data/lib/yabeda/shoryuken/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'anyway'
+
+module Yabeda
+  module Shoryuken
+    # Yabeda Shoryuken config
+    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: ::Shoryuken.server?
+
+      # Declare metrics that are only tracked inside worker process even outside them
+      attr_config declare_process_metrics: ::Shoryuken.server?
+    end
+  end
+end

data/lib/yabeda/shoryuken/server_middleware.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Shoryuken
+    # Shoryuken worker middleware
+    class ServerMiddleware
+      # rubocop: disable Metrics/AbcSize, :
+      def call(worker, queue, sqs_msg, body)
+        jid = SecureRandom.uuid
+
+        custom_tags = Yabeda::Shoryuken.custom_tags(worker, sqs_msg).to_h
+        labels = Yabeda::Shoryuken.labelize(worker.class, sqs_msg, queue, body).merge(custom_tags)
+        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        begin
+          Yabeda::Shoryuken.jobs_started_at[labels][jid] = start
+          Yabeda.with_tags(**custom_tags) do
+            yield
+          end
+
+          Yabeda.shoryuken_jobs_success_total.increment(labels)
+        rescue Exception # rubocop: disable Lint/RescueException
+          Yabeda.shoryuken_jobs_failed_total.increment(labels)
+          raise
+        ensure
+          Yabeda.shoryuken_job_runtime.measure(labels, elapsed(start))
+          Yabeda.shoryuken_jobs_executed_total.increment(labels)
+          Yabeda::Shoryuken.jobs_started_at[labels].delete(jid)
+        end
+      end
+      # rubocop: enable Metrics/AbcSize:
+
+      private
+
+      def elapsed(start)
+        (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).round(3)
+      end
+    end
+  end
+end

data/lib/yabeda/shoryuken/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Shoryuken
+    VERSION = '0.1.1'
+  end
+end

data/lib/yabeda/shoryuken.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'shoryuken'
+
+require 'yabeda'
+require 'yabeda/shoryuken/version'
+require 'yabeda/shoryuken/client_middleware'
+require 'yabeda/shoryuken/server_middleware'
+require 'yabeda/shoryuken/config'
+
+module Yabeda
+  # Yabeda Shoryuken integration
+  module Shoryuken
+    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
+    ].freeze
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    Yabeda.configure do
+      config = ::Yabeda::Shoryuken.config
+
+      group :shoryuken
+
+      counter :messages_enqueued_total, tags: %i[queue],
+                                        comment: 'A counter of the total number of message shoryuken enqueued.'
+
+      if config.declare_process_metrics # defaults to +::Shoryuken.server?+
+        counter   :jobs_executed_total,  tags: %i[queue worker],
+                                         comment: 'A counter of the total number of jobs shoryuken executed.'
+        counter   :jobs_success_total,   tags: %i[queue worker],
+                                         comment: 'A counter of the total number of jobs successfully processed by shoryuken.'
+        counter   :jobs_failed_total,    tags: %i[queue worker],
+                                         comment: 'A counter of the total number of jobs failed in shoryuken.'
+
+        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_runtime, comment: 'A histogram of the job execution time.',
+                                unit: :seconds, per: :job,
+                                tags: %i[queue worker],
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+      end
+
+      collect do
+        Yabeda::Shoryuken.track_max_job_runtime if ::Shoryuken.server?
+      end
+    end
+
+    ::Shoryuken.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add ServerMiddleware
+      end
+      config.client_middleware do |chain|
+        chain.add ClientMiddleware
+      end
+    end
+
+    ::Shoryuken.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add ClientMiddleware
+      end
+    end
+
+    class << self
+      def labelize(worker_class, sqs_msg, queue, body = nil)
+        { queue: queue, worker: worker_name(worker_class, sqs_msg, body) }
+      end
+
+      def worker_name(worker_class, sqs_msg, body = nil)
+        if ::Shoryuken.active_job? \
+          && !sqs_msg.is_a?(Array) \
+          && sqs_msg.message_attributes \
+          && sqs_msg.message_attributes['shoryuken_class'] \
+          && sqs_msg.message_attributes['shoryuken_class'][:string_value] \
+          == ActiveJob::QueueAdapters::ShoryukenAdapter::JobWrapper.to_s \
+          && body
+
+          "ActiveJob/#{body['job_class']}"
+        else
+          worker_class.to_s
+        end
+      end
+
+      def custom_tags(worker, sqs_msg)
+        return {} unless worker.respond_to?(:yabeda_tags)
+
+        worker.method(:yabeda_tags).arity.zero? ? worker.yabeda_tags : worker.yabeda_tags(*sqs_msg.attributes)
+      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::Shoryuken.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.shoryuken.running_job_runtime.set(labels, oldest_job_duration)
+        end
+      end
+    end
+
+    self.jobs_started_at = Concurrent::Map.new { |hash, key| hash[key] = Concurrent::Map.new }
+  end
+end

data/sig/yabeda/shoryuken.rbs

@@ -0,0 +1,6 @@
+module Yabeda
+  module Shoryuken
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/yabeda-shoryuken.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/yabeda/shoryuken/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'yabeda-shoryuken'
+  spec.version = Yabeda::Shoryuken::VERSION
+  spec.authors = ['Roberto Scinocca']
+  spec.email = ['roberto.scinocca@hey.com']
+
+  spec.summary       = 'Yabeda extension for Shoryuken'
+  spec.homepage      = 'https://github.com/retsef/yabeda-shoryuken'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/retsef/yabeda-shoryuken'
+  spec.metadata['changelog_uri'] = 'https://github.com/retsef/yabeda-shoryuken/blob/master/CHANGELOG.md'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_dependency 'anyway_config', '>= 1.3', '< 3'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'shoryuken'
+  spec.add_dependency 'yabeda', '~> 0.10'
+
+  spec.add_development_dependency 'aws-sdk-sqs', '>= 0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-shoryuken
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Roberto Scinocca
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoryuken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- roberto.scinocca@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/shoryuken.rb
+- lib/yabeda/shoryuken/client_middleware.rb
+- lib/yabeda/shoryuken/config.rb
+- lib/yabeda/shoryuken/server_middleware.rb
+- lib/yabeda/shoryuken/version.rb
+- sig/yabeda/shoryuken.rbs
+- yabeda-shoryuken.gemspec
+homepage: https://github.com/retsef/yabeda-shoryuken
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/retsef/yabeda-shoryuken
+  source_code_uri: https://github.com/retsef/yabeda-shoryuken
+  changelog_uri: https://github.com/retsef/yabeda-shoryuken/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Yabeda extension for Shoryuken
+test_files: []