semlogr-sinks-seq 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: be108635842d0272886fa9f86981c5bfceffdbd3583f22dda283bdf40fbc220e
-  data.tar.gz: d2284aea604a7a9bfe929ff49b2f3e00c1245d0c299a6ea1af6056d2c6a2af97
+SHA1:
+  metadata.gz: e6948bb4d0f7e5e84c57a76c73337f619962ea85
+  data.tar.gz: 9bfb3372a548cff950d8e6bace8da7250ca48967
 SHA512:
-  metadata.gz: e048c37bed8374cd78d78c8f8aa637d3aeb669928010fd1de15b716f767d209e38d162a859f724f2b11b20badad92c6512667e963f3c654051ba5abd00c3deaf
-  data.tar.gz: f7a11437f867d83f37a06fc347134182d12c49ddae874438892b05e9babd9879cc8bbc8f98286440eb83835755d69ed86224726e827d416eaf352725da65ceb4
+  metadata.gz: 5bb061971f2c955541f9a79891567f4fbc24a6a7ca79b3f75d0c415b0d6e9b48a5f9a2dc2350f668a6335ec6b28cd7a2dccda8e50faf34d2c9b4c05967400164
+  data.tar.gz: e9355726bc151cd433eca847bcfd89e812dc44a0aac5d2cb7d422b277189eeb93cee79a4ac2920f7a015476755a1a12e7072479f68b45e0ae7e740ba8728c794

data/CHANGELOG.md

@@ -1,17 +1,10 @@
 # Changelog
 
-### 0.2.1
-
-- Use new semlogr component registry
-
-### 0.1.3
-
-- Rubocop update (nothing useful)
-
-### 0.1.2
+### 0.1.1
 
-- Remove dependency on logstash-logger and implement connection and queue using ruby-stud
+- Add clef formatter instead of tacking onto existing JSON formatter
+- Adding support to flush buffer on application exit so that we don't lose messages
 
-### 0.1.1
+### 0.1.0
 
 - Initial release

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Semlogr
+
+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/lib/semlogr/sinks/seq/clef_formatter.rb

@@ -0,0 +1,45 @@
+module Semlogr
+  module Sinks
+    module Seq
+      class ClefFormatter
+        def initialize(opts = {})
+          default_opts = {
+            mode: :custom,
+            time_format: :ruby,
+            use_to_json: true
+          }
+
+          @opts = default_opts.merge(opts)
+        end
+
+        def format(log_event)
+          event = {
+            '@t' => log_event.timestamp.iso8601(3),
+            '@l' => log_event.severity.to_s,
+            '@mt' => log_event.template.text
+          }
+
+          add_error(event, log_event.error)
+          add_properties(event, log_event.properties)
+
+          event_json = Oj.dump(event, @opts)
+          "#{event_json}\n"
+        end
+
+        private
+
+        def add_error(event, error)
+          return unless error
+          event['@x'] = "#{error[:type]}: #{error[:message]}"
+
+          return unless error[:backtrace] && error[:backtrace].any?
+          event['@x'] += "\n\s\s#{error[:backtrace].join("\n\s\s")}"
+        end
+
+        def add_properties(event, properties)
+          event.merge!(properties) { |_, old, _| old }
+        end
+      end
+    end
+  end
+end

data/lib/semlogr/sinks/seq/sink.rb

@@ -1,5 +1,6 @@
+require 'timeout'
 require 'stud/buffer'
-require 'semlogr/formatters/json_formatter'
+require 'semlogr/sinks/seq/clef_formatter'
 require 'semlogr/sinks/seq/seq_api'
 
 module Semlogr
@@ -8,11 +9,13 @@ module Semlogr
       class Sink
         include Stud::Buffer
 
-        def initialize(opts = {})
-          @options = opts
-          @formatter = Formatters::JsonFormatter.new
-          @client = create_client(opts)
+        def initialize(client: nil, formatter: nil, **opts)
+          opts = default_opts.merge(opts)
 
+          @client = client || create_client(opts)
+          @formatter = formatter || ClefFormatter.new
+
+          exit_handler_initialize(opts)
           buffer_initialize(opts)
         end
 
@@ -24,18 +27,7 @@ module Semlogr
           payload = ''
 
           log_events.each do |log_event|
-            payload << @formatter.format(log_event) do |event|
-              seq_event = event[:properties] || {}
-              seq_event = seq_event.merge(
-                '@t' => event[:timestamp],
-                '@l' => event[:severity],
-                '@mt' => event[:message_template]
-              )
-
-              add_error(seq_event, event[:error])
-
-              seq_event
-            end
+            payload << @formatter.format(log_event)
           end
 
           @client.post_events(payload)
@@ -43,20 +35,28 @@ module Semlogr
 
         private
 
+        def default_opts
+          {
+            flush_at_exit: true,
+            flush_at_exit_timeout: 10
+          }
+        end
+
+        def exit_handler_initialize(opts)
+          return unless opts[:flush_at_exit]
+
+          at_exit do
+            flush_timeout = opts[:flush_at_exit_timeout]
+            Timeout.timeout(flush_timeout) { buffer_flush(final: true) }
+          end
+        end
+
         def create_client(opts)
           server_url = opts.fetch(:server_url, 'http://localhost:5341')
           api_key = opts.fetch(:api_key, nil)
 
           SeqApi.new(server_url, api_key)
         end
-
-        def add_error(seq_event, error)
-          return unless error
-          seq_event['@x'] = "#{error[:type]}: #{error[:message]}"
-
-          return unless error[:backtrace] && error[:backtrace].any?
-          seq_event['@x'] += "\n\s\s#{error[:backtrace].join("\n\s\s")}"
-        end
       end
     end
   end

data/lib/semlogr/sinks/seq/version.rb

@@ -1,7 +1,7 @@
 module Semlogr
   module Sinks
     module Seq
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.1'.freeze
     end
   end
 end

data/semlogr-sinks-seq.gemspec

@@ -1,5 +1,6 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'semlogr/sinks/seq/version'
 
 Gem::Specification.new do |spec|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semlogr-sinks-seq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stefan Sedich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -135,11 +135,13 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/semlogr/sinks/seq.rb
+- lib/semlogr/sinks/seq/clef_formatter.rb
 - lib/semlogr/sinks/seq/seq_api.rb
 - lib/semlogr/sinks/seq/sink.rb
 - lib/semlogr/sinks/seq/version.rb
@@ -163,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A semlogr sink for logging to seq.