logstash-logger-yajl 0.27.0

data/spec/multi_logger_spec.rb

@@ -0,0 +1,59 @@
+require 'logstash-logger'
+
+describe LogStashLogger::MultiLogger do
+  include_context 'device'
+
+  # Create a MultiLogger writing to both STDOUT and a StringIO
+  subject { multi_logger }
+
+  it { is_expected.to be_a LogStashLogger::MultiLogger }
+
+  it "has multiple loggers" do
+    expect(subject.loggers.count).to eq(2)
+  end
+
+  it "has one logger per output" do
+    expect(subject.loggers[0].device).to be_a LogStashLogger::Device::Stdout
+    expect(subject.loggers[1].device).to be_a LogStashLogger::Device::IO
+  end
+
+  it "allows a different formatter for each logger" do
+    expect(subject.loggers[0].formatter.class).to eq ::Logger::Formatter
+    expect(subject.loggers[1].formatter.class).to eq LogStashLogger::Formatter::JsonLines
+  end
+
+  it "logs to all loggers" do
+    subject.loggers.each do |logger|
+      expect(logger).to receive(:info).with("test")
+    end
+
+    subject.info("test")
+  end
+
+  it "supports silenced logging" do
+    subject.loggers.each do |logger|
+      expect(logger).to receive(:silence).and_call_original
+      expect(logger.device).to receive(:write).once
+    end
+
+    subject.silence(::Logger::WARN) do |logger|
+      expect(logger).to eq(subject)
+      logger.info 'info'
+      logger.warn 'warning'
+    end
+  end
+
+  it "supports tagged logging" do
+    subject.loggers.each do |logger|
+      expect(logger).to receive(:tagged).with('tag').and_call_original
+      expect(logger.device).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to match_array(['tag'])
+      end
+    end
+
+    subject.tagged('tag') do |logger|
+      logger.info 'test'
+    end
+  end
+end

data/spec/rails_spec.rb

@@ -0,0 +1,91 @@
+require 'rails/all'
+require 'logstash-logger'
+require 'logstash-logger/railtie'
+
+module Test
+  class Application < ::Rails::Application
+    config.eager_load = false
+
+    config.logstash.port = PORT
+    config.log_level = :info
+  end
+end
+
+Test::Application.initialize!
+
+describe LogStashLogger do
+  include_context 'device'
+
+  describe "Rails integration" do
+    let(:app) { Rails.application }
+    let(:config) { app.config }
+    subject { app.config.logger }
+
+    before(:each) do
+      app.config.logstash = ActiveSupport::OrderedOptions.new
+      app.config.logger = nil
+    end
+
+    describe '#setup' do
+      context "when configured with a port" do
+        before(:each) do
+          app.config.logstash.port = PORT
+          app.config.log_level = :info
+          LogStashLogger.setup(app)
+        end
+
+        it { is_expected.to be_a LogStashLogger }
+
+        it "defaults level to config.log_level" do
+          expect(subject.level).to eq(::Logger::INFO)
+        end
+      end
+
+      context "when configured with a URI" do
+        before(:each) do
+          app.config.logstash.uri = tcp_uri
+          LogStashLogger.setup(app)
+        end
+
+        it "configures the logger using the URI" do
+          expect(subject.device).to be_a LogStashLogger::Device::TCP
+        end
+      end
+
+      context "when configuring a multi delegator" do
+        before(:each) do
+          app.config.logstash.type = :multi_delegator
+          app.config.logstash.outputs = [
+            {
+              type: :udp,
+              uri: udp_uri
+            },
+            {
+              type: :file,
+              path: '/tmp/foo.log'
+            }
+          ]
+          LogStashLogger.setup(app)
+        end
+
+        it "uses a multi delegator" do
+          expect(subject.device).to be_a LogStashLogger::Device::MultiDelegator
+          expect(subject.device.devices.map(&:class)).to eq([
+            LogStashLogger::Device::UDP,
+            LogStashLogger::Device::File
+          ])
+        end
+      end
+
+      context "when logstash is not configured" do
+        before(:each) do
+          LogStashLogger.setup(app)
+        end
+
+        it "does not configure anything" do
+          expect(app.config.logger).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/silenced_logging_spec.rb

@@ -0,0 +1,31 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  include_context 'logger'
+
+  describe "silenced logging" do
+
+    it "yields the logger" do
+      logger.silence do |yielded|
+        expect(yielded).to eq(logger)
+      end
+    end
+
+    it "silences any message below ERROR level by default" do
+      logger.silence do
+        expect(logger.device).to receive(:write).once
+        logger.info("info")
+        logger.warn("warning")
+        logger.error("error")
+      end
+    end
+
+    it "takes a custom log level to silence to" do
+      logger.silence(::Logger::WARN) do
+        expect(logger.device).to receive(:write).once
+        logger.info("info")
+        logger.warn("warning")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+require 'pry'
+require 'securerandom'
+
+require 'simplecov'
+SimpleCov.start
+if ENV['CI']=='true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  config.before(:suite) do
+    puts "Testing with #{CONNECTION_TYPE.to_s.upcase} socket type"
+  end
+
+  config.before(:each) do
+    LogStashLogger.configure do
+
+    end
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+HOST = ENV['HOST'] || '0.0.0.0'
+PORT = ENV.fetch('PORT', 5228).to_i
+CONNECTION_TYPE ||= (ENV['TYPE'] || 'UDP').to_s.downcase.to_sym
+
+RSpec.shared_context 'logger' do
+  # The type of connection we're testing
+  def connection_type
+    CONNECTION_TYPE
+  end
+
+  let(:host) { HOST }
+  let(:hostname) { Socket.gethostname }
+  let(:port) { PORT }
+
+  # The logstash logger
+  let(:logger) { LogStashLogger.new(host: host, port: port, type: connection_type, sync: true) }
+  # The log device that the logger writes to
+  let(:logdev) { logger.instance_variable_get(:@logdev) }
+end
+
+RSpec.shared_context 'device' do
+  let(:port) { PORT }
+  let(:device_with_port) { LogStashLogger::Device.new(port: port) }
+  let(:udp_device) { LogStashLogger::Device.new(type: :udp, port: port, sync: true) }
+  let(:tcp_device) { LogStashLogger::Device.new(type: :tcp, port: port, sync: true) }
+  let(:ssl_tcp_device) { LogStashLogger::Device.new(type: :tcp, port: port, ssl_enable: true, sync: true) }
+  let(:unix_device) { LogStashLogger::Device.new(type: :unix, path: '/tmp/logstash', sync: true) }
+
+  let(:file) { Tempfile.new('test') }
+  let(:file_device) { LogStashLogger::Device.new(type: :file, path: file.path)}
+
+  let(:io) { StringIO.new }
+  let(:io_device) { LogStashLogger::Device.new(type: :io, io: io)}
+
+  let(:redis_device) { LogStashLogger::Device.new(type: :redis, sync: true) }
+  let(:kafka_device) { LogStashLogger::Device.new(type: :kafka, sync: true) }
+  let(:kinesis_device) { LogStashLogger::Device.new(type: :kinesis, sync: true) }
+  let(:firehose_device) { LogStashLogger::Device.new(type: :firehose, sync: true) }
+
+  let(:outputs) { [{type: :stdout}, {type: :io, io: io}] }
+  let(:multi_delegator_device) { LogStashLogger::Device.new(type: :multi_delegator, outputs: outputs) }
+  let(:balancer_device) { LogStashLogger::Device.new(type: :balancer, outputs: outputs) }
+  let(:multi_logger) do
+    LogStashLogger.new(
+        type: :multi_logger,
+        outputs: [
+            { type: :stdout, formatter: ::Logger::Formatter },
+            { type: :io, io: io }
+        ]
+    )
+  end
+
+  let(:udp_uri) { "udp://localhost:5228" }
+  let(:tcp_uri) { "tcp://localhost:5229" }
+  let(:unix_uri) { "unix:///some/path/to/socket" }
+  let(:file_uri) { "file://#{file.path}" }
+  let(:redis_uri) { "redis://localhost:6379" }
+  let(:kafka_uri) { "kafka://localhost:9092" }
+  let(:stdout_uri) { "stdout://localhost" }
+  let(:stderr_uri) { "stderr://localhost" }
+
+  let(:invalid_uri_config) { {uri: "non parsable uri"} }
+  let(:udp_uri_config)     { {uri: udp_uri} }
+  let(:tcp_uri_config)     { {uri: tcp_uri} }
+  let(:unix_uri_config)    { {uri: unix_uri} }
+  let(:file_uri_config)    { {uri: file_uri} }
+  let(:redis_uri_config)   { {uri: redis_uri} }
+  let(:kafka_uri_config)   { {uri: kafka_uri} }
+  let(:stdout_uri_config)  { {uri: stdout_uri} }
+  let(:stderr_uri_config)  { {uri: stderr_uri} }
+end
+
+RSpec.shared_context 'formatter' do
+  let(:severity) { "DEBUG" }
+  let(:time) { Time.now }
+  let(:progname) { "ruby" }
+  let(:message) { "foo" }
+  let(:long_message) { SecureRandom.hex(65537) }
+  let(:hostname) { Socket.gethostname }
+  let(:formatted_message) do
+    subject.call(severity, time, progname, message)
+  end
+end

data/spec/syslog_spec.rb

@@ -0,0 +1,32 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  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
+      expect(syslog).to receive(:log)
+      subject.info('test')
+    end
+
+    it 'sets the syslog identity' do
+      expect(syslog.ident).to eq(program_name)
+    end
+
+    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

data/spec/tagged_logging_spec.rb

@@ -0,0 +1,32 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  include_context 'logger'
+
+  describe "tagged logging" do
+    let(:message) { 'foo' }
+    let(:tag) { 'bar' }
+
+    it "puts tags into the tags array on the logstash event" do
+      expect(logdev).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to match_array([tag])
+        expect(event['message']).to eq(message)
+      end
+
+      logger.tagged(tag) do
+        logger.info(message)
+      end
+    end
+
+    it "doesn't put tags on the event when there are no tags" do
+      expect(logdev).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to be_nil
+        expect(event['message']).to eq(message)
+      end
+
+      logger.info(message)
+    end
+  end
+end

metadata

@@ -0,0 +1,385 @@
+--- !ruby/object:Gem::Specification
+name: logstash-logger-yajl
+version: !ruby/object:Gem::Version
+  version: 0.27.0
+platform: ruby
+authors:
+- David Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: poseidon
+  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'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-kinesis
+  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'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-firehose
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: insist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- lib/logstash-event.rb
+- lib/logstash-logger.rb
+- lib/logstash-logger/buffer.rb
+- lib/logstash-logger/configuration.rb
+- lib/logstash-logger/device.rb
+- lib/logstash-logger/device/aws_stream.rb
+- lib/logstash-logger/device/balancer.rb
+- lib/logstash-logger/device/base.rb
+- lib/logstash-logger/device/connectable.rb
+- lib/logstash-logger/device/file.rb
+- lib/logstash-logger/device/firehose.rb
+- lib/logstash-logger/device/io.rb
+- lib/logstash-logger/device/kafka.rb
+- lib/logstash-logger/device/kinesis.rb
+- lib/logstash-logger/device/multi_delegator.rb
+- lib/logstash-logger/device/redis.rb
+- lib/logstash-logger/device/socket.rb
+- lib/logstash-logger/device/stderr.rb
+- lib/logstash-logger/device/stdout.rb
+- lib/logstash-logger/device/tcp.rb
+- lib/logstash-logger/device/udp.rb
+- lib/logstash-logger/device/unix.rb
+- lib/logstash-logger/formatter.rb
+- lib/logstash-logger/formatter/base.rb
+- lib/logstash-logger/formatter/cee.rb
+- lib/logstash-logger/formatter/cee_syslog.rb
+- lib/logstash-logger/formatter/json.rb
+- lib/logstash-logger/formatter/json_lines.rb
+- lib/logstash-logger/formatter/logstash_event.rb
+- lib/logstash-logger/logger.rb
+- lib/logstash-logger/multi_logger.rb
+- lib/logstash-logger/railtie.rb
+- lib/logstash-logger/silenced_logging.rb
+- lib/logstash-logger/tagged_logging.rb
+- lib/logstash-logger/version.rb
+- lib/logstash/event.rb
+- lib/logstash/namespace.rb
+- lib/logstash/util.rb
+- lib/logstash/util/fieldreference.rb
+- logstash-logger.gemspec
+- samples/example.crt
+- samples/example.key
+- samples/file.conf
+- samples/redis.conf
+- samples/ssl.conf
+- samples/syslog.conf
+- samples/tcp.conf
+- samples/udp.conf
+- samples/unix.conf
+- spec/configuration_spec.rb
+- spec/constructor_spec.rb
+- spec/device/balancer_spec.rb
+- spec/device/connectable_spec.rb
+- spec/device/file_spec.rb
+- spec/device/firehose_spec.rb
+- spec/device/io_spec.rb
+- spec/device/kafka_spec.rb
+- spec/device/kinesis_spec.rb
+- spec/device/multi_delegator_spec.rb
+- spec/device/redis_spec.rb
+- spec/device/socket_spec.rb
+- spec/device/stderr_spec.rb
+- spec/device/stdout_spec.rb
+- spec/device/tcp_spec.rb
+- spec/device/udp_spec.rb
+- spec/device/unix_spec.rb
+- spec/device_spec.rb
+- spec/formatter/base_spec.rb
+- spec/formatter/cee_spec.rb
+- spec/formatter/cee_syslog_spec.rb
+- spec/formatter/json_lines_spec.rb
+- spec/formatter/json_spec.rb
+- spec/formatter/logstash_event_spec.rb
+- spec/formatter_spec.rb
+- spec/logger_spec.rb
+- spec/logstash_event_spec.rb
+- spec/multi_logger_spec.rb
+- spec/rails_spec.rb
+- spec/silenced_logging_spec.rb
+- spec/spec_helper.rb
+- spec/syslog_spec.rb
+- spec/tagged_logging_spec.rb
+homepage: http://github.com/dwbutler/logstash-logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: LogStash Logger for ruby
+test_files:
+- spec/configuration_spec.rb
+- spec/constructor_spec.rb
+- spec/device/balancer_spec.rb
+- spec/device/connectable_spec.rb
+- spec/device/file_spec.rb
+- spec/device/firehose_spec.rb
+- spec/device/io_spec.rb
+- spec/device/kafka_spec.rb
+- spec/device/kinesis_spec.rb
+- spec/device/multi_delegator_spec.rb
+- spec/device/redis_spec.rb
+- spec/device/socket_spec.rb
+- spec/device/stderr_spec.rb
+- spec/device/stdout_spec.rb
+- spec/device/tcp_spec.rb
+- spec/device/udp_spec.rb
+- spec/device/unix_spec.rb
+- spec/device_spec.rb
+- spec/formatter/base_spec.rb
+- spec/formatter/cee_spec.rb
+- spec/formatter/cee_syslog_spec.rb
+- spec/formatter/json_lines_spec.rb
+- spec/formatter/json_spec.rb
+- spec/formatter/logstash_event_spec.rb
+- spec/formatter_spec.rb
+- spec/logger_spec.rb
+- spec/logstash_event_spec.rb
+- spec/multi_logger_spec.rb
+- spec/rails_spec.rb
+- spec/silenced_logging_spec.rb
+- spec/spec_helper.rb
+- spec/syslog_spec.rb
+- spec/tagged_logging_spec.rb