sidekiq-prometheus-exporter 0.2.0 → 0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-prometheus-exporter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergey Fedorov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,174 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !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'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: All the basic metrics prepared for Prometheus
 email:
 - oni.strech@gmail.com
@@ -213,8 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -225,43 +55,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docker/Dockerfile
-- docker/README.md
-- docker/config.ru
-- examples/docker-compose.yml
-- examples/metrics/Dockerfile
-- examples/metrics/config.ru
-- examples/prometheus/prometheus.yml
-- examples/screenshot.png
-- examples/sidekiq-dashboard.grafana-6.json
-- examples/sidekiq-dashboard.grafana-7.json
-- examples/sidekiq/Dockerfile
-- examples/sidekiq/sidekiq.rb
-- examples/sidekiq/sidekiq.yml
-- gemfiles/sidekiq_4.1.0.Gemfile
-- gemfiles/sidekiq_4.1.0.Gemfile.lock
-- gemfiles/sidekiq_4.x.Gemfile
-- gemfiles/sidekiq_4.x.Gemfile.lock
-- gemfiles/sidekiq_5.x.Gemfile
-- gemfiles/sidekiq_5.x.Gemfile.lock
-- gemfiles/sidekiq_6.x.Gemfile
-- gemfiles/sidekiq_6.x.Gemfile.lock
-- gemfiles/sidekiq_7.x.Gemfile
-- gemfiles/sidekiq_7.x.Gemfile.lock
-- gemfiles/sidekiq_latest.Gemfile
-- gemfiles/sidekiq_latest.Gemfile.lock
-- helm/sidekiq-prometheus-exporter/.helmignore
-- helm/sidekiq-prometheus-exporter/Chart.yaml
-- helm/sidekiq-prometheus-exporter/README.md
-- helm/sidekiq-prometheus-exporter/templates/NOTES.txt
-- helm/sidekiq-prometheus-exporter/templates/_helpers.tpl
-- helm/sidekiq-prometheus-exporter/templates/clusterrole.yaml
-- helm/sidekiq-prometheus-exporter/templates/clusterrolebinding.yaml
-- helm/sidekiq-prometheus-exporter/templates/deployment.yaml
-- helm/sidekiq-prometheus-exporter/templates/service.yaml
-- helm/sidekiq-prometheus-exporter/templates/serviceaccount.yaml
-- helm/sidekiq-prometheus-exporter/templates/servicemonitor.yaml
-- helm/sidekiq-prometheus-exporter/values.yaml
 - lib/sidekiq/prometheus/exporter.rb
 - lib/sidekiq/prometheus/exporter/cron.rb
 - lib/sidekiq/prometheus/exporter/exporters.rb
@@ -285,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Prometheus exporter for the Sidekiq

data/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: [Strech]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: strech
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: ['https://paypal.me/onistrech/eur5.0']

data/.github/workflows/ci.yaml

@@ -1,70 +0,0 @@
----
-name: CI
-on:
-  push:
-    branches: ["master"]
-  pull_request:
-    branches: ["master"]
-  schedule:
-    # Run the workflow once per month
-    - cron: "0 0 1 * *"
-jobs:
-  rubocop:
-    name: Rubocop
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7.8
-      - name: rubocop
-        uses: reviewdog/action-rubocop@v2
-        with:
-          rubocop_version: gemfile
-          rubocop_extensions: rubocop-rake:gemfile rubocop-rspec:gemfile rubocop-performance:gemfile
-          reporter: github-pr-review
-          fail_on_error: true
-
-  test:
-    needs: rubocop
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }} / Sidekiq ${{ matrix.sidekiq }}
-    strategy:
-      matrix:
-        # Always keep a window of "5 most recent" including (or on top with) HEAD
-        ruby: ["2.7.8", "3.0.6", "3.1.4", "3.2.2", "latest"]
-        sidekiq: ["4.1.0", "4.x", "5.x", "6.x", "7.x", "latest"]
-        # Allow failures ... kind-a
-        exclude:
-          - ruby: "2.7.8"
-            sidekiq: "latest"
-          - ruby: "3.0.6"
-            sidekiq: "latest"
-          - ruby: "3.1.4"
-            sidekiq: "latest"
-          - ruby: "3.2.2"
-            sidekiq: "latest"
-
-    container:
-      image: ruby:${{ matrix.ruby }}
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/cache@v2
-        id: vendor-cache
-        with:
-          path: vendor
-          key: bundle-${{ matrix.ruby }}-sidekiq-${{ matrix.sidekiq }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/.*Gemfile.lock') }}
-
-      - name: Upgrade Bundler to 2.x (for older Ruby versions)
-        run: gem install bundler -v '~> 2.1'
-
-      - name: Bundle install
-        run: |
-          bundle config path vendor/bundle
-          bundle config gemfile gemfiles/sidekiq_${{ matrix.sidekiq }}.Gemfile
-          bundle install
-
-      - name: Run RSpec
-        run: bundle exec rake spec

data/docker/Dockerfile

@@ -1,24 +0,0 @@
-FROM ruby:2.7.7-alpine3.16
-
-LABEL maintainer="Sergey Fedorov <oni.strech@gmail.com>"
-LABEL repository="strech/sidekiq-prometheus-exporter"
-
-ENV RACK_VERSION 2.2.4
-ENV SIDEKIQ_VERSION 6.5.7
-ENV REDIS_NAMESPACE_VERSION 1.9
-ENV SIDEKIQ_PROMETHEUS_EXPORTER_VERSION 0.1.17
-
-RUN    addgroup -S exporter \
-    && adduser -s /bin/false -SDHg exporter exporter \
-    && gem install "rack:$RACK_VERSION" \
-    && gem install "sidekiq:$SIDEKIQ_VERSION" \
-    && gem install "redis-namespace:$REDIS_NAMESPACE_VERSION" \
-    && gem install "sidekiq-prometheus-exporter:$SIDEKIQ_PROMETHEUS_EXPORTER_VERSION"
-
-USER exporter
-WORKDIR /app
-COPY config.ru config.ru
-
-EXPOSE 9292
-ENTRYPOINT [ "rackup" ]
-CMD [ "-p", "9292", "-o", "0.0.0.0", "config.ru" ]

data/docker/README.md

@@ -1,61 +0,0 @@
-# Official Docker image
-
-[0]: https://github.com/Strech/sidekiq-prometheus-exporter
-[1]: https://www.iana.org/assignments/uri-schemes/prov/redis
-[2]: https://github.com/resque/redis-namespace
-[3]: https://github.com/redis/redis-rb/tree/v4.1.3#sentinel-support
-[4]: https://github.com/mperham/sidekiq/issues/4479
-
-This is an official Docker image for [sidekiq-prometheus-exporter][0]
-gem.
-
-It combines some approaches which were already published as images by other
-devs and at the same time brings more flexibility for the stock configuration
-and applies recommended Docker best practices.
-
-:warning: The Docker image currently supports **only** standards metrics.
-
-## Supported ENVs
-
-Required
-
-- `REDIS_URL` - [RFC 3986 generic URI][1], exclusive with `REDIS_HOST`
-- `REDIS_HOST` - a Redis host, exclusive with `REDIS_URL` (default: `localhost`)
-
-Optional
-
-- `REDIS_SSL` - a flag to enable Redis SSL URL scheme (default: `false`)
-- `REDIS_PORT` - a Redis port (default: `6379`)
-- `REDIS_PASSWORD` - a Redis password (if you need one)
-- `REDIS_DB_NUMBER` - a Redis database number (default: `0`)
-- `REDIS_NAMESPACE` - a Redis [namespace][2] name (if you have separated sidekiq)
-- `REDIS_SENTINELS` - a list of comma separated Redis urls (like `REDIS_URL`, but for sentinels)
-- `REDIS_SENTINEL_ROLE` - a role within the [sentinel][3] to connect (default: `master`)
-- `REDIS_DISABLE_CLIENT_ID` - a flag to disable `CLIENT` command in [Sidekiq][4]
-
-:bulb: Note, that `REDIS_URL` and `REDIS_HOST` are exclusive. Since `REDIS_HOST` is more
-atomic value it will be checked after `REDIS_URL`.
-
-:bulb: `REDIS_SENTINELS` will be parsed with `URI`, because of that it's
-mandatory for them to be formatted with protocol `redis://...`.
-
-:bulb: `REDIS_DISABLE_CLIENT_ID` might be required if a SaaS Redis provider is being used.
-
-## Examples
-
-If you don't have a running Redis instance, you can quickly spin an empty to
-practice.
-
-```bash
-$ docker run -d --rm --name redis-instance redis
-```
-
-and then run an exporter
-
-```bash
-$ docker run -it --rm \
-             --link redis-instance \
-             -p 9292:9292 \
-             -e REDIS_URL=redis://redis-instance \
-             strech/sidekiq-prometheus-exporter
-```

data/docker/config.ru

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'sidekiq'
-require 'sidekiq/prometheus/exporter'
-
-config = {}
-config[:url] = ENV['REDIS_URL'] if ENV.key?('REDIS_URL')
-
-unless config.key?(:url)
-  scheme = (ENV.fetch('REDIS_SSL', 'false') == 'true') ? 'rediss' : 'redis'
-  host = ENV.fetch('REDIS_HOST', 'localhost')
-  port = ENV.fetch('REDIS_PORT', 6379)
-  db_number = ENV.fetch('REDIS_DB_NUMBER', 0)
-  password = ":#{ENV['REDIS_PASSWORD']}" if ENV.key?('REDIS_PASSWORD')
-
-  config[:url] = "#{scheme}://#{password}@#{host}:#{port}/#{db_number}"
-end
-
-if ENV.key?('REDIS_NAMESPACE')
-  require 'redis-namespace'
-
-  config[:namespace] = ENV['REDIS_NAMESPACE']
-end
-
-if ENV.key?('REDIS_SENTINELS')
-  require 'uri'
-
-  config[:role] = ENV.fetch('REDIS_SENTINEL_ROLE', :master).to_sym
-  config[:sentinels] = ENV['REDIS_SENTINELS'].split(',').map do |url|
-    uri = URI.parse(url.strip)
-    cfg = {host: uri.host || 'localhost', port: uri.port || 26379} # rubocop:disable Style/NumericLiterals
-    cfg[:password] = ":#{uri.password}" if uri.password
-    cfg
-  end
-end
-
-config[:id] = nil if ENV.key?('REDIS_DISABLE_CLIENT_ID')
-
-Sidekiq.configure_client { |client| client.redis = config }
-
-run Sidekiq::Prometheus::Exporter.to_app

data/examples/docker-compose.yml

@@ -1,49 +0,0 @@
----
-version: "3.4"
-
-services:
-  metrics:
-    build: ./metrics
-    volumes:
-      - ./metrics/config.ru:/config.ru
-    ports:
-      - 9292:9292
-    depends_on:
-      - sidekiq
-      - redis
-
-  sidekiq:
-    build: ./sidekiq
-    volumes:
-      - ./sidekiq/sidekiq.rb:/sidekiq.rb
-      - ./sidekiq/sidekiq.yml:/sidekiq.yml
-    depends_on:
-      - redis
-
-  prometheus:
-    image: prom/prometheus
-    volumes:
-      - prometheus-data:/prometheus
-      - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
-    ports:
-      - 9090:9090
-    depends_on:
-      - metrics
-
-  grafana:
-    image: grafana/grafana:7.1.1
-    volumes:
-      - grafana-data:/var/lib/grafana
-    ports:
-      - 3000:3000
-    depends_on:
-      - prometheus
-
-  redis:
-    image: redis:4.0.8-alpine
-
-volumes:
-  grafana-data:
-    driver: local
-  prometheus-data:
-    driver: local

data/examples/metrics/Dockerfile

@@ -1,7 +0,0 @@
-FROM ruby:2.3.6-alpine
-
-RUN gem install sidekiq -v "~> 5.0"
-RUN gem install sidekiq-prometheus-exporter -v "~> 0.1"
-
-ENTRYPOINT [ "rackup" ]
-CMD [ "-p", "9292", "-o", "0.0.0.0", "/config.ru" ]

data/examples/metrics/config.ru

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'sidekiq'
-require 'sidekiq/prometheus/exporter'
-
-Sidekiq.configure_client do |config|
-  config.redis = {url: 'redis://redis:6379/0'}
-end
-
-run Sidekiq::Prometheus::Exporter.to_app

data/examples/prometheus/prometheus.yml

@@ -1,8 +0,0 @@
-global:
-  scrape_interval:     5s
-  evaluation_interval: 5s
-
-scrape_configs:
-  - job_name: 'prometheus'
-    static_configs:
-      - targets: ['metrics:9292']

data/examples/sidekiq/Dockerfile

@@ -1,5 +0,0 @@
-FROM ruby:2.3.6-alpine
-
-RUN gem install sidekiq -v "~> 5.0"
-ENTRYPOINT [ "sidekiq" ]
-CMD [ "-r", "/sidekiq.rb", "-C", "/sidekiq.yml" ]

data/examples/sidekiq/sidekiq.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-class SleepyWorker
-  include Sidekiq::Worker
-
-  sidekiq_options queue: :default
-
-  def perform
-    sleep rand(1...10)
-  end
-end
-
-class BrokenWorker
-  include Sidekiq::Worker
-
-  sidekiq_options queue: :critical,
-                  retry: 5
-
-  def perform
-    raise 'Ooooooops ...'
-  end
-end
-
-Sidekiq.configure_server do |config|
-  config.redis = {url: 'redis://redis:6379/0'}
-end
-
-Sidekiq.configure_client do |config|
-  config.redis = {url: 'redis://redis:6379/0'}
-end
-
-Thread.new do
-  sleep 5
-
-  loop do
-    SleepyWorker.perform_async
-    BrokenWorker.perform_async
-
-    sleep rand(1..5)
-  end
-end

data/examples/sidekiq/sidekiq.yml

@@ -1,5 +0,0 @@
----
-:concurrency: 2
-:queues:
-  - [critical, 2]
-  - default