sidekiq-statistic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c4eb622f47e1018cc66fcd471d4b6cff9c2e9c2
+  data.tar.gz: 933f7ff73ff792308ca852e0e7d1cdfe8217c706
+SHA512:
+  metadata.gz: 5814fd4ba22afb951a089ffa6a8cc560a1792ea63faad2d1b13e09c53bcc63c1b5bacf5d9ef33665eb98d44bfdf66325dff071ff212593aa2e02f658ca49f5ea
+  data.tar.gz: c748d18674cbb9c0d95d8ae4bdc92079d5895fa130dc2dd29e2d49f4e7fe6e0ba3a7b0d03ae3caedfed30033a0caa05cf24d4944bfb82363f525d756889310d8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/dump.rdb

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+cache: bundler
+services:
+  - redis-server
+rvm:
+  - 2.1
+  - 2.0.0
+  - 2.2
+  - jruby-19mode
+  - jruby
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby
+bundler_args: --without test --jobs 3 --retry 3

data/CHANGELOG.md

@@ -0,0 +1,86 @@
+## v1.0
+* 19.08.2015: Middleware refactoring (#45)
+
+  *Mike Perham*
+* 19.08.2015: Use redis lists for save all job runtimes
+
+  *Anton Davydov*
+* 12.08.2015: Add filters (by worker) for realtime charts
+
+  *Anton Davydov*
+* 11.08.2015: Realtime chart for each worker and job
+
+  *Anton Davydov*
+* 31.07.2015: Add JSON API
+
+  *Anton Davydov*
+* 29.07.2015: Add localizations for plugin
+
+  *Anton Davydov*
+* 28.07.2015: Read first 1_000 lines from changelog
+
+  *Anton Davydov*
+* 28.07.2015: Rename plugin to sidekiq-statistic
+
+  *Anton Davydov*
+* 23.07.2015: Use native redis hash instead json serialization
+
+  *Anton Davydov*
+* 15.07.2015: Improve integration with active job
+
+  *Anton Davydov*
+* 01.07.2015: New realisation for thread safe history middleware
+
+  *Anton Davydov*
+* 13.05.2015: Add ability to change any date range on any history page
+
+  *Anton Davydov*
+* 12.05.2015: Add last job status data parameter for each worker
+
+  *Anton Davydov*
+* 11.05.2015: Add page woth worker data table for each day
+
+  *Anton Davydov*
+* 28.04.2015: Formating worker date in web UI
+
+  *Anton Davydov*
+* 27.04.2015: Set specific color for any worker
+
+  *Anton Davydov*
+* 10.04.2015: Add search field on worker page
+
+  *Anton Davydov*
+* 04.04.2015: Fix livereload button in index page
+
+  *Anton Davydov*
+* 23.03.2015: Add max runtime column to worker web table
+
+  *Anton Davydov*
+* 19.03.2015: Add functionality for adding custom css and js files to web page
+
+  *Anton Davydov*
+* 18.03.2015: Add configuration class with log_file options
+
+  *Anton Davydov*
+* 16.03.2015: Add worker page where user can see log for this worker
+
+  *Anton Davydov*
+* 15.03.2015: Add worker statistic table to index history page
+
+  *Anton Davydov*
+* 08.03.2015: Add charts for each passed and failed jobs for each worker.
+
+  *Anton Davydov*
+* 08.03.2015: Add Statistic class which provide statistics
+              for each day and each worker.
+
+  Sidekiq::History::Statistic.new(0).workers_hash
+  # =>[{"2015-03-07"=>{"HistoryWorker"=>{:failed=>1, :passed=>1}}}]
+
+  *Anton Davydov*
+* 08.03.2015: Save in redis json with failed and passed jobs for each worker.
+
+  *Anton Davydov*
+* 04.03.2015: Created simple midelware and static page.
+
+  *Anton Davydov*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anton Davydov
+
+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,134 @@
+# Sidekiq statistic
+
+[![Build Status](https://travis-ci.org/davydovanton/sidekiq-statistic.svg)](https://travis-ci.org/davydovanton/sidekiq-statistic) [![Code Climate](https://codeclimate.com/github/davydovanton/sidekiq-history/badges/gpa.svg)](https://codeclimate.com/github/davydovanton/sidekiq-history) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](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.
+
+**This gem work only with sidekiq version more than [3.3.4](https://github.com/mperham/sidekiq/releases/tag/v3.3.4)**
+
+## Screenshots
+Also you can check <a href="https://sidekiq-history-gem.herokuapp.com/sidekiq/statistic" target="_blank">heroku application</a> with rails app with this sidekiq plugin
+
+### Index page:
+![sidekiq-history_index](https://cloud.githubusercontent.com/assets/1147484/8071172/1708e3b0-0f10-11e5-84cf-86a910f5ecc2.png)
+
+### Worker page with table (per day):
+![sidekiq-history_worker](https://cloud.githubusercontent.com/assets/1147484/8071171/1706924a-0f10-11e5-9ddc-8aeeb7f5c794.png)
+
+### Worker page with log:
+![screenshot 2015-06-10 01 27 50](https://cloud.githubusercontent.com/assets/1147484/8071166/0edd7688-0f10-11e5-9841-0572ab5704e3.jpg)
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-statistic', github: 'davydovanton/sidekiq-statistic'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+Open in your browser `<sidekiq-path>/statistic` page.
+
+### Not rails application
+First step: read [sidekiq documentation](https://github.com/mperham/sidekiq/wiki/Monitoring#standalone).
+
+Second step: add `require 'sidekiq-statistic'` to you `config.ru`. For example:
+``` ruby
+# config.ru
+require 'sidekiq/web'
+require 'sidekiq-statistic'
+
+use Rack::Session::Cookie, secret: 'some unique secret string here'
+run Sidekiq::Web
+```
+
+## Configuration
+Sidekiq statistic gem have `log_file` option. This option lets you specify a custom path to sidekiq log file. By default this option equal `log/sidekiq.log`
+
+``` ruby
+Sidekiq::Statistic.configure do |config|
+  config.log_file = 'test/helpers/logfile.log'
+end
+```
+
+## 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
+      }
+    },
+
+    ...
+  ]
+}
+```
+
+## How it works
+![how-it-works](https://cloud.githubusercontent.com/assets/1147484/8802272/fc0a1302-2fc8-11e5-86a5-817409259338.png)
+
+## 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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/history"
+
+# 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

data/lib/sidekiq-statistic.rb

@@ -0,0 +1 @@
+require 'sidekiq/statistic'

data/lib/sidekiq/statistic.rb

@@ -0,0 +1,49 @@
+begin
+  require 'sidekiq/web'
+rescue LoadError
+  # client-only usage
+end
+
+require 'sidekiq/api'
+require 'sidekiq/statistic/configuration'
+require 'sidekiq/statistic/log_parser'
+require 'sidekiq/statistic/middleware'
+require 'sidekiq/statistic/base'
+require 'sidekiq/statistic/statistic/charts'
+require 'sidekiq/statistic/statistic/realtime'
+require 'sidekiq/statistic/statistic/runtime'
+require 'sidekiq/statistic/statistic/workers'
+require 'sidekiq/statistic/version'
+require 'sidekiq/statistic/web_extension'
+require 'sidekiq/statistic/web_api_extension'
+require 'sidekiq/statistic/web_extension_helper'
+
+module Sidekiq
+  module Statistic
+    REDIS_HASH = 'sidekiq:statistic'.freeze
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Statistic::Middleware
+  end
+end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::Statistic::WebApiExtension
+  Sidekiq::Web.register Sidekiq::Statistic::WebExtension
+  Sidekiq::Web.tabs['Statistic'] = 'statistic'
+end

data/lib/sidekiq/statistic/base.rb

@@ -0,0 +1,103 @@
+module Sidekiq
+  module Statistic
+    class Base
+      def initialize(days_previous, start_date = nil)
+        @start_date = start_date || Time.now.utc.to_date
+        @end_date = @start_date - days_previous
+      end
+
+      def statistic_for(worker)
+        statistic_hash.map{ |h| h.values.first[worker] || {} }
+      end
+
+      def worker_names
+        @worker_names ||= statistic_hash.flat_map{ |h| h.values.first.keys }.uniq
+      end
+
+      def statistic_hash
+        @redis_hash ||= Sidekiq.redis do |conn|
+          redis_hash = {}
+          get_statistic_hash(conn, redis_hash)
+          update_time_values(conn, redis_hash)
+          desired_dates.map { |key| result_hash(redis_hash, key) }
+        end
+      end
+
+    private
+
+      def get_statistic_hash(conn, redis_hash)
+        conn
+          .hgetall(REDIS_HASH)
+          .each do |keys, value|
+            *keys, last = keys.split(':'.freeze)
+            keys.inject(redis_hash, &key_or_empty_hash)[last.to_sym] = to_number(value)
+          end
+      end
+
+      def key_or_empty_hash
+        ->(h, k) { h[k] || h[k] = {} }
+      end
+
+      def desired_dates
+        (@end_date..@start_date).map(&:to_s)
+      end
+
+      def result_hash(redis_hash, key)
+        redis_hash.fetch(key, {}).each { |_, v| update_hash_statments v }
+        { key => (redis_hash[key] || {}) }
+      end
+
+      def update_hash_statments(hash)
+        hash[:passed] ||= 0
+        hash[:failed] ||= 0
+      end
+
+      def to_number(value)
+        case value
+        when /\A[\d.]+\z/ then value.to_f
+        when /\A\d+\z/ then value.to_i
+        else value
+        end
+      end
+
+      def update_time_values(conn, redis_hash)
+        redis_hash.each do |time, workers|
+          workers.each do |worker, _|
+            worker_key = "#{time}:#{worker}"
+
+            timeslist, _ = conn.multi do |multi|
+              multi.lrange("#{worker_key}:timeslist", 0, -1)
+              multi.del("#{worker_key}:timeslist")
+            end
+
+            timeslist.map!(&:to_f)
+            redis_hash[time][worker].merge! time_hash(timeslist, worker_key)
+          end
+        end
+      end
+
+      def time_hash(timeslist, worker_key)
+        return {} if timeslist.empty?
+        statistics = time_statistics(timeslist)
+
+        Sidekiq.redis do |redis|
+          redis.hmset REDIS_HASH,
+            statistics.flat_map{ |(k, v)| ["#{worker_key}:#{k}", v] }
+        end
+
+        statistics
+      end
+
+      def time_statistics(timeslist)
+        total = timeslist.inject(:+)
+
+        {
+          average_time: total / timeslist.count,
+          min_time: timeslist.min,
+          max_time: timeslist.max,
+          total_time: total
+        }
+      end
+    end
+  end
+end