logstash-logger 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '02946cc68ecd472a33ee4e20c8b0f9676a35c31e'
-  data.tar.gz: 22ebacf159993cebd61ec2f2069c5d35ccb5949e
+  metadata.gz: 2f81edad89b077de5fa36b1b1291f6b0d1c66761
+  data.tar.gz: 9834bb9837f9b9d6672f6a24b0325e3d2d9098ef
 SHA512:
-  metadata.gz: d19465ebd83bb4a0710eac75face6c11287c5737fc8683e79e5b725cd81933082d123d0bcf220ab49b267c693b98f6bffc5300c7c6ceae7a0ad7b350654c3fe6
-  data.tar.gz: f1be1a3735cd768d7c53b5d9cdddb34a3fde4e76d0cc6b770f731a70cd5129d1278bd21017634c9af25c99593d7f006d3d9ed2646a4faf7c84e8e454b85a00d8
+  metadata.gz: 49afad48b880a4c98156de108ad9f3105ed3ecf72e38d24987d08027d56ecdc2147c4b46fe0fb9d59799fdfbf44af7218e70e9185470f0f046e89921976afed1
+  data.tar.gz: 7274f69bc942ee4c2597682cde7f818c6da371bc58108ef56b2e3002b854e7142f241529003f5ed4f7c2001b35364e23f62572b70430ef9971131088c44a7b71

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.26.0
+
+- Allow user configuration of the logger class. [#129](https://github.com/dwbutler/logstash-logger/pull/129)
+- Fix: Allow type to be a string for multi_logger and syslog. [#131](https://github.com/dwbutler/logstash-logger/pull/131)
+- Fix: Cancelled events are being logged. [#133](https://github.com/dwbutler/logstash-logger/issues/133)
+- Fix: Expose method to reset logger state. [#138](https://github.com/dwbutler/logstash-logger/pull/138)
+- Use specific AWS SDK gems. [#136](https://github.com/dwbutler/logstash-logger/pull/136)
+- Adds support for using the default AWS credential provider chain. [#141](https://github.com/dwbutler/logstash-logger/pull/141)
+
 ## 0.25.1
 
 - Skip message truncating when there is no message field. [#130](https://github.com/dwbutler/logstash-logger/pull/130)

data/README.md

@@ -399,6 +399,15 @@ logger.silence(temporary_level) do
 end
 ```
 
+## Custom Logger Class
+
+By default, LogStashLogger creates a logger that extends Ruby's built in `Logger` class.
+If you require a different logger implementation, you can use a different class
+by passing in the class with the `logger_class` option.
+
+Note that for syslog, the `Syslog::Logger` class is required and cannot be
+changed.
+
 ## Rails Integration
 
 Supports Rails 4 and 5.
@@ -559,6 +568,10 @@ config.logstash.backoff = 1
 
 Add the aws-sdk gem to your Gemfile:
 
+    # aws-sdk >= 3.0
+    gem 'aws-sdk-kinesis'
+
+    # aws-sdk < 3.0
     gem 'aws-sdk'
 
 ```ruby
@@ -583,6 +596,10 @@ config.logstash.aws_secret_access_key = 'ASKASKHLD1234123412341234'
 
 Add the aws-sdk gem to your Gemfile:
 
+    # aws-sdk >= 3.0
+    gem 'aws-sdk-firehose'
+
+    # aws-sdk < 3.0
     gem 'aws-sdk'
 
 ```ruby
@@ -592,13 +609,13 @@ config.logstash.type = :firehose
 # Optional, will default to the 'logstash' delivery stream
 config.logstash.stream = 'my-stream-name'
 
-# Optional, will default to 'us-east-1'
+# Optional, will default to AWS default region config chain
 config.logstash.aws_region = 'us-west-2'
 
-# Optional, will default to the AWS_ACCESS_KEY_ID environment variable
+# Optional, will default to AWS default credential provider chain
 config.logstash.aws_access_key_id = 'ASKASKHLD12341'
 
-# Optional, will default to the AWS_SECRET_ACCESS_KEY environment variable
+# Optional, will default to AWS default credential provider chain
 config.logstash.aws_secret_access_key = 'ASKASKHLD1234123412341234'
 
 ```
@@ -693,6 +710,36 @@ def track_load_balancer_session_id
 end
 ```
 
+## Cleaning up resources when forking
+
+If your application forks (as is common with many web servers) you will need to
+manage cleaning up resources on your LogStashLogger instances. The instance method
+`#reset` is available for this purpose. Here is sample configuration for
+several common web servers used with Rails:
+
+Passenger:
+```ruby
+::PhusionPassenger.on_event(:starting_worker_process) do |forked|
+  Rails.logger.reset
+end
+```
+
+Puma:
+```ruby
+# In config/puma.rb
+on_worker_boot do
+  Rails.logger.reset
+end
+```
+
+Unicorn
+```ruby
+# In config/unicorn.rb
+after_fork do |server, worker|
+  Rails.logger.reset
+end
+```
+
 ## Ruby Compatibility
 
 Verified to work with:
@@ -818,6 +865,11 @@ logger = LogStashLogger.new('localhost', 5228, :tcp)
 * [Joao Fernandes](https://github.com/jcmfernandes)
 * [CoolElvis](https://github.com/coolelvis)
 * [Sergey Pyankov](https://github.com/esergion)
+* [Alec Hoey](https://github.com/alechoey)
+* [Alexey Krasnoperov](https://github.com/AlexeyKrasnoperov)
+* [Gabriel de Oliveira](https://github.com/gdeoliveira)
+* [Vladislav Syabruk](https://github.com/SeTeM)
+* [Matus Vacula](https://github.com/matus-vacula)
 
 ## Contributing
 

data/lib/logstash-logger/buffer.rb

@@ -107,6 +107,8 @@ module LogStashLogger
     end
 
     def reset_buffer
+      reset_flush_timer_thread
+
       @buffer_state = {
         # items accepted from including class
         :pending_items => {},
@@ -127,7 +129,6 @@ module LogStashLogger
         :timer =>          flush_timer_thread
       }
 
-
       # events we've accumulated
       buffer_clear_pending
     end
@@ -305,6 +306,13 @@ module LogStashLogger
         end
     end
 
+    def reset_flush_timer_thread
+      unless @flush_timer_thread.nil?
+        @flush_timer_thread.kill
+        @flush_timer_thread = nil
+      end
+    end
+
     def buffer_clear_pending
       @buffer_state[:pending_items] = Hash.new { |h, k| h[k] = [] }
       @buffer_state[:pending_count] = 0

data/lib/logstash-logger/device/aws_stream.rb

@@ -1,10 +1,13 @@
-require 'aws-sdk'
+begin
+  require 'aws-sdk-core'
+rescue LoadError
+  require 'aws-sdk'
+end
 
 module LogStashLogger
   module Device
     class AwsStream < Connectable
 
-      DEFAULT_REGION = 'us-east-1'
       DEFAULT_STREAM = 'logstash'
 
       @stream_class = nil
@@ -18,9 +21,9 @@ module LogStashLogger
 
       def initialize(opts)
         super
-        @access_key_id = opts[:aws_access_key_id] || ENV['AWS_ACCESS_KEY_ID']
-        @secret_access_key = opts[:aws_secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
-        @aws_region = opts[:aws_region] || DEFAULT_REGION
+        @access_key_id = opts[:aws_access_key_id]
+        @secret_access_key = opts[:aws_secret_access_key]
+        @aws_region = opts[:aws_region]
         @stream = opts[:stream] || DEFAULT_STREAM
       end
 
@@ -41,10 +44,10 @@ module LogStashLogger
       end
 
       def connect
-        @io = self.class.stream_class.new(
-          region: @aws_region,
-          credentials: ::Aws::Credentials.new(@access_key_id, @secret_access_key)
-        )
+        client_opts = {}
+        client_opts[:credentials] = Aws::Credentials.new(@access_key_id, @secret_access_key) unless @access_key_id == nil || @secret_access_key == nil
+        client_opts[:region] = @aws_region unless @aws_region == nil
+        @io = self.class.stream_class.new(client_opts)
       end
 
       def with_connection

data/lib/logstash-logger/device/base.rb

@@ -15,7 +15,7 @@ module LogStashLogger
       end
 
       def write(message)
-        write_one(message)
+        write_one(message) unless message.nil?
       end
 
       def write_one(message)
@@ -39,6 +39,10 @@ module LogStashLogger
         @io && @io.flush
       end
 
+      def reset
+        close
+      end
+
       def close(opts = {})
         close!
       rescue => e

data/lib/logstash-logger/device/connectable.rb

@@ -56,7 +56,7 @@ module LogStashLogger
       end
 
       def write(message)
-        buffer_receive message, @buffer_group
+        buffer_receive(message, @buffer_group) unless message.nil?
       end
 
       def flush(*args)
@@ -107,6 +107,11 @@ module LogStashLogger
         fail NotImplementedError
       end
 
+      def reset
+        reset_buffer
+        close(flush: false)
+      end
+
       def reconnect
         close(flush: false)
         connect

data/lib/logstash-logger/device/firehose.rb

@@ -1,4 +1,9 @@
-require 'aws-sdk'
+begin
+  require 'aws-sdk-firehose'
+rescue LoadError
+  require 'aws-sdk'
+end
+
 require 'logstash-logger/device/aws_stream'
 
 module LogStashLogger

data/lib/logstash-logger/device/kinesis.rb

@@ -1,4 +1,9 @@
-require 'aws-sdk'
+begin
+  require 'aws-sdk-kinesis'
+rescue LoadError
+  require 'aws-sdk'
+end
+
 require 'logstash-logger/device/aws_stream'
 
 module LogStashLogger

data/lib/logstash-logger/formatter/base.rb

@@ -14,11 +14,12 @@ module LogStashLogger
         super()
       end
 
-      def call(severity, time, progname, message)
-        @event = build_event(message, severity, time)
+      def call(severity, time, _progname, message)
+        event = build_event(message, severity, time)
+        format_event(event) unless event.cancelled?
       end
 
-      protected
+      private
 
       def build_event(message, severity, time)
         data = message
@@ -63,6 +64,10 @@ module LogStashLogger
 
         event
       end
+
+      def format_event(event)
+        event
+      end
     end
   end
 end

data/lib/logstash-logger/formatter/cee.rb

@@ -1,9 +1,10 @@
 module LogStashLogger
   module Formatter
     class Cee < Base
-      def call(severity, time, progname, message)
-        super
-        "@cee:#{@event.to_json}"
+      private
+
+      def format_event(event)
+        "@cee:#{event.to_json}"
       end
     end
   end

data/lib/logstash-logger/formatter/cee_syslog.rb

@@ -2,18 +2,20 @@ module LogStashLogger
   module Formatter
     class CeeSyslog < Cee
       def call(severity, time, progname, message)
-        @cee = super
         @progname = progname
-
-        "#{facility}:#{@cee}\n"
+        super
       end
 
-      protected
+      private
+
+      def build_facility(host)
+        facility = host.dup
+        facility << " #{@progname}" if @progname
+        facility
+      end
 
-      def facility
-        @facility = "#{@event['host']}"
-        @facility << " #{@progname}" if @progname
-        @facility
+      def format_event(event)
+        "#{build_facility(event["host".freeze])}:#{super}\n"
       end
     end
   end

data/lib/logstash-logger/formatter/json.rb

@@ -1,9 +1,10 @@
 module LogStashLogger
   module Formatter
     class Json < Base
-      def call(severity, time, progname, message)
-        super
-        @event.to_json
+      private
+
+      def format_event(event)
+        event.to_json
       end
     end
   end

data/lib/logstash-logger/formatter/json_lines.rb

@@ -1,9 +1,10 @@
 module LogStashLogger
   module Formatter
     class JsonLines < Base
-      def call(severity, time, progname, message)
-        super
-        "#{@event.to_json}\n"
+      private
+
+      def format_event(event)
+        "#{event.to_json}\n"
       end
     end
   end

data/lib/logstash-logger/formatter/logstash_event.rb

@@ -1,9 +1,6 @@
 module LogStashLogger
   module Formatter
     class LogStashEvent < Base
-      def call(severity, time, progname, message)
-        super
-      end
     end
   end
 end

data/lib/logstash-logger/logger.rb

@@ -19,6 +19,10 @@ module LogStashLogger
       def flush
         !!(@device.flush if @device.respond_to?(:flush))
       end
+
+      def reset
+        @device.reset if @device.respond_to?(:reset)
+      end
     end
   end
 
@@ -48,7 +52,8 @@ module LogStashLogger
   def self.build_logger(opts)
     formatter = Formatter.new(opts.delete(:formatter), customize_event: opts.delete(:customize_event))
 
-    logger = case opts[:type]
+    logger_type = opts[:type].to_s.to_sym
+    logger = case logger_type
     when :multi_logger
       build_multi_logger(opts)
     when :syslog
@@ -64,8 +69,9 @@ module LogStashLogger
   private
 
   def self.build_default_logger(opts)
+    logger_class = opts.delete(:logger_class) || ::Logger
     device = Device.new(opts)
-    ::Logger.new(device).tap do |logger|
+    logger_class.new(device).tap do |logger|
       logger.instance_variable_set(:@device, device)
       extend_logger(logger)
     end

data/lib/logstash-logger/version.rb

@@ -1,3 +1,3 @@
 module LogStashLogger
-  VERSION = "0.25.1"
+  VERSION = "0.26.0"
 end

data/logstash-logger.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'wwtd'
   gem.add_development_dependency 'appraisal'
+  gem.add_development_dependency 'rubocop'
 end

data/spec/constructor_spec.rb

@@ -1,22 +1,30 @@
 require 'logstash-logger'
 
 describe LogStashLogger do
-  describe ".new" do
-    it "returns a Logger instance" do
+  describe '.new' do
+    it 'returns a Logger instance' do
       expect(LogStashLogger.new(type: :stdout)).to be_a ::Logger
     end
 
-    context "type: :multi_logger" do
+    context 'type: :multi_logger' do
       it "returns an instance of LogStashLogger::MultiLogger" do
         expect(LogStashLogger.new(type: :multi_logger)).to be_a LogStashLogger::MultiLogger
       end
 
-      it "merges top level configuration into each logger" do
+      it 'merges top level configuration into each logger' do
         logger = LogStashLogger.new(type: :multi_logger, port: 1234, outputs: [ { type: :tcp  }, { type: :udp } ])
         logger.loggers.each do |logger|
           expect(logger.device.port).to eq(1234)
         end
       end
     end
+
+    context 'logger_class: CustomLogger' do
+      class CustomLogger < Logger; end
+
+      it 'should create a logger of the specified class' do
+        expect(LogStashLogger.new(type: :stdout, :logger_class => CustomLogger)).to be_a CustomLogger
+      end
+    end
   end
 end

data/spec/device/firehose_spec.rb

@@ -1,6 +1,6 @@
 require 'logstash-logger'
 
-describe LogStashLogger::Device::Kinesis do
+describe LogStashLogger::Device::Firehose do
   include_context 'device'
 
   let(:client) { double("Aws::Firehose::Client") }
@@ -35,10 +35,6 @@ describe LogStashLogger::Device::Kinesis do
     firehose_device.write_one "foo"
   end
 
-  it "defaults the AWS region to us-east-1" do
-    expect(firehose_device.aws_region).to eq('us-east-1')
-  end
-
   it "defaults the Firehose stream to logstash" do
     expect(firehose_device.stream).to eq('logstash')
   end

data/spec/device/kinesis_spec.rb

@@ -35,10 +35,6 @@ describe LogStashLogger::Device::Kinesis do
     kinesis_device.write_one "foo"
   end
 
-  it "defaults the AWS region to us-east-1" do
-    expect(kinesis_device.aws_region).to eq('us-east-1')
-  end
-
   it "defaults the kinesis stream to logstash" do
     expect(kinesis_device.stream).to eq('logstash')
   end

data/spec/formatter/base_spec.rb

@@ -3,6 +3,28 @@ require 'logstash-logger'
 describe LogStashLogger::Formatter::Base do
   include_context "formatter"
 
+  describe "#call" do
+    context "when event is not cancelled" do
+      it "returns a formatted message" do
+        expect(subject).to receive(:format_event).once.with(instance_of(LogStash::Event)).and_call_original
+        expect(subject.call(severity, time, progname, message)).to be_a(LogStash::Event)
+      end
+    end
+
+    context "when event is cancelled" do
+      before(:each) do
+        LogStashLogger.configure do |config|
+          config.customize_event(&:cancel)
+        end
+      end
+
+      it "returns `nil`" do
+        expect(subject).not_to receive(:format_event)
+        expect(subject.call(severity, time, progname, message)).to be_nil
+      end
+    end
+  end
+
   describe "#build_event" do
     let(:event) { formatted_message }
 

data/spec/formatter/cee_syslog_spec.rb

@@ -7,7 +7,7 @@ describe LogStashLogger::Formatter::CeeSyslog do
     let(:facility) { "facility" }
 
     before do
-      allow(subject).to receive(:facility).and_return(facility)
+      allow(subject).to receive(:build_facility).and_return(facility)
     end
 
     it "outputs a facility before the @cee" do
@@ -21,7 +21,7 @@ describe LogStashLogger::Formatter::CeeSyslog do
     end
   end
 
-  describe "#facility" do
+  describe "#build_facility" do
     let(:host) { Socket.gethostname }
 
     before do
@@ -29,14 +29,14 @@ describe LogStashLogger::Formatter::CeeSyslog do
     end
 
     it "includes hostname and progname" do
-      expect(subject.send(:facility)).to match(/\A#{host}\s#{progname}\z/)
+      expect(subject.send(:build_facility, host)).to match(/\A#{host}\s#{progname}\z/)
     end
 
     context "without progname" do
       let(:progname) { nil }
 
       it "only includes hostname" do
-        expect(subject.send(:facility)).to match(/\A#{host}\z/)
+        expect(subject.send(:build_facility, host)).to match(/\A#{host}\z/)
       end
     end
   end

data/spec/syslog_spec.rb

@@ -1,25 +1,32 @@
 require 'logstash-logger'
 
 describe LogStashLogger do
-  context "Syslog" do
-    let(:program_name) { "MyApp" }
-    let(:facility) { 128 } #Syslog::LOG_LOCAL0 }
+  let(:program_name) { 'MyApp' }
+  let(:facility) { 128 } #Syslog::LOG_LOCAL0 }
+
+  context 'Syslog' do
     subject { LogStashLogger.new(type: :syslog, program_name: program_name, facility: facility) }
     let(:syslog) { subject.class.class_variable_get(:@@syslog) }
 
     it { is_expected.to be_a Syslog::Logger }
 
-    it "writes formatted messages to syslog" do
+    it 'writes formatted messages to syslog' do
       expect(syslog).to receive(:log)
-      subject.info("test")
+      subject.info('test')
     end
 
-    it "sets the syslog identity" do
+    it 'sets the syslog identity' do
       expect(syslog.ident).to eq(program_name)
     end
 
-    it "sets the default facility if supported" do
+    it 'sets the default facility if supported' do
       expect(subject.facility).to eq(facility) if subject.respond_to?(:facility)
     end
   end
+
+  context 'when logger type is a string' do
+    subject { LogStashLogger.new(type: 'syslog', program_name: program_name, facility: facility) }
+
+    it { is_expected.to be_a Syslog::Logger }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby logger that writes directly to LogStash
 email:
 - dwbutler@ucla.edu
@@ -157,7 +171,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"

data/.codeclimate.yml

@@ -1,16 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- spec/