sidekiq-prometheus-exporter 0.1.10 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 158112bb6619ff47bb38fd43801aaa1a01c95103
-  data.tar.gz: 99c35a1b67a403f17ee15eb4f576dcc6e30f8930
+SHA256:
+  metadata.gz: e6abd894355205259e60c8804e17560ca107d88f0299aea7fae7c495130521dd
+  data.tar.gz: 5665a775e383a91b129d12e84128740904321da0e099fc1237c9381701bd2b91
 SHA512:
-  metadata.gz: a5a4dcd286f353895888195d80e1a2c59a9142dc6a81e6b891d07cab307880e567a787892aa902a0bae7c549409663d9c56bfeb85ffffcc30e3e256a141356c7
-  data.tar.gz: 3fe0b5c64ff492697c149a13c68aea5fe0cad985d0e78c898047b2b6b876fb6fe559e3741114012aba377f66fab9dc993acf85570b0dbb7862c707c23c13ed6f
+  metadata.gz: 95a6c12a03307b5cd4651bb6190d1bf4659005554d1f42839f6f340f9bf55faab6a5335dc29ec49982f381312502ef10dec9fff2578e9120179d1f04350a980d
+  data.tar.gz: 1d4c635db97afde9d894c5294ef5d592fe2f3caf5cc72f0a33b7d1dd8ba70614eee1b54e4d3b2f54a744a03587bd669f1f7d442bfc7b803ed6f8e904b2c73edf

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# 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

@@ -0,0 +1,76 @@
+---
+name: CI
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+jobs:
+  test:
+    runs-on: ubuntu-16.04
+    name: Ruby ${{ matrix.ruby }} / Sidekiq ${{ matrix.sidekiq }}
+    strategy:
+      matrix:
+        ruby: ["2.3.8", "2.4.10", "2.5.8", "2.6.6", "2.7.2", "latest"]
+        sidekiq: ["3.3.1", "3.x", "4.x", "5.x", "6.x", "latest"]
+        include:
+          - ruby: "2.6.6"
+            sidekiq: "5.x"
+            codeclimate: "true"
+        exclude:
+          - ruby: "2.3.8"
+            sidekiq: "6.x"
+          - ruby: "2.4.10"
+            sidekiq: "6.x"
+          - ruby: "2.3.8"
+            sidekiq: "latest"
+          - ruby: "2.4.10"
+            sidekiq: "latest"
+          - ruby: "2.5.8"
+            sidekiq: "latest"
+          - ruby: "2.6.6"
+            sidekiq: "latest"
+          - ruby: "2.7.2"
+            sidekiq: "latest"
+
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+
+    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: Install CodeClimate test reporter
+        if: steps.vendor-cache.outputs.cache-hit != 'true'
+        run: |
+          mkdir -p ./vendor
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 \
+               > ./vendor/cc-test-reporter
+          chmod +x ./vendor/cc-test-reporter
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle config gemfile gemfiles/sidekiq_${{ matrix.sidekiq }}.Gemfile
+          bundle install
+
+      - name: Start recording Codeclimate test coverage
+        if: matrix.codeclimate == 'true'
+        run: ./vendor/cc-test-reporter before-build
+
+      - name: Run RSpec
+        run: bundle exec rake spec
+
+      - name: Finish recording Codeclimate test coverage
+        if: matrix.codeclimate == 'true'
+        run: ./vendor/cc-test-reporter after-build

data/.gitignore

@@ -1,4 +1,3 @@
-/.bundle/
 /.yardoc
 /_yardoc/
 /coverage/
@@ -9,6 +8,9 @@
 /Gemfile.lock
 /.ruby-version
 
+# Global ignore of bundler config
+.bundle/
+
 # rspec failure tracking
 .rspec_status
 

data/.rubocop.yml

@@ -2,7 +2,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: ~
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
@@ -30,7 +30,7 @@ Style/Documentation:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
-  EnforcedStyle: when_needed
+  EnforcedStyle: always
   SupportedStyles:
     # `when_needed` will add the frozen string literal comment to files
     # only when the `TargetRubyVersion` is set to 2.3+.
@@ -89,25 +89,25 @@ Style/NumericPredicate:
   # Exclude RSpec specs because assertions like `expect(1).to be > 0` cause
   # false positives.
   Exclude:
-    - 'spec/**/*'
+    - "spec/**/*"
 
 Style/MethodCalledOnDoEndBlock:
-  Description: 'Avoid chaining a method call on a do...end block.'
-  StyleGuide: '#single-line-blocks'
+  Description: "Avoid chaining a method call on a do...end block."
+  StyleGuide: "#single-line-blocks"
   Enabled: true
 
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
-    '%':  ()
-    '%i': ()
-    '%I': ()
-    '%q': ()
-    '%Q': ()
-    '%r': '{}'
-    '%s': ()
-    '%w': ()
-    '%W': ()
-    '%x': '{}'
+    "%": ()
+    "%i": ()
+    "%I": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": "{}"
 
 Style/SpecialGlobalVars:
   EnforcedStyle: use_english_names
@@ -158,10 +158,10 @@ Style/TernaryParentheses:
 
 Naming/AccessorMethodName:
   Description: Check the naming of accessor methods for get_/set_.
-  StyleGuide: '#accessor_mutator_method_names'
+  StyleGuide: "#accessor_mutator_method_names"
 
 # https://rubocop.readthedocs.io/en/latest/cops_naming/#naminguncommunicativemethodparamname
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - _
     - io
@@ -174,7 +174,11 @@ Naming/UncommunicativeMethodParamName:
 
 #################### Layout ####################################
 
-Layout/AlignParameters:
+Layout/LineLength:
+  # Default: 80
+  Max: 120
+
+Layout/ParameterAlignment:
   # Alignment of parameters in multi-line method calls.
   #
   # The `with_first_parameter` style aligns the following lines along the same
@@ -194,7 +198,7 @@ Layout/AlignParameters:
     - with_fixed_indentation
 
 # Checks the indentation of the first element in an array literal.
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   # The value `special_inside_parentheses` means that array literals with
   # brackets that have their opening bracket on the same line as a surrounding
   # opening round parenthesis, shall have their first element indented relative
@@ -216,7 +220,7 @@ Layout/IndentArray:
   IndentationWidth: ~
 
 # Checks the indentation of the first key in a hash literal.
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   # The value `special_inside_parentheses` means that hash literals with braces
   # that have their opening brace on the same line as a surrounding opening
   # round parenthesis, shall have their first key indented relative to the
@@ -277,20 +281,16 @@ Layout/MultilineOperationIndentation:
 
 ##################### Metrics ##################################
 
-Metrics/LineLength:
-  # Default: 80
-  Max: 120
-
 Metrics/MethodLength:
   # Default: 10
   Max: 15
 
 Metrics/BlockLength:
   Exclude:
-    - 'Rakefile'
-    - '**/*.gemspec'
-    - '**/*.rake'
-    - 'spec/**/*.rb'
+    - "Rakefile"
+    - "**/*.gemspec"
+    - "**/*.rake"
+    - "spec/**/*.rb"
 
 ##################### Lint ##################################
 

data/Appraisals

@@ -1,6 +1,7 @@
 appraise 'sidekiq-3.3.1' do
   gem 'slim'
-  gem 'redis', '>= 3.3.5'
+  gem 'redis', '~> 3.3'
+  gem 'redis-namespace', '< 1.7.0'
   gem 'sinatra'
   gem 'concurrent-ruby'
   gem 'sidekiq', '= 3.3.1'
@@ -8,18 +9,30 @@ end
 
 appraise 'sidekiq-3.x' do
   gem 'slim'
-  gem 'redis', '>= 3.3.5'
+  gem 'redis', '~> 3.3'
+  gem 'redis-namespace', '< 1.7.0'
   gem 'sinatra'
   gem 'concurrent-ruby'
   gem 'sidekiq', '~> 3.0'
 end
 
 appraise 'sidekiq-4.x' do
-  gem 'redis', '>= 3.3.5'
+  gem 'redis', '~> 3.3'
   gem 'sidekiq', '~> 4.0'
 end
 
 appraise 'sidekiq-5.x' do
-  gem 'redis', '>= 3.3.5'
+  gem 'redis', '~> 3.3'
   gem 'sidekiq', '~> 5.0'
 end
+
+appraise 'sidekiq-6.x' do
+  gem 'redis', '~> 4.1'
+  gem 'sidekiq', '~> 6.0'
+end
+
+appraise 'sidekiq-latest' do
+  gem 'rack', '>= 2', github: 'rack/rack'
+  gem 'redis', '>= 4', github: 'redis/redis-rb'
+  gem 'sidekiq', '>= 6', github: 'mperham/sidekiq'
+end

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/Strech/sidekiq-prometheus-exporter.svg?branch=master)](https://travis-ci.org/Strech/sidekiq-prometheus-exporter)
+![CI status](https://github.com/Strech/sidekiq-prometheus-exporter/workflows/CI/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bb1b30cd7aca8ecc9413/maintainability)](https://codeclimate.com/github/Strech/sidekiq-prometheus-exporter/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/bb1b30cd7aca8ecc9413/test_coverage)](https://codeclimate.com/github/Strech/sidekiq-prometheus-exporter/test_coverage)
 
@@ -10,66 +10,78 @@
 
 ![Grafana dashboard example](/examples/screenshot.png)
 
-Open [dashboard example file](/examples/sidekiq.json), then open `https://<your grafana-url>/dashboard/import` and paste the content of the file.
+Open [dashboard example file](/examples/sidekiq-dashboard.grafana-7.json) (grafana 7), then open `https://<your grafana-url>/dashboard/import` and paste the content of the file.
 
 # Available metrics
 
-*(starting Sidekiq `v3.3.1`)*
+_(starting Sidekiq `v3.3.1`)_
 
-### Standard
+## Standard
 
-| Name                                      | Type    | Description             |
-|-------------------------------------------|---------|-------------------------|
-| sidekiq_processed_jobs_total              | counter | The total number of processed jobs
-| sidekiq_failed_jobs_total                 | counter | The total number of failed jobs
-| sidekiq_workers                           | gauge   | The number of workers across all the processes
-| sidekiq_processes                         | gauge   | The number of processes
-| sidekiq_busy_workers                      | gauge   | The number of workers performing the job
-| sidekiq_enqueued_jobs                     | gauge   | The number of enqueued jobs
-| sidekiq_scheduled_jobs                    | gauge   | The number of jobs scheduled for a future execution
-| sidekiq_retry_jobs                        | gauge   | The number of jobs scheduled for the next try
-| sidekiq_dead_jobs                         | gauge   | The number of jobs being dead
-| sidekiq_queue_latency_seconds             | gauge   | The number of seconds between oldest job being pushed to the queue and current time (labels: `name`)
-| sidekiq_queue_max_processing_time_seconds | gauge   | The number of seconds between oldest job of the queue being executed and current time (labels: `name`)
-| sidekiq_queue_enqueued_jobs               | gauge   | The number of enqueued jobs in the queue (labels: `name`)
+| Name                                      | Type    | Description                                                                                            |
+| ----------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------ |
+| sidekiq_processed_jobs_total              | counter | The total number of processed jobs                                                                     |
+| sidekiq_failed_jobs_total                 | counter | The total number of failed jobs                                                                        |
+| sidekiq_workers                           | gauge   | The number of workers across all the processes                                                         |
+| sidekiq_processes                         | gauge   | The number of processes                                                                                |
+| sidekiq_busy_workers                      | gauge   | The number of workers performing the job                                                               |
+| sidekiq_enqueued_jobs                     | gauge   | The number of enqueued jobs                                                                            |
+| sidekiq_scheduled_jobs                    | gauge   | The number of jobs scheduled for a future execution                                                    |
+| sidekiq_retry_jobs                        | gauge   | The number of jobs scheduled for the next try                                                          |
+| sidekiq_dead_jobs                         | gauge   | The number of jobs being dead                                                                          |
+| sidekiq_queue_latency_seconds             | gauge   | The number of seconds between oldest job being pushed to the queue and current time (labels: `name`)   |
+| sidekiq_queue_max_processing_time_seconds | gauge   | The number of seconds between oldest job of the queue being executed and current time (labels: `name`) |
+| sidekiq_queue_enqueued_jobs               | gauge   | The number of enqueued jobs in the queue (labels: `name`)                                              |
 
-### [Scheduler](https://github.com/moove-it/sidekiq-scheduler)
+<details>
+  <summary>Click to expand for all available contribs</summary>
 
-| Name                                          | Type  | Description           |
-|-----------------------------------------------|-------|-----------------------|
-| sidekiq_scheduler_jobs                        | gauge | The number of recurring jobs
-| sidekiq_scheduler_enabled_jobs                | gauge | The number of enabled recurring jobs
-| sidekiq_scheduler_time_since_last_run_minutes | gauge | The number of minutes since the last recurring job was executed and current time (labels: `name`)
+## [Scheduler](https://github.com/moove-it/sidekiq-scheduler)
 
-### [Cron](https://github.com/ondrejbartas/sidekiq-cron)
+| Name                                          | Type  | Description                                                                                       |
+| --------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------- |
+| sidekiq_scheduler_jobs                        | gauge | The number of recurring jobs                                                                      |
+| sidekiq_scheduler_enabled_jobs                | gauge | The number of enabled recurring jobs                                                              |
+| sidekiq_scheduler_time_since_last_run_minutes | gauge | The number of minutes since the last recurring job was executed and current time (labels: `name`) |
 
-| Name                                      | Type    | Description             |
-|-------------------------------------------|---------|-------------------------|
-| sidekiq_cron_jobs                         | gauge   | The number of cron jobs
+## [Cron](https://github.com/ondrejbartas/sidekiq-cron)
+
+| Name              | Type  | Description             |
+| ----------------- | ----- | ----------------------- |
+| sidekiq_cron_jobs | gauge | The number of cron jobs |
+
+</details>
+
+## Sponsorship
+
+If you like the project and want to support me on my sleepless nights, you can
+
+[![Support via PayPal](https://cdn.rawgit.com/twolfson/paypal-github-button/1.0.0/dist/button.svg)](https://www.paypal.com/paypalme/onistrech/eur5.0)
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W8367XJ)
 
 # Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sidekiq-prometheus-exporter'
+gem 'sidekiq-prometheus-exporter', '~> 0.1'
 ```
 
 And then execute:
 
-```bash
+```console
 $ bundle
 ```
 
 Or install it yourself as:
 
-```bash
+```console
 $ gem install sidekiq-prometheus-exporter -v '~> 0.1'
 ```
 
-# Rack application
+## Rack application
 
-For  a fresh new application to expose metrics create `config.ru` file with
+For a fresh new application to expose metrics create `config.ru` file with
 next code inside
 
 ```ruby
@@ -85,13 +97,37 @@ run Sidekiq::Prometheus::Exporter.to_app
 
 Use your favorite server to start it up, like this
 
-```bash
+```console
 $ bundle exec rackup -p9292 -o0.0.0.0
 ```
 
 and then `curl https://0.0.0.0:9292/metrics`
 
-# Sidekiq Web (extream)
+## Rails application
+
+When you have rails application, it's possible to mount exporter
+as a rack application in your `routes.rb`
+
+```ruby
+Rails.application.routes.draw do
+  # ... omitted ...
+
+  # For more information please check here
+  # https://api.rubyonrails.org/v5.1/classes/ActionDispatch/Routing/Mapper/Base.html#method-i-mount
+  require 'sidekiq/prometheus/exporter'
+  mount Sidekiq::Prometheus::Exporter => '/metrics'
+end
+```
+
+Use rails server from `bin` folder to start it up, like this
+
+```console
+$ ./bin/rails s -p 9292 -b 0.0.0.0
+```
+
+and then `curl https://0.0.0.0:9292/metrics`
+
+## Sidekiq Web (extream)
 
 If you are ok with metrics being exposed via Sidekiq web dashboard because
 you have it inside your private network or only Prometheus scraper will have access
@@ -106,7 +142,52 @@ Sidekiq::Web.register(Sidekiq::Prometheus::Exporter)
 
 and then `curl https://<your-sidekiq-web-uri>/metrics`
 
-# Sidekiq Contribs
+## Docker
+
+If we are talking about isolation you can run already prepared official
+rack application in the Docker container by using the [public image](https://hub.docker.com/r/strech/sidekiq-prometheus-exporter)
+(check out this [README](/blob/master/docker/README.md) for more)
+
+```bash
+$ docker run -it --rm \
+             -p 9292:9292 \
+             -e REDIS_URL=redis://<your-redis-host>:6379/0 \
+             strech/sidekiq-prometheus-exporter
+```
+
+and then `curl https://0.0.0.0:9292/metrics`
+
+## Helm
+
+And finally the cloud solution _(who don't these days)_. Easy to install, easy
+to use. A fully-functioning Helm-package based on official [Docker
+image](https://hub.docker.com/r/strech/sidekiq-prometheus-exporter), comes with lots of [configuration
+options](https://github.com/Strech/sidekiq-prometheus-exporter/blob/master/helm/sidekiq-prometheus-exporter/README.md)
+
+```console
+$ helm repo add strech https://strech.github.io/sidekiq-prometheus-exporter
+"strech" has been added to your repositories
+
+$ helm install strech/sidekiq-prometheus-exporter --name sidekiq-metrics
+```
+
+to `curl` your metrics, please follow the post-installation guide
+
+# Tips&Tricks
+
+If you want to see at the exporter startup time a banner about which exporters
+are enabled add this call to your `config.ru` (but after exporter `configure` statement)
+
+```ruby
+require 'sidekiq/prometheus/exporter'
+
+puts Sidekiq::Prometheus::Exporter.banner
+```
+
+:anger: if you don't see your banner try to output into `STDERR` instead of
+`STDOUT`
+
+## Sidekiq Contribs
 
 By default we try to detect as many as possible [sidekiq contribs](https://github.com/mperham/sidekiq/wiki/Related-Projects)
 and add their metrics to the output.
@@ -126,7 +207,9 @@ Sidekiq::Prometheus::Exporter.configure do |config|
 end
 ```
 
-## Contributing
+:bulb: if you did't find the contrib you would like to see, don't hesitate to [open an issue](https://github.com/Strech/sidekiq-prometheus-exporter/issues/new) and describe what do you think we should export.
+
+# Contributing
 
 Bug reports and pull requests to support earlier versions of Sidekiq are welcome on GitHub at https://github.com/Strech/sidekiq-prometheus-exporter/issues.