sidekiq-ichnite 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +9 -0
  3. data/.travis.yml +5 -0
  4. data/Gemfile +4 -0
  5. data/LICENSE.txt +21 -0
  6. data/README.md +40 -0
  7. data/Rakefile +10 -0
  8. data/bin/console +14 -0
  9. data/bin/setup +8 -0
  10. data/lib/sidekiq-ichnite.rb +26 -0
  11. data/lib/sidekiq-ichnite/middleware.rb +103 -0
  12. data/lib/sidekiq-ichnite/version.rb +5 -0
  13. data/sidekiq-ichnite.gemspec +30 -0
  14. metadata +127 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: cd4229c46a73da8139a3fe2117c15388cf3e20d9
4
+ data.tar.gz: 9132cb8f8fe469b5fd98b06d5f98b4fe19ea6fe3
5
+ SHA512:
6
+ metadata.gz: 2a7a0ac850ec0c4214655e41101c1312d1b106b24e97de93abb95344e70c8f8399f78ad2490922833b351f09b0e263e92d9fffd7515cc2411a223e603d09cd91
7
+ data.tar.gz: d5b4c8464daeb1682934bdad47221fbc0e0238768d27d59dad5dd8812f54dcca3b73165a969a059382816bc49059b2edd3492e947c2551696e2997012f50216c
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in sidekiq-ichnite.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Yves Senn
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,40 @@
1
+ # Sidekiq::Ichnite
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq-ichnite`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'sidekiq-ichnite'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install sidekiq-ichnite
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-ichnite.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "sidekiq-ichnite"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/sidekiq-ichnite.rb ADDED
@@ -0,0 +1,26 @@
1
+ require_relative 'sidekiq-ichnite/middleware'
2
+
3
+ Sidekiq::Logging.logger.level = Logger::WARN
4
+
5
+ Sidekiq.configure_server do |config|
6
+ # Remove Sidekiqs default backtrace logging
7
+ if !defined?(Rails) || Rails.env.production?
8
+ config.error_handlers.delete_if { |h| Sidekiq::ExceptionHandler::Logger === h }
9
+ end
10
+ end
11
+
12
+ Sidekiq.configure_client do |config|
13
+ config.client_middleware do |chain|
14
+ chain.add Sidekiq::Ichnite::ClientMiddleware
15
+ end
16
+ end
17
+
18
+ Sidekiq.configure_server do |config|
19
+ config.client_middleware do |chain|
20
+ chain.add Sidekiq::Ichnite::ClientMiddleware
21
+ end
22
+
23
+ config.server_middleware do |chain|
24
+ chain.add Sidekiq::Ichnite::ServerMiddleware
25
+ end
26
+ end
data/lib/sidekiq-ichnite/middleware.rb ADDED
@@ -0,0 +1,103 @@
1
+ module Sidekiq
2
+ module Ichnite
3
+ def self.job_id(msg)
4
+ msg['jid']
5
+ end
6
+
7
+ def self.job_class(msg)
8
+ aj_job_class(msg) || msg['class']
9
+ end
10
+
11
+ def self.aj_job_class(msg)
12
+ msg['wrapped']
13
+ end
14
+
15
+ def self.job_args(msg)
16
+ args = msg['args']
17
+ aj_job_args(args) || args
18
+ end
19
+
20
+ def self.aj_job_args(args)
21
+ first_arg = args.first
22
+
23
+ # check if the first argument looks like a AJ metadata hash
24
+ if first_arg.is_a?(Hash) && first_arg.key?('arguments')
25
+ first_arg['arguments'].map do |arg|
26
+ if arg.is_a?(Hash) && arg.key?('_aj_globalid')
27
+ arg['_aj_globalid']
28
+ else
29
+ arg
30
+ end
31
+ end
32
+ end
33
+ end
34
+
35
+ class ClientMiddleware
36
+ def call(worker_class, msg, queue, _redis_pool)
37
+ context = {
38
+ queue: queue,
39
+ job_class: Sidekiq::Ichnite.job_class(msg),
40
+ job_id: Sidekiq::Ichnite.job_id(msg)
41
+ }
42
+ if at = msg['at']
43
+ context[:scheduled_at] = Time.at(at).utc
44
+ ::Ichnite.log('job_schedule', context)
45
+ else
46
+ context[:args] = Sidekiq::Ichnite.job_args(msg)
47
+ ::Ichnite.log('job_enqueue', context)
48
+ end
49
+ yield
50
+ end
51
+ end
52
+
53
+ class ServerMiddleware
54
+ def call(worker, msg, queue)
55
+ Ichnite.enter(
56
+ job_id: Sidekiq::Ichnite.job_id(msg),
57
+ job_class: Sidekiq::Ichnite.job_class(msg)) do
58
+ begin
59
+ context = { queue: queue }
60
+
61
+ ts = Time.now.to_f
62
+ # We are currently not logging start events.
63
+ # This would most likely blow our SumoLogic limit.
64
+ # start context, ts
65
+ yield
66
+ stop context, msg, ts
67
+ rescue => ex
68
+ error context, ex, ts
69
+ raise ex
70
+ end
71
+ end
72
+ end
73
+
74
+ def start(context, _time)
75
+ ::Ichnite.log('job_start', context)
76
+ end
77
+
78
+ def error(context, error, start)
79
+ data = context.merge(
80
+ at: :error,
81
+ duration: duration_ms(start),
82
+ error: error.class.name,
83
+ message: error.message[/\A.+$/].inspect)
84
+ ::Ichnite.log('job_error', data)
85
+ end
86
+
87
+ def stop(context, _msg, start)
88
+ data = context.merge(
89
+ # It looks like this number is subject to clock drift.
90
+ # TODO: Figure out a way to make this accurate.
91
+ # queued_duration: duration_ms(msg['enqueued_at'], start),
92
+ duration: duration_ms(start))
93
+
94
+ ::Ichnite.log('job_stop', data)
95
+ end
96
+
97
+ def duration_ms(from, to = Time.now.to_f)
98
+ ((to - from) * 1000).round
99
+ end
100
+ end
101
+
102
+ end
103
+ end
data/lib/sidekiq-ichnite/version.rb ADDED
@@ -0,0 +1,5 @@
1
+ module Sidekiq
2
+ module Ichnite
3
+ VERSION = "0.0.3"
4
+ end
5
+ end
data/sidekiq-ichnite.gemspec ADDED
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'sidekiq-ichnite/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "sidekiq-ichnite"
8
+ spec.version = Sidekiq::Ichnite::VERSION
9
+ spec.authors = ["Yves Senn"]
10
+ spec.email = ["[email protected]"]
11
+
12
+ spec.summary = %q{Structured logging for Sidekiq}
13
+ spec.description = %q{Implement a structured logging approach for sidekiq.}
14
+ spec.homepage = "https://github.com/senny/sidekiq-ichnite"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "ichnite"
25
+ spec.add_dependency "sidekiq"
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.13"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "minitest", "~> 5.0"
30
+ end
metadata ADDED
@@ -0,0 +1,127 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sidekiq-ichnite
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.3
5
+ platform: ruby
6
+ authors:
7
+ - Yves Senn
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-10-24 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: ichnite
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: sidekiq
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.13'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.13'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: minitest
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '5.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '5.0'
83
+ description: Implement a structured logging approach for sidekiq.
84
+ email:
85
+ - [email protected]
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".travis.yml"
92
+ - Gemfile
93
+ - LICENSE.txt
94
+ - README.md
95
+ - Rakefile
96
+ - bin/console
97
+ - bin/setup
98
+ - lib/sidekiq-ichnite.rb
99
+ - lib/sidekiq-ichnite/middleware.rb
100
+ - lib/sidekiq-ichnite/version.rb
101
+ - sidekiq-ichnite.gemspec
102
+ homepage: https://github.com/senny/sidekiq-ichnite
103
+ licenses:
104
+ - MIT
105
+ metadata: {}
106
+ post_install_message:
107
+ rdoc_options: []
108
+ require_paths:
109
+ - lib
110
+ required_ruby_version: !ruby/object:Gem::Requirement
111
+ requirements:
112
+ - - ">="
113
+ - !ruby/object:Gem::Version
114
+ version: '0'
115
+ required_rubygems_version: !ruby/object:Gem::Requirement
116
+ requirements:
117
+ - - ">="
118
+ - !ruby/object:Gem::Version
119
+ version: '0'
120
+ requirements: []
121
+ rubyforge_project:
122
+ rubygems_version: 2.5.1
123
+ signing_key:
124
+ specification_version: 4
125
+ summary: Structured logging for Sidekiq
126
+ test_files: []
127
+ has_rdoc:
OSZAR »