logasm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c109d32973a0fb0874162679d8c648790698ff
+  data.tar.gz: 4187e98a866d2ec61e4232febb84a6832a30c019
+SHA512:
+  metadata.gz: da9efd6daf3d43b27e7a16b25c1d858c8d85f19291823cb4d57ba58c86aef7376559a5ea7ce8a9629c54492a0aafafbb5b00487c0f6bf53bbdf993148ebd9244
+  data.tar.gz: 0632bf09b2a4079a036ec8a53469b826a8e1a1a562972ed5300e48ce11babd1187cc5b9601bfdb811796c3c6d47d35fd666d1ef21001f325ac475ef9c65772b6

data/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+npm-debug.log
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+logasm

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+group :test, :development do
+  gem 'rspec'
+  gem 'pry'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    logasm (0.1.0)
+      inflecto
+      logstash-event (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    inflecto (0.0.2)
+    logstash-event (1.2.02)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  logasm!
+  pry
+  rake
+  rspec

data/README.md

@@ -0,0 +1,63 @@
+Logasm
+================
+
+## Usage
+
+### Creating a new Logasm logger in Ruby
+
+```ruby
+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
+
+```
+loggers:
+  stdout:
+    level: 'debug'
+  logstash:
+    level: 'info'
+    host: 'localhost'
+    port: 5228
+```
+Supported log levels:
+
+1. fatal
+2. error
+3. warn
+4. info
+5. debug
+
+For example level: 'warn' will log everything with warn and above.
+
+#### Examples
+
+Creating a new stdout logger
+
+```ruby
+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.

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task ci: :spec
+task default: :spec

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

@@ -0,0 +1,35 @@
+class Logasm
+  module Adapters
+    class LogstashAdapter
+      class Formatter < ::Logger::Formatter
+        HOST = ::Socket.gethostname
+
+        def initialize(service_name)
+          @service_name = service_name
+        end
+
+        def call(severity, time, _progname, message)
+          event = build_event(message, severity, time)
+          "#{event.to_json}\n"
+        end
+
+        private
+
+        def build_event(metadata, level, time)
+          event = LogStash::Event.new(metadata.merge("@timestamp" => time))
+
+          event['application'] = @service_name if @service_name
+          event['level'] = level.downcase
+          event['host'] ||= HOST
+
+          # In case Time#to_json has been overridden
+          if event.timestamp.is_a?(Time)
+            event.timestamp = event.timestamp.iso8601(3)
+          end
+
+          event
+        end
+      end
+    end
+  end
+end

data/lib/logasm/adapters/logstash_adapter.rb

@@ -0,0 +1,25 @@
+require 'socket'
+require 'logstash-event'
+
+class Logasm
+  module Adapters
+    class LogstashAdapter
+      attr_reader :logger
+
+      def initialize(level, service, host:, 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/stdout_adapter.rb

@@ -0,0 +1,18 @@
+class Logasm
+  module Adapters
+    class StdoutAdapter
+      attr_reader :logger
+
+      def initialize(level, *)
+        @logger = Logger.new(STDOUT)
+        @logger.level = level
+      end
+
+      def log(level, message: nil, **metadata)
+        log_data = [message, metadata.empty? ? nil : metadata.to_json].compact.join(' ')
+
+        @logger.public_send level, log_data
+      end
+    end
+  end
+end

data/lib/logasm/adapters.rb

@@ -0,0 +1,11 @@
+class Logasm
+  module Adapters
+    LOG_LEVELS = %w(debug info warn error fatal unknown).freeze
+
+    def self.get(type, service_name, arguments)
+      adapter = const_get(Inflecto.camelize(type.to_s) + 'Adapter')
+      level = LOG_LEVELS.index(arguments.fetch(:level, 'debug'))
+      adapter.new(level, service_name, arguments)
+    end
+  end
+end

data/lib/logasm.rb

@@ -0,0 +1,56 @@
+require 'inflecto'
+require 'logger'
+require_relative 'logasm/adapters'
+require_relative 'logasm/adapters/stdout_adapter'
+require_relative 'logasm/adapters/logstash_adapter'
+require_relative 'logasm/adapters/logstash_adapter/formatter'
+
+class Logasm
+  def self.build(service_name, loggers_config)
+    loggers_config ||= {stdout: nil}
+    adapters = loggers_config.map do |type, arguments|
+      Adapters.get(type.to_s, service_name, arguments || {})
+    end
+    new(adapters)
+  end
+
+  def initialize(adapters)
+    @adapters = adapters
+  end
+
+  def debug(*args)
+    log :debug, *args
+  end
+
+  def info(*args)
+    log :info, *args
+  end
+
+  def warn(*args)
+    log :warn, *args
+  end
+
+  def error(*args)
+    log :error, *args
+  end
+
+  def fatal(*args)
+    log :fatal, *args
+  end
+
+  private
+
+  def log(level, *args)
+    data = parse_log_data(*args)
+
+    @adapters.each do |adapter|
+      adapter.log(level, data)
+    end
+  end
+
+  def parse_log_data(message, metadata = {})
+    return message if message.is_a?(Hash)
+
+    (metadata || {}).merge(message: message)
+  end
+end

data/logasm.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "logasm"
+  gem.version       = '0.1.0'
+  gem.authors       = ["Salemove"]
+  gem.email         = ["support@salemove.com"]
+  gem.description   = %q{It's logasmic}
+  gem.summary       = %q{What description said}
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'logstash-event', '~> 1.2'
+  gem.add_dependency 'inflecto'
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end

data/spec/adapters/logstash_adapter/formatter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Logasm::Adapters::LogstashAdapter::Formatter do
+  subject(:event) { JSON.parse(formatter.call(severity, time, nil, message)) }
+
+  let(:formatter) { described_class.new(service_name) }
+  let(:service_name) { 'test_service' }
+  let(:severity) { 'INFO' }
+  let(:time) { Time.now }
+  let(:message) { {} }
+
+  context 'when service name is present' do
+    it 'includes it in the event as application' do
+      expect(event['application']).to eq('test_service')
+    end
+  end
+
+  context 'when service name is not present' do
+    let(:service_name) { nil }
+
+    it 'includes does not include the application key' do
+      expect(event).to_not have_key('application')
+    end
+  end
+
+  it 'includes severity as lowercase level' do
+    expect(event['level']).to eq('info')
+  end
+
+  it 'includes timestamp' do
+    expect(event['@timestamp']).to match(/\d{4}.*/)
+  end
+
+  it 'includes the host' do
+    expect(event['host']).to be_a(String)
+  end
+end

data/spec/adapters/logstash_adapter_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+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/stdout_adapter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'logasm'
+
+describe Logasm::Adapters::StdoutAdapter do
+  it 'creates a stdout logger' do
+    io_logger = described_class.new(0)
+
+    logger = io_logger.instance_variable_get(:@logger)
+    expect(logger).to be_a Logger
+  end
+
+  describe '#log' do
+    let(:adapter) { described_class.new(0) }
+    let(:logger) { adapter.logger }
+
+    context 'with only a message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:info).with('test')
+
+        adapter.log :info, message: 'test'
+      end
+    end
+
+    context 'with an empty message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:info).with(' {"a":"b"}')
+
+        adapter.log :info, message: '', a: 'b'
+      end
+    end
+
+    context 'with no message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:info).with('{"a":"b"}')
+
+        adapter.log :info, a: 'b'
+      end
+    end
+
+    context 'with a message and metadata' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:info).with('test {"a":"b"}')
+
+        adapter.log :info, message: 'test', a: 'b'
+      end
+    end
+  end
+end

data/spec/logasm_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Logasm do
+  describe '.build' do
+    it 'creates file 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::StdoutAdapter)
+      end
+
+      described_class.build('test_service', stdout: nil)
+    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
+      expect(described_class).to receive(:new) do |adapters|
+        expect(adapters.count).to be(1)
+        expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
+      end
+
+      described_class.build('test_service', nil)
+    end
+  end
+
+  context 'when parsing log data' do
+    let(:logasm) { described_class.new([adapter]) }
+    let(:adapter) { double }
+
+    it 'parses empty string with nil metadata' do
+      expect(adapter).to receive(:log).with(:info, message: '')
+
+      logasm.info('', nil)
+    end
+
+    it 'parses nil as metadata' do
+      expect(adapter).to receive(:log).with(:info, message: nil)
+
+      logasm.info(nil)
+    end
+
+    it 'parses only message' do
+      expect(adapter).to receive(:log).with(:info, message: 'test message')
+
+      logasm.info 'test message'
+    end
+
+    it 'parses only metadata' do
+      expect(adapter).to receive(:log).with(:info, test: 'data')
+
+      logasm.info test: 'data'
+    end
+
+    it 'parses message and metadata' do
+      expect(adapter).to receive(:log).with(:info, message: 'test message', test: 'data')
+
+      logasm.info 'test message', test: 'data'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+require 'pry'
+require 'securerandom'
+
+require 'logasm'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: logasm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salemove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+description: It's logasmic
+email:
+- support@salemove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/logasm.rb
+- lib/logasm/adapters.rb
+- lib/logasm/adapters/logstash_adapter.rb
+- lib/logasm/adapters/logstash_adapter/formatter.rb
+- lib/logasm/adapters/stdout_adapter.rb
+- logasm.gemspec
+- spec/adapters/logstash_adapter/formatter_spec.rb
+- spec/adapters/logstash_adapter_spec.rb
+- spec/adapters/stdout_adapter_spec.rb
+- spec/logasm_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.4.3
+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/stdout_adapter_spec.rb
+- spec/logasm_spec.rb
+- spec/spec_helper.rb