sonnet 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd726535211c5d03c5db6a93f14aae3121802b99a85d60ee955fe8d455c77d51
-  data.tar.gz: ff06b123ee59cd638298cf81e1f3a3394e5c43df362c81f4cca2180cf65b8baf
+  metadata.gz: 273fb36aa6154de4836aae0cb4f44ccb4b9799652f8dfebbd08a9ee04d2fa669
+  data.tar.gz: d8f9d7f79f4a5b436754c7ee7adab6d39a30440b041e306e5e37861592ba7beb
 SHA512:
-  metadata.gz: ea0b0ebf4fbbcdc71b65365b47cb259d95b4e8a17c07cb2590e6e502d8d0a71d14dd69a74f54f159da624584a153551362fa03aa892aaf137f6573ddfe6236e3
-  data.tar.gz: 5c6d8c066d1c9daf4c7f611458b905a0018251efb1006a9f4b90d4c8ad995fc99edb64b710df55698a1bc364919e3d6f6eba4323a30bb4194fb976c894dacb02
+  metadata.gz: d4ec687ec2c6e93d459a30065d6c4849dff9533cca1dbd6861c9cf18591b490b52e0f250d9e07e4c107d543b83546afb0160f4a23d0ff8ccc2b6663a09c477c5
+  data.tar.gz: 83305c920737815295ddfc792ae7b979247d3b334a848ff726afa1ea2e16ff73974be8d53513bc9376a5c38235cb7de44b025d4aa02c857bcbd42b8ab33af850

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sonnet (0.1.3)
+    sonnet (0.1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,11 @@
 # Sonnet
 
-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/sonnet`. To experiment with that code, run `bin/console` for an interactive prompt.
+Structured logging for Ruby applications.
 
-TODO: Delete this and the text above, and describe your gem
+## Alternatives
+
+* [Ougai](https://github.com/tilfin/ougai)
+* [Semantic Logger](https://github.com/rocketjob/semantic_logger)
 
 ## Installation
 
@@ -22,13 +25,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-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.
-
-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).
+```ruby
+require "sonnet"
+logger = Logger.new(STDOUT)
+logger.extend(Sonnet::Logger)
+```
 
 ## Contributing
 

data/examples/sidekiq.rb

@@ -0,0 +1,41 @@
+require "sidekiq/job_logger"
+
+module SidekiqLogging
+  def self.job_context(job_hash)
+    {
+      worker_class: job_hash["wrapped"] || job_hash["class"],
+      jid: job_hash["jid"]
+    }
+  end
+
+  class JobLogger < Sidekiq::JobLogger
+    def call(job_hash, queue, &block)
+      Sidekiq.logger.with_context(SidekiqLogging.job_context(job_hash)) do
+        begin
+          start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+          Sidekiq.logger.debug(message: "start")
+          yield
+          Sidekiq.logger.debug(message: "done", duration: elapsed(start))
+        rescue
+          Sidekiq.logger.debug(message: "failure", duration: elapsed(start))
+          raise
+        end
+      end
+    end
+  end
+
+  class ErrorHandler
+    def call(exception, context_hash)
+      Sidekiq.logger.with_context(SidekiqLogging.job_context(context_hash[:job])) do
+        Sidekiq.logger.warn(exception)
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  Sidekiq::Logging.logger = Rails.logger
+  config.options[:job_logger] = SidekiqLogging::JobLogger
+  config.error_handlers.pop
+  config.error_handlers << SidekiqLogging::ErrorHandler.new
+end

data/lib/sonnet.rb

@@ -4,7 +4,5 @@ require "sonnet/formatter"
 require "sonnet/logger"
 require "sonnet/version"
 
-require "json"
-
 module Sonnet
 end

data/lib/sonnet/formatter.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require "sonnet/serializer"
+require "json"
+require "time"
 
 module Sonnet
   class Formatter
-    TIMESTAMP_FORMAT = "%FT%T.%LZ"
-
     def self.call(severity, time, progname, data)
       new(severity, time, progname, data).to_json
     end
@@ -26,13 +25,13 @@ module Sonnet
     end
 
     def timestamp
-      (@time || Time.now).utc.strftime(TIMESTAMP_FORMAT)
+      (@time || Time.now).utc.iso8601(3)
     end
 
     def data
       case @data
       when Exception
-        Serializer.serialize_exception(@data)
+        serialize_exception(@data)
       when Hash
         @data
       else
@@ -40,16 +39,18 @@ module Sonnet
       end
     end
 
-    def application_context
+    def serialize_exception(exception)
       {
-        program: program,
-        # hostname: hostname,
-        level: level,
-        timestamp: timestamp,
-        pid: pid
+        kind: exception.class.name,
+        message: exception.to_s,
+        stack: exception.backtrace&.slice(0, 3)
       }
     end
 
+    def serialize_string(string)
+      { message: string.to_s }
+    end
+
     def context
       self.class.current_context.inject({}, &:merge)
     end
@@ -62,16 +63,18 @@ module Sonnet
     #   @hostname || Socket.gethostname.force_encoding('UTF-8')
     # end
 
-    def serialize_string(string)
-      { message: string.to_s }
-    end
-
     def pid
       $$
     end
 
     def as_json
-      context.merge(data).merge(application_context).compact
+      {
+        program: program,
+        # hostname: hostname,
+        level: level,
+        timestamp: timestamp,
+        pid: pid
+      }.merge(data).merge(context).compact
     end
 
     def to_json

data/lib/sonnet/version.rb

@@ -1,3 +1,3 @@
 module Sonnet
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/sonnet.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Cory Kaufman-Schofield"]
   spec.email = ["cory@corykaufman.com"]
 
-  spec.summary = "Structured logs for Ruby applications"
-  spec.description = "Structured logs for Ruby applications"
+  spec.summary = "Structured logging for Ruby applications"
+  spec.description = "Structured logging for Ruby applications"
   spec.homepage = "https://github.com/allspiritseve/sonnet"
   spec.license = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonnet
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Cory Kaufman-Schofield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Structured logs for Ruby applications
+description: Structured logging for Ruby applications
 email:
 - cory@corykaufman.com
 executables: []
@@ -81,14 +81,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/sidekiq.rb
 - lib/sonnet.rb
 - lib/sonnet/formatter.rb
 - lib/sonnet/logger.rb
 - lib/sonnet/monkeypatch.rb
 - lib/sonnet/rails.rb
-- lib/sonnet/serializer.rb
-- lib/sonnet/sidekiq/exception_handler.rb
-- lib/sonnet/sidekiq/job_logger.rb
 - lib/sonnet/version.rb
 - sonnet.gemspec
 - test/sonnet_test.rb
@@ -116,5 +114,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Structured logs for Ruby applications
+summary: Structured logging for Ruby applications
 test_files: []

data/lib/sonnet/serializer.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Sonnet
-  module Serializer
-    def self.serialize_exception(exception)
-      {
-        kind: exception.class.name,
-        message: exception.to_s,
-        stack: exception.backtrace&.slice(0, 3)
-      }
-    end
-  end
-end

data/lib/sonnet/sidekiq/exception_handler.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/exception_handler"
-require "sonnet/serializer"
-
-module Sonnet
-  module Sidekiq
-    module ExceptionHandler
-      def self.extended(base)
-        ::Sidekiq::ExceptionHandler::Logger.prepend(Logger)
-      end
-
-      module Logger
-        def call(ex, ctxHash)
-          ::Sidekiq.logger.warn(
-            exception: ex,
-            message: ctxHash["context"],
-            job: ctxHash[:job]
-          )
-        end
-      end
-    end
-  end
-end

data/lib/sonnet/sidekiq/job_logger.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/job_logger"
-
-module Sonnet
-  module Sidekiq
-    class JobLogger < ::Sidekiq::JobLogger
-      def call(item, queue)
-        ::Sidekiq::Logging.with_context(source: item['class']) do
-          begin
-            start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-            logger.debug(message: "start")
-            yield
-            logger.debug(message: "done", duration: elapsed(start))
-          rescue
-            logger.debug(message: "failure", duration: elapsed(start))
-            raise
-          end
-        end
-      end
-    end
-  end
-end