sidekiq-prometheus-exporter 0.1.9 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8500379e8abe15f6eb9680233e4a5c29367814f
-  data.tar.gz: 024d07a212ce61766c3d9753d5e30d23eefea448
+SHA256:
+  metadata.gz: b765e7d2573199042fcb0bc816c07797ddc7cd629a8491df3eee217f09282883
+  data.tar.gz: 7db77dd139a068968b55a79c1cdf57f9bbb7684f739ad95044cfd6fd4cf22389
 SHA512:
-  metadata.gz: e38cf453e888f26bd19e8eef17d1f2dd1187ad4dd790425c1dcbfe309a4c4efb0b207341bd23b364dba5dd6fced3967e00d73ade5f0cc88ceaceaf211438ee73
-  data.tar.gz: 19d8fd0bcafc80ff5c032391bd80eb4a92b8427911153fef16a05f03b7d68959b801182e4a2c1841174e356c1c13aefe46987fe12d901e1d0c8528a3196a347a
+  metadata.gz: 6c83d7afd3fcf1a0dfe16bc9bc35f05ad84bad8a46656d4af313c309427682f6e4347f912c3f0daeb7594d12fc9914f9e2e4f5452a4925643eebe81224e2e736
+  data.tar.gz: 3be26fb67085e9dbebcd9eb9a377feb24acfbb075e1a67eebdf550ffa8e5c54716398e254fbf6cee9b4c92cf2b814bd1951dc13f9c13ded4c27c054020cc3828

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/.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/.travis.yml

@@ -1,23 +1,85 @@
-sudo: false
+os: linux
+dist: xenial
 language: ruby
 rvm:
-  - 2.2.10
   - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.2
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+  - ruby-head
+notifications:
+  email: false
+
 gemfile:
   - gemfiles/sidekiq_3.3.1.gemfile
   - gemfiles/sidekiq_3.x.gemfile
   - gemfiles/sidekiq_4.x.gemfile
   - gemfiles/sidekiq_5.x.gemfile
-addons:
-  code_climate:
-    repo_token: $CODECLIMATE_REPO_TOKEN
-notifications:
-  email: false
+  - gemfiles/sidekiq_6.x.gemfile
+  - gemfiles/sidekiq_head.gemfile
+
+jobs:
+  include:
+    - rvm: "2.6.6"
+      gemfile: "gemfiles/sidekiq_5.x.gemfile"
+      env:
+        - CODECLIMATE_REPORT=true
+  exclude:
+    - rvm: "2.3.8"
+      gemfile: "gemfiles/sidekiq_6.x.gemfile"
+    - rvm: "2.4.10"
+      gemfile: "gemfiles/sidekiq_6.x.gemfile"
+    - rvm: "2.3.8"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+    - rvm: "2.4.10"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+    - rvm: "2.5.8"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+    - rvm: "2.6.6"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+    - rvm: "2.7.1"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+  allow_failures:
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_3.3.1.gemfile"
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_3.x.gemfile"
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_4.x.gemfile"
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_5.x.gemfile"
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_6.x.gemfile"
+    - rvm: "ruby-head"
+      gemfile: "gemfiles/sidekiq_head.gemfile"
+
+cache:
+  directories:
+    - ./vendor
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$CODECLIMATE_REPO_TOKEN
+
+before_install:
+  - gem install bundler -v '~> 2.1'
+
+before_script:
+  - if [ ! -f ./vendor/cc-test-reporter ]; then
+    curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./vendor/cc-test-reporter;
+    chmod +x ./vendor/cc-test-reporter;
+    fi
+  - if [ ! -z "$CODECLIMATE_REPORT" ]; then
+    echo "Start recording Codeclimate test coverage";
+    ./vendor/cc-test-reporter before-build;
+    fi
+
+script:
+  - bundle exec rake spec
 
-cache: bundler
-before_install: gem install bundler -v 1.16.5
-after_success: bundle exec codeclimate-test-reporter
-script: bundle exec rake spec
+after_success:
+  - if [ ! -z "$CODECLIMATE_REPORT" ]; then
+    echo "Finish recording Codeclimate test coverage";
+    ./vendor/cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT;
+    fi

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-head' do
+  gem 'rack', '>= 2', github: 'rack/rack'
+  gem 'redis', '>= 4', github: 'redis/redis-rb'
+  gem 'sidekiq', '>= 6', github: 'mperham/sidekiq'
+end

data/README.md

@@ -10,56 +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_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 amount of seconds between oldest job being pushed to the queue and current time (labels: `name`)
-| sidekiq_queue_max_processing_time_seconds | gauge   | The amount 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`)                                              |
 
-### [Cron](https://github.com/ondrejbartas/sidekiq-cron)
+<details>
+  <summary>Click to expand for all available contribs</summary>
 
-| Name                                      | Type    | Description             |
-|-------------------------------------------|---------|-------------------------|
-| sidekiq_cron_jobs                         | gauge   | The number of cron jobs
+## [Scheduler](https://github.com/moove-it/sidekiq-scheduler)
+
+| 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`) |
+
+## [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
@@ -75,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
@@ -96,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.
@@ -116,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.