base on See statistic about your workers # Sidekiq::Statistic [](https://travis-ci.org/davydovanton/sidekiq-statistic) [](https://codeclimate.com/github/davydovanton/sidekiq-history) [](https://gitter.im/davydovanton/sidekiq-history?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) Improved display of statistics for your Sidekiq workers and jobs. ## Screenshots ### Index page:  ### Worker page with table (per day):  ## Installation Add this line to your application's Gemfile: gem 'sidekiq-statistic' And then execute: $ bundle ## Usage ### Using Rails Read [Sidekiq documentation](https://github.com/mperham/sidekiq/wiki/Monitoring#rails) to configure Sidekiq Web UI in your `routes.rb`. When Sidekiq Web UI is active you're going be able to see the option `Statistic` on the menu. ### Using a standalone application Read [Sidekiq documentation](https://github.com/mperham/sidekiq/wiki/Monitoring#standalone) to configure Sidekiq in your Rack server. Next add `require 'sidekiq-statistic'` to your `config.ru`. ``` ruby # config.ru require 'sidekiq/web' require 'sidekiq-statistic' use Rack::Session::Cookie, secret: 'some unique secret string here' run Sidekiq::Web ``` ## Configuration The Statistic configuration is an initializer that GEM uses to configure itself. The option `max_timelist_length` is used to avoid memory leak, in practice, whenever the cache size reaches that number, the GEM is going to remove 25% of the key values, avoiding inflating memory. ``` ruby Sidekiq::Statistic.configure do |config| config.max_timelist_length = 250_000 end ``` ## Supported Sidekiq versions Statistic support the following Sidekiq versions: - Sidekiq 6. - Sidekiq 5. - Sidekiq 4. - Sidekiq 3.5. ## JSON API ### /api/statistic.json Returns statistic for each worker. Params: * `dateFrom` - Date start (format: `yyyy-mm-dd`) * `dateTo` - Date end (format: `yyyy-mm-dd`) Example: ``` $ curl http://example.com/sidekiq/api/statistic.json?dateFrom=2015-07-30&dateTo=2015-07-31 # => { "workers": [ { "name": "Worker", "last_job_status": "passed", "number_of_calls": { "success": 1, "failure": 0, "total": 1 }, "runtime": { "last": "2015-07-31 10:42:13 UTC", "max": 4.002, "min": 4.002, "average": 4.002, "total": 4.002 } }, ... ] } ``` ### /api/statistic/:worker_name.json Returns worker statistic for each day in range. Params: * `dateFrom` - Date start (format: `yyyy-mm-dd`) * `dateTo` - Date end (format: `yyyy-mm-dd`) Example: ``` $ curl http://example.com/sidekiq/api/statistic/Worker.json?dateFrom=2015-07-30&dateTo=2015-07-31 # => { "days": [ { "date": "2015-07-31", "failure": 0, "success": 1, "total": 1, "last_job_status": "passed", "runtime": { "last": null, "max": 0, "min": 0, "average": 0, "total": 0 } }, ... ] } ``` ## Update statistic inside middleware You can update your worker statistic inside middleware. For this you should to update `sidekiq:statistic` redis hash. This hash has the following structure: * `sidekiq:statistic` - redis hash with all statistic - `yyyy-mm-dd:WorkerName:passed` - count of passed jobs for Worker name on yyyy-mm-dd - `yyyy-mm-dd:WorkerName:failed` - count of failed jobs for Worker name on yyyy-mm-dd - `yyyy-mm-dd:WorkerName:last_job_status` - string with status (`passed` or `failed`) for last job - `yyyy-mm-dd:WorkerName:last_time` - date of last job performing - `yyyy-mm-dd:WorkerName:queue` - name of job queue (`default` by default) For time information you should push the runtime value to `yyyy-mm-dd:WorkerName:timeslist` redis list. ## How it works <details> <summary>Big image 'how it works'</summary>  </details> ## Contributing 1. Fork it ( https://github.com/davydovanton/sidekiq-statistic/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request ", Assign "at most 3 tags" to the expected json: {"id":"7538","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"