sidekiq-statistic 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 204eadc3fb3cee1ccf67c444c6d605bcbf605071
-  data.tar.gz: 0fccef486519aa0e2d83768f799489cd84526401
+SHA256:
+  metadata.gz: a32f2de3dc5fe06de39827e46f0b182a20f9221eeac4ddd03f01cf7d1038d699
+  data.tar.gz: f47b057b32feb27d543d936661cbcd440a0f5562d75f005d5bdaf53d9805d800
 SHA512:
-  metadata.gz: cd21216040203ef9fbe3d119f246635e22b58a0593b35055ca4e6d26e9bbb553170710f76afd73cad262576ebef37d60ffcf6ec2e0480eebc5c6a60f4801d381
-  data.tar.gz: 7a84e030ce3dd3820e9b4c428c4f3a052b91409026eeb29d29513ff23ce5866af808d0d3c0cf88ab04ce685f42fde21908ce22b51b82ea5cb2b63f1d05f9f9da
+  metadata.gz: b70d66e91a305176f3044fb66441430a3064404a9929089e9090c92692f154ad1b180696317d0c9bd03920b95a5d7785bb7f802ced621083321a210144449d71
+  data.tar.gz: b825025d90d0f899f83b347a16f217703c75037bcc9605c041a72cb48828b9ef2aca15593c09d16980f0ecee9558c0154f4af1ef64a5e384a454725d2561322a

data/.travis.yml

@@ -3,15 +3,15 @@ sudo: false
 cache: bundler
 services:
   - redis-server
+before_install:
+  - gem install bundler
+  - gem update bundler
 rvm:
-  - 2.1
-  - 2.0.0
-  - 2.2
-  - jruby-19mode
-  - jruby
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - jruby-head
   - rbx-2
 matrix:
   allow_failures:
     - rvm: rbx-2
-    - rvm: jruby
-bundler_args: --without test --jobs 3 --retry 3

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 ## HEAD
+* 08.03.2019: Change LogParser regexp (#81) *Kirill Tatchihin*
+* 03.02.02019: Change storing of last_runtime from date to timestamp (#87) *Kirill Tatchihin*
+* 30.03.2017: Prevent excessive Redis memory usage (#107) *Gareth du Plooy*
+* 08.04.2016: Add new option for displaying last N lines of log file (#91) *Nick Zhebrun*
+* 20.11.2015: Convert value in redis time array to float (#76) *Anton Davydov*
+* 20.11.2015: Add Ukrainian Localization (#85) *@POStroi*
 
 ## v1.2
 * 15.11.2015: Update gemspec to allow usage with sidekiq 4 (#83) *Felix Bünemann*

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Anton Davydov
+Copyright (c) 2016 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

data/README.md

@@ -39,16 +39,19 @@ require 'sidekiq/web'
 require 'sidekiq-statistic'
 
 use Rack::Session::Cookie, secret: 'some unique secret string here'
-Sidekiq::Web.instance_eval { @middleware.reverse! } # Last added, First Run
 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`
+Sidekiq statistic gem have `log_file` and `last_log_lines` options.
+`log_file` option lets you specify a custom path to sidekiq log file. By default this option equal `log/sidekiq.log`
+`last_log lines` option lets you specify a custom count of last logger file lines which will be displayed. By default this option equal 1000.
 
 ``` ruby
 Sidekiq::Statistic.configure do |config|
   config.log_file = 'test/helpers/logfile.log'
+  config.last_log_lines = 10_000
+  config.max_timelist_length = 500_000
 end
 ```
 
@@ -126,7 +129,7 @@ $ curl http://example.com/sidekiq/api/statistic/Worker.json?dateFrom=2015-07-30&
 ## 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:
-* `sideki:statistic` - redis hash with all statistic
+* `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:failed` - count of failed jobs for Worker name on yyyy-mm-dd
@@ -137,7 +140,12 @@ This hash has the following structure:
 For time information you should push the runtime value to `yyyy-mm-dd:WorkerName:timeslist` redis list.
 
 ## How it works
-![how-it-works](https://cloud.githubusercontent.com/assets/1147484/8802272/fc0a1302-2fc8-11e5-86a5-817409259338.png)
+<details>
+ <summary>Big image 'how it works'</summary>
+    
+ ![how-it-works](https://cloud.githubusercontent.com/assets/1147484/8802272/fc0a1302-2fc8-11e5-86a5-817409259338.png)
+
+</details>
 
 ## Contributing
 1. Fork it ( https://github.com/davydovanton/sidekiq-statistic/fork )

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/bin/console

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

data/lib/sidekiq-statistic.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sidekiq/statistic'

data/lib/sidekiq/statistic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'sidekiq/web'
 rescue LoadError
@@ -17,10 +19,11 @@ require 'sidekiq/statistic/version'
 require 'sidekiq/statistic/web_extension'
 require 'sidekiq/statistic/web_api_extension'
 require 'sidekiq/statistic/web_extension_helper'
+require 'sidekiq/statistic/helpers/color'
 
 module Sidekiq
   module Statistic
-    REDIS_HASH = 'sidekiq:statistic'.freeze
+    REDIS_HASH = 'sidekiq:statistic'
 
     class << self
       attr_writer :configuration

data/lib/sidekiq/statistic/base.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Statistic
     class Base
-      KEY_SEPARATOR = /(?<!:):(?!:)/.freeze
+      KEY_SEPARATOR = /(?<!:):(?!:)/
 
       def initialize(days_previous, start_date = nil)
         @start_date = start_date || Time.now.utc.to_date
@@ -56,8 +58,8 @@ module Sidekiq
 
       def to_number(value)
         case value
-        when /\A[\d.]+\z/ then value.to_f
-        when /\A\d+\z/ then value.to_i
+        when /\A-?\d+\.\d+\z/ then value.to_f
+        when /\A-?\d+\z/ then value.to_i
         else value
         end
       end

data/lib/sidekiq/statistic/configuration.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Statistic
     class Configuration
-      attr_accessor :log_file
+      attr_accessor :log_file, :last_log_lines, :max_timelist_length
 
       def initialize
         @log_file = 'log/sidekiq.log'
+        @last_log_lines = 1_000
+        @max_timelist_length = 250_000
       end
     end
   end

data/lib/sidekiq/statistic/helpers/color.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Statistic
+    module Helpers
+      class Color
+        class << self
+          def for(worker_name, format = :rgb)
+            rgb = Digest::MD5.hexdigest(worker_name)[0..5]
+                             .scan(/../)
+                             .map { |color| color.to_i(16) }
+                             .join(',')
+
+            return to_hex(rgb) if format == :hex
+
+            rgb
+          end
+
+          private
+
+          def to_hex(rgb)
+            '#' + rgb.split(',').map { |v| v.to_i.to_s(16).rjust(2, '0').upcase }.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/statistic/locales/de.yml

@@ -25,3 +25,5 @@ de: # <---- change this to your locale code
   WorkerLog: Arbeiter-Log
   WorkerTablePerDay: Arbeiter-Tabelle (pro Tag)
   LastRun: Letzte Ausführung
+  EmptyLogs: Keine Ergebnisse
+  SearchLogs: Suchen Sie in der Protokolldatei

data/lib/sidekiq/statistic/locales/en.yml

@@ -25,3 +25,5 @@ en: # <---- change this to your locale code
   WorkerLog: Worker log
   WorkerTablePerDay: Worker table (per day)
   LastRun: Last run
+  EmptyLogs: No results
+  SearchLogs: Search in log file

data/lib/sidekiq/statistic/locales/fr.yml

@@ -0,0 +1,29 @@
+# elements like %{queue} are variables and should not be translated
+fr: # <---- change this to your locale code
+  Queue: Queue
+  Exclude: Exclure
+  Index: Indice
+  RealtimeStatistic: Statistique en temps réel
+  Statistic: Statistique
+  Start: Début
+  End: Fin
+  Failed: Échoué
+  Passed: Passé
+  WorkersTable: Workers Table
+  Worker: Worker
+  Date: Date
+  Success: Succès
+  Failure: Échec
+  Total: Total
+  TimeSec: Temps (sec)
+  AverageSec: Moyenne (sec)
+  MinTimeSec: Min temps (sec)
+  MaxTimeSec: Max temps (sec)
+  LastJobStatus: Dernier statut job
+  WorkerInformation: '%{worker} information'
+  InformationTable: Information table
+  WorkerLog: Journaux Worker
+  WorkerTablePerDay: Worker Table (par jour)
+  LastRun: Dernier Exécution
+  EmptyLogs: Jornaux Vides
+  SearchLogs: Journaux de recherche

data/lib/sidekiq/statistic/locales/it.yml

@@ -25,3 +25,5 @@ it: # <---- change this to your locale code
   WorkerLog: Worker log
   WorkerTablePerDay: Tabella Worker (per giorno)
   LastRun: Ultima Esecuzione
+  EmptyLogs: Nessun Risultato
+  SearchLogs: Cerca nel file di registro

data/lib/sidekiq/statistic/locales/jp.yml

@@ -0,0 +1,29 @@
+# elements like %{queue} are variables and should not be translated
+jp: # <---- change this to your locale code
+  Queue: キュー
+  Exclude: 削除
+  Index: 索引
+  RealtimeStatistic: リアルタイム統計
+  Statistic: 統計
+  Start: 開始
+  End: 終了
+  Failed: 失敗
+  Passed: 成功
+  WorkersTable: ワーカー表
+  Worker: ワーカー
+  Date: 日付
+  Success: 成功
+  Failure: 失敗
+  Total: 合計
+  TimeSec: 時間(秒)
+  AverageSec: 平均時間(秒)
+  MinTimeSec: 最小時間(秒)
+  MaxTimeSec: 最長時間(秒)
+  LastJobStatus: 最後の状態
+  WorkerInformation: '%{worker}の情報'
+  InformationTable: 情報表
+  WorkerLog: ワーカーログ
+  WorkerTablePerDay: ワーカー表 (日)
+  LastRun: 最後の実行
+  EmptyLogs: データがありません
+  SearchLogs: ログファイルにて検索

data/lib/sidekiq/statistic/locales/pt-br.yml

@@ -0,0 +1,33 @@
+# elements like %{queue} are variables and should not be translated
+pt-br: # <---- change this to your locale code
+  Queue: Fila
+  Exclude: Excluir
+  Index: Índice
+  RealtimeStatistic: Estatística em tempo real
+  Statistic: Estatística
+  Start: Início
+  End: Fim
+  Failed: Falhou
+  Passed: Passou
+  WorkersTable: Tabela de Workers
+  Worker: Worker
+  Date: Data
+  Success: Successo
+  Failure: Falha
+  Total: Total
+  TimeSec: Tempo(s)
+  AverageSec: Média(s)
+  MinTimeSec: Tempo Min(s)
+  MaxTimeSec: Tempo Max(s)
+  LastJobStatus: Status do último trabalho
+  WorkerInformation: 'Informações do %{worker}'
+  InformationTable: Tabela de informação
+  WorkerLog: Log do Worker
+  WorkerTablePerDay: Tabela do Worker (por dia)
+  LastRun: Última execução
+  EmptyLogs: Nenhum resultado
+  SearchLogs: Pesquisar no arquivo de logs
+  date:
+    formats:
+      default: "%d/%m/%Y"
+      datetime: "%d/%m/%Y - %T"

data/lib/sidekiq/statistic/locales/ru.yml

@@ -7,21 +7,23 @@ ru: # <---- change this to your locale code
   Statistic: Статистика
   Start: Начало
   End: Конец
-  Failed: Не выполненые
-  Passed: Выполненые
+  Failed: Не выполненные
+  Passed: Выполненные
   WorkersTable: Таблица воркеров
   Worker: Воркер
   Date: Дата
   Success: Успешно
   Failure: Неудачно
-  Total: Сумарно
+  Total: Суммарно
   TimeSec: Время(сек)
-  AverageSec: Среднее(сек)
-  MinTimeSec: Мин время(сек)
-  MaxTimeSec: Макс время(сек)
+  AverageSec: Среднее время(сек)
+  MinTimeSec: 'Мин. время(сек)'
+  MaxTimeSec: 'Макс. время(сек)'
   LastJobStatus: Статус последнего джоба
   WorkerInformation: 'Информация о %{worker}'
   InformationTable: Таблица с информацией
   WorkerLog: Лог воркера
   WorkerTablePerDay: Таблица воркера (по дням)
   LastRun: Последний запуск
+  EmptyLogs: Нет результатов
+  SearchLogs: Поиск в лог-файле

data/lib/sidekiq/statistic/locales/uk.yml

@@ -0,0 +1,29 @@
+# elements like %{queue} are variables and should not be translated
+uk: # <---- change this to your locale code
+  Queue: Черга
+  Exclude: Вилучити
+  Index: Головна
+  RealtimeStatistic: Статистика у реальному часі
+  Statistic: Статистика
+  Start: Початок
+  End: Кінець
+  Failed: Невиконані
+  Passed: Виконані
+  WorkersTable: Таблиця обробників
+  Worker: Обробник
+  Date: Дата
+  Success: Успішно
+  Failure: Невдало
+  Total: Сумарно
+  TimeSec: Час(сек)
+  AverageSec: Середнє(сек)
+  MinTimeSec: Мін. час(сек)
+  MaxTimeSec: Макс. час(сек)
+  LastJobStatus: Стан останнього обробника
+  WorkerInformation: 'Інформація про %{worker}'
+  InformationTable: Таблиця з інформацією
+  WorkerLog: Журнал обробника
+  WorkerTablePerDay: Таблиця обробника (по днях)
+  LastRun: Останній запуск
+  EmptyLogs: немає результатів
+  SearchLogs: Пошук у файлі журналу

data/lib/sidekiq/statistic/log_parser.rb

@@ -1,28 +1,33 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Statistic
     # Heroku have read only file system. See more in this link:
     # https://devcenter.heroku.com/articles/read-only-filesystem
     class LogParser
-      FILE_LINES_COUNT = 1_000
+      WORKER_INFO_REGEXP_TEMPLATE = "([\\W]+|^)%{worker_name}([\\W]+|$)"
+
       def initialize(worker_name)
         @worker_name = worker_name
         @logfile = log_file
+        @worker_info_regexp = Regexp.compile(WORKER_INFO_REGEXP_TEMPLATE % { worker_name: @worker_name })
+        @jid_tag_regexp =  Regexp.compile('(JID-[\\w]+)')
       end
 
       def parse
-        return [] unless File.exists?(@logfile)
+        return [] unless File.exist?(@logfile)
 
         File
           .readlines(@logfile)
-          .first(FILE_LINES_COUNT)
-          .map{ |line| sub_line(line) if line[/\W?#@worker_name\W?/] }
+          .last(last_log_lines)
+          .map{ |line| sub_line(line) if line.match(worker_info_regexp) }
           .compact
       end
 
       def sub_line(line)
         line
           .sub(/\n/, '')
-          .sub(/(JID-[\w]+)/) { jid_tag($1) }
+          .sub(jid_tag_regexp) { jid_tag($1) }
       end
 
       def jid_tag(jid)
@@ -47,11 +52,18 @@ module Sidekiq
       end
 
     private
+
+      attr_reader :worker_info_regexp, :jid_tag_regexp
+
       def log_file
         Sidekiq.options[:logfile] ||
           Sidekiq.logger.instance_variable_get(:@logdev).filename ||
           Sidekiq::Statistic.configuration.log_file
       end
+
+      def last_log_lines
+        Sidekiq::Statistic.configuration.last_log_lines
+      end
     end
   end
 end