logasm 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 976cb0da3fd9228fcfc8131274424fa54ea76117
-  data.tar.gz: 638a7ed3dee8b7756b97fbc4f45c08cc2ddb6993
+  metadata.gz: bb7e9b0c7705fcdbfd723890c04ccbb1f5aeb944
+  data.tar.gz: d554034a757044f6880a9e12a8e1fad0ff83d1fb
 SHA512:
-  metadata.gz: 53b084eeb0aec7ebaa7830d8677b295d9a4b4c31b472929df8e6c35b8ef54c7719d08879e8653335e4c4cae0e80b3cfd26d3640167e8ac8f24b08e7893150efc
-  data.tar.gz: c054f7d41cb28d47abc5610368e9a5a918c8bd5a2d62abe07dd133c1edd8fba706c6437b9ef3c4baf96cd3f92d9c9eb9e9dd782788668be4673dd0b2f3a0aff8
+  metadata.gz: 2bcf5f48bb51ed0f433919b8a64b0671510b17159daea4e5cded9a7666384de6468ed3ee47531fd9ee144425f5b7de46e6c657292c2e36823e404f65b99d1958
+  data.tar.gz: 5e6875c898fbb2f7239ab6c471aa1016f57ba789ecb9e32753e56039c9ab7751eb95ec6c54e08cdfd1794656dea6f3238d873e7e34334893f4f7b5cce9ace5bd

data/README.md

@@ -9,8 +9,6 @@ Logasm
 Logasm.build(application_name, logger_config)
 ```
 
-<b>application_name</b> is the name of the application. Only logstash logger will use this.
-
 <b>logger_config</b> is a hash with logger types and their configuration.
 
 #### Configuration
@@ -19,10 +17,6 @@ Logasm.build(application_name, logger_config)
 loggers:
   stdout:
     level: 'debug'
-  logstash:
-    level: 'info'
-    host: 'localhost'
-    port: 5228
 ```
 Supported log levels:
 
@@ -44,22 +38,6 @@ require 'logasm'
 logasm = Logasm.build('myApp', stdout: nil)
 ```
 
-Creating a new logstash logger
-
-```ruby
-require 'logasm'
-
-logasm = Logasm.build('myApp', logstash: { host: "localhost", port: 5228 })
-```
-
-Creating a new logger that logs into stdout and logstash at the same time
-
-```ruby
-require 'logasm'
-
-logasm = Logasm.build('myApp', { stdout: nil, logstash: { host: "localhost", port: 5228 }})
-```
-
 When no loggers are specified, it creates a stdout logger by default.
 
 ## Preprocessors

data/lib/logasm/adapters/stdout_adapter.rb

@@ -17,7 +17,10 @@ class Logasm
       def log(level, metadata = {})
         message = metadata[:message]
         data = metadata.select { |key, value| key != :message }
-        log_data = [message, data.empty? ? nil : data.to_json].compact.join(' ')
+        log_data = [
+          message,
+          data.empty? ? nil : Oj.dump(data, mode: :compat, time_format: :ruby)
+        ].compact.join(' ')
 
         @logger.public_send level, log_data
       end

data/lib/logasm/adapters/stdout_json_adapter.rb

@@ -9,7 +9,7 @@ class Logasm
       def log(level, metadata = {})
         if meets_threshold?(level)
           message = Utils.build_event(metadata, level, @service_name)
-          STDOUT.puts(JSON.dump(message))
+          STDOUT.puts(Oj.dump(message, mode: :compat, time_format: :ruby))
         end
       end
 

data/lib/logasm/adapters.rb

@@ -4,13 +4,7 @@ class Logasm
 
     def self.get(type, service_name, arguments)
       adapter =
-        if type == 'rabbitmq'
-          require_relative 'adapters/rabbitmq_adapter'
-          RabbitmqAdapter
-        elsif type == 'logstash'
-          require_relative 'adapters/logstash_adapter'
-          LogstashAdapter
-        elsif type == 'stdout'
+        if type == 'stdout'
           if arguments.fetch(:json, false)
             require_relative 'adapters/stdout_json_adapter'
             StdoutJsonAdapter

data/lib/logasm/utils.rb

@@ -1,9 +1,7 @@
-require 'socket'
 require 'time'
 
 class Logasm
   module Utils
-    HOST = ::Socket.gethostname
     DECIMAL_FRACTION_OF_SECOND = 3
 
     # Build logstash json compatible event
@@ -36,8 +34,7 @@ class Logasm
 
     def self.overwritable_params
       {
-        :@timestamp => Time.now.utc.iso8601(DECIMAL_FRACTION_OF_SECOND),
-        host: HOST
+        :@timestamp => Time.now.utc.iso8601(DECIMAL_FRACTION_OF_SECOND)
       }
     end
 

data/lib/logasm.rb

@@ -1,6 +1,6 @@
 require 'inflecto'
 require 'logger'
-require 'json'
+require 'oj'
 require_relative 'logasm/adapters'
 require_relative 'logasm/utils'
 require_relative 'logasm/null_logger'

data/logasm.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "logasm"
-  gem.version       = '0.9.1'
+  gem.version       = '1.0.0'
   gem.authors       = ["Salemove"]
   gem.email         = ["support@salemove.com"]
   gem.description   = %q{It's logasmic}
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'inflecto'
   gem.add_dependency 'lru_redux'
+  gem.add_dependency 'oj'
 
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"

data/spec/adapters/stdout_json_adapter_spec.rb

@@ -12,7 +12,7 @@ describe Logasm::Adapters::StdoutJsonAdapter do
       let(:adapter) { described_class.new(debug_level_code, service_name) }
       let(:metadata) { {x: 'y'} }
       let(:event) { {a: 'b', x: 'y'} }
-      let(:serialized_event) { JSON.dump(event) }
+      let(:serialized_event) { Oj.dump(event, mode: :compat, time_format: :ruby) }
       let(:service_name) { 'my-service' }
 
       before do

data/spec/logasm_spec.rb

@@ -20,26 +20,7 @@ describe Logasm do
       described_class.build('test_service', stdout: {json: true})
     end
 
-    it 'creates logstash logger' do
-      expect(described_class).to receive(:new) do |adapters|
-        expect(adapters.count).to be(1)
-        expect(adapters.first).to be_a(described_class::Adapters::LogstashAdapter)
-      end
-
-      described_class.build('test_service', logstash: {host: 'localhost', port: 5228})
-    end
-
-    it 'creates multiple loggers' do
-      expect(described_class).to receive(:new) do |adapters|
-        expect(adapters.count).to be(2)
-        expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
-        expect(adapters.last).to be_a(described_class::Adapters::LogstashAdapter)
-      end
-
-      described_class.build('test_service', stdout: nil, logstash: {host: 'localhost', port: 5228})
-    end
-
-    it 'creates file logger when no loggers are specified' do
+    it 'creates stdout logger when no loggers are specified' do
       expect(described_class).to receive(:new) do |adapters|
         expect(adapters.count).to be(1)
         expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
@@ -124,14 +105,9 @@ describe Logasm do
   end
 
   context 'log level queries' do
-    context 'when one adapter has debug level' do
+    context 'when adapter has debug level' do
       let(:logger) do
-        described_class.build(
-          'test_service',
-          stdout: {level: 'debug'},
-          logstash: {level: 'info', host: '127.0.0.1', port: 5228 },
-          rabbitmq: {level: 'fatal'},
-        )
+        described_class.build('test_service', stdout: {level: 'debug'})
       end
 
       it 'responds true to debug? and higher levels' do
@@ -143,14 +119,9 @@ describe Logasm do
       end
     end
 
-    context 'when one adapter has info level' do
+    context 'when adapter has info level' do
       let(:logger) do
-        described_class.build(
-          'test_service',
-          rabbitmq: {level: 'info'},
-          stdout: {level: 'warn'},
-          logstash: {level: 'warn', host: '127.0.0.1', port: 5228 },
-        )
+        described_class.build('test_service', stdout: {level: 'info'})
       end
 
       it 'responds true to info? and higher levels' do

data/spec/utils_spec.rb

@@ -34,10 +34,6 @@ describe Logasm::Utils do
       expect(event[:@timestamp]).to eq('2015-10-11T23:10:21.123Z')
     end
 
-    it 'includes the host' do
-      expect(event[:host]).to be_a(String)
-    end
-
     context 'when @timestamp provided' do
       let(:metadata) { {message: 'test', :@timestamp => 'a timestamp'} }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logasm
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +125,6 @@ files:
 - benchmark/whitelisting.rb
 - lib/logasm.rb
 - lib/logasm/adapters.rb
-- lib/logasm/adapters/logstash_adapter.rb
-- lib/logasm/adapters/logstash_adapter/formatter.rb
-- lib/logasm/adapters/rabbitmq_adapter.rb
 - lib/logasm/adapters/stdout_adapter.rb
 - lib/logasm/adapters/stdout_json_adapter.rb
 - lib/logasm/null_logger.rb
@@ -125,9 +136,6 @@ files:
 - lib/logasm/preprocessors/whitelist.rb
 - lib/logasm/utils.rb
 - logasm.gemspec
-- spec/adapters/logstash_adapter/formatter_spec.rb
-- spec/adapters/logstash_adapter_spec.rb
-- spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
 - spec/adapters/stdout_json_adapter_spec.rb
 - spec/logasm_spec.rb
@@ -162,9 +170,6 @@ signing_key:
 specification_version: 4
 summary: What description said
 test_files:
-- spec/adapters/logstash_adapter/formatter_spec.rb
-- spec/adapters/logstash_adapter_spec.rb
-- spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
 - spec/adapters/stdout_json_adapter_spec.rb
 - spec/logasm_spec.rb

data/lib/logasm/adapters/logstash_adapter/formatter.rb

@@ -1,16 +0,0 @@
-class Logasm
-  module Adapters
-    class LogstashAdapter
-      class Formatter < ::Logger::Formatter
-        def initialize(service_name)
-          @service_name = service_name
-        end
-
-        def call(level, _time, _progname, message)
-          event = Utils.build_event(message, level, @service_name)
-          "#{event.to_json}\n"
-        end
-      end
-    end
-  end
-end

data/lib/logasm/adapters/logstash_adapter.rb

@@ -1,31 +0,0 @@
-require 'socket'
-require_relative 'logstash_adapter/formatter'
-require 'forwardable'
-
-class Logasm
-  module Adapters
-    class LogstashAdapter
-      extend Forwardable
-      attr_reader :logger
-
-      def_delegators :@logger, :debug?, :info?, :warn?, :error?, :fatal?
-
-      def initialize(level, service, arguments = {})
-        host = arguments.fetch(:host)
-        port = arguments.fetch(:port)
-        device = UDPSocket.new.tap do |socket|
-          socket.connect(host, port)
-        end
-
-        @logger = Logger.new(device).tap do |logger|
-          logger.formatter = Formatter.new(service)
-          logger.level = level
-        end
-      end
-
-      def log(level, data)
-        @logger.public_send level, data
-      end
-    end
-  end
-end

data/lib/logasm/adapters/rabbitmq_adapter.rb

@@ -1,75 +0,0 @@
-begin
-  require 'bunny'
-rescue LoadError => e
-  raise unless e.message =~ /bunny/
-  exception = e.exception('To use RabbitMQ adapter for logging, please install bunny!')
-  exception.set_backtrace(e.backtrace)
-  raise exception
-end
-
-class Logasm
-  module Adapters
-    class RabbitmqAdapter
-      CONFIGURATION_KEYS = [:host, :hosts, :user, :pass, :port]
-
-      attr_reader :bunny
-
-      def initialize(level, service_name, arguments = {})
-        config = arguments.select { |key, value| CONFIGURATION_KEYS.include?(key) }
-        @level = level
-        @service_name = service_name
-        @bunny = Bunny.new(config)
-        @queue_name = arguments.fetch(:queue, 'logstash-queue')
-      end
-
-      def log(level, metadata = {})
-        if meets_threshold?(level)
-          message = Utils.build_event(metadata, level, @service_name)
-          deliver_message message
-        end
-      end
-
-      def debug?
-        meets_threshold?(:debug)
-      end
-
-      def info?
-        meets_threshold?(:info)
-      end
-
-      def warn?
-        meets_threshold?(:warn)
-      end
-
-      def error?
-        meets_threshold?(:error)
-      end
-
-      def fatal?
-        meets_threshold?(:fatal)
-      end
-
-      private
-
-      def meets_threshold?(level)
-        LOG_LEVELS.index(level.to_s) >= @level
-      end
-
-      def deliver_message(message)
-        exchange.publish(JSON.dump(message), {
-          content_type: 'application/json',
-          routing_key: @queue_name
-        })
-      rescue Bunny::ConnectionClosedError
-      end
-
-      def exchange
-        @exchange ||= begin
-          bunny.start
-          channel = bunny.create_channel
-          channel.default_exchange
-        end
-      end
-    end
-  end
-end

data/spec/adapters/logstash_adapter/formatter_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-require_relative '../../../lib/logasm/adapters/logstash_adapter/formatter'
-
-describe Logasm::Adapters::LogstashAdapter::Formatter do
-  subject(:event) { formatter.call(severity, Time.now, nil, message) }
-
-  let(:formatter)    { described_class.new(service_name) }
-  let(:service_name) { 'test_service' }
-  let(:severity)     { 'INFO' }
-  let(:message)      { {x: 'y'} }
-
-  it 'returns correct json' do
-    hash = JSON.parse(subject)
-    expect(hash['x']).to eq('y')
-    expect(hash['application']).to eq('test_service')
-    expect(hash['level']).to eq('info')
-    expect(hash['host']).to be_a(String)
-    expect(hash['@timestamp']).to match(/\d{4}-\d{2}-\d{2}T.*/)
-  end
-end

data/spec/adapters/logstash_adapter_spec.rb

@@ -1,13 +0,0 @@
-require 'spec_helper'
-require_relative '../../lib/logasm/adapters/logstash_adapter'
-
-describe Logasm::Adapters::LogstashAdapter do
-  let(:logstash) { described_class.new(0, 'test_service', { host: 'localhost', port: '5228'}) }
-  let(:logger) { logstash.logger }
-
-  it 'delegates to the logger' do
-    expect(logger).to receive(:info).with(message: 'test')
-
-    logstash.log :info, message: 'test'
-  end
-end

data/spec/adapters/rabbitmq_adapter_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-require_relative '../../lib/logasm/adapters/rabbitmq_adapter'
-
-describe Logasm::Adapters::RabbitmqAdapter do
-  let(:adapter) do
-    described_class.new(log_level, 'TestService', {
-      host: 'localhost', user: 'guest', pass: 'guest', port: '5672'
-    })
-  end
-  let(:bunny) { double(start: nil, create_channel: channel) }
-  let(:channel) { double(default_exchange: exchange) }
-  let(:exchange) { spy }
-
-  before do
-    allow(Bunny).to receive(:new) { bunny }
-  end
-
-  describe '#log' do
-    context 'when logging a message' do
-      let(:log_level) { 0 }
-
-      it 'delegates to bunny' do
-        adapter.log :info, message: 'test'
-
-        expect(exchange).to have_received(:publish).with(
-          match(/{"@timestamp":"\d{4}-\d{2}-\d{2}T.*","host":".+","message":"test","application":"test_service","level":"info"}/),
-          { content_type: 'application/json', routing_key: 'logstash-queue' }
-        )
-      end
-    end
-
-    context 'when log level is lower than threshold' do
-      let(:log_level) { 3 }
-
-      it 'does not delegate to bunny' do
-        adapter.log :info, message: 'test', a: 'b'
-
-        expect(exchange).to_not have_received(:publish)
-      end
-    end
-  end
-end