semlog 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 964258648040269ffcdb9c07a46d970dfbb415d0
+  data.tar.gz: cca947657b3e5609c503ccf0abc90d52bd4333af
+SHA512:
+  metadata.gz: 424a1df5df3e47c9217fe214523f9dbd3bc7518735eaed5907e843a5cff4c82b5861a59b8f115a941ce7e3fa1f4cb59f0852518f0031ba1e7aabc91902ee9215
+  data.tar.gz: 31520146ce5e1f8584410696d73720baf3b81c153db78632cba21ff596d56ae5ac61fe5f6676b4303edf099a413e2d585b501ef63928eb0c1967f135730f17cc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in semlog.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# Semlog
+
+Gelf log appender directly to rabbitmq
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semlog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install semlog
+
+## Usage
+
+Suggested initializer
+```ruby
+$logger = SemanticLogger['semlog']
+$logger.level = Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO"))
+SemanticLogger.add_appender(file_name: file_name, formatter: :color)
+SemanticLogger.add_appender(io: $stderr, level: :debug)
+
+
+gelf_appender = Semlog::SemanticLogger::Appender::GelflogAppender.new(
+  host: ENV['RABBIT_HOST'],
+  port: ENV['RABBIT_PORT'],
+  vhost:ENV['RABBIT_VIRTUAL_HOST'],
+  exchange: ENV['RABBIT_EXCHANGE'],
+  user:  ENV['RABBIT_USER'],
+  pw:  ENV['RABBIT_PW'],
+  application: 'semlog'
+)
+
+gelf_appender.name = 'Semlog'
+
+
+SemanticLogger.add_appender(gelf_appender)
+
+$logger.info "Logging initiated to #{$logger.level } level"
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leffen/semlog.
+

data/lib/semlog.rb

@@ -0,0 +1,8 @@
+require "semlog/version"
+require "semlog/severity"
+require "semlog/rabbit_notifier"
+require "semlog/gelflog_appender"
+
+module Semlog
+  # Your code goes here...
+end

data/lib/semlog/gelflog_appender.rb

@@ -0,0 +1,68 @@
+require "semantic_logger"
+
+module Semlog
+
+  class GelflogAppender < SemanticLogger::Subscriber
+
+    # Map Semantic Logger levels to Graylog levels
+    LEVEL_MAP = {
+      fatal: Semlog::FATAL,
+      error: Semlog::ERROR,
+      warn: Semlog::WARN,
+      info: Semlog::INFO,
+      debug: Semlog::DEBUG,
+      trace: Semlog::DEBUG
+    }
+
+    attr_reader :notifier
+
+    def initialize(options = {}, &block)
+      options = options.dup
+
+      @rabbit_host=options.delete(:host)|| 'localhost'
+      @port=options.delete(:port)|| 5672
+      @vhost=options.delete(:vhost)||''
+      @exchange=options.delete(:exchange)|| ''
+      @user=options.delete(:user)||''
+      @pw=options.delete(:pw)||''
+      @app_name = options.delete(:application) || 'Semlog'
+
+      super(options, &block)
+      self.application = @app_name
+
+      reopen
+    end
+
+    def reopen
+      @notifier = RabbitNotifier.new(host: @rabbit_host, port: @port, vhost: @vhost, exchange_name: @exchange, user: @user, pw: @pw)
+    end
+
+    def make_hash(log)
+      h = log.to_h(host, application)
+      h[:level] = map_level(log)
+      h[:level_str] = log.level.to_s
+      h[:short_message] = h.delete(:message) if log.message && !h.key?("short_message") && !h.key?(:short_message)
+      h[:request_uid] = h.delete(:tags).first if log.tags && log.tags.count > 0
+      h
+    end
+
+    # Forward log messages
+    def log(log)
+      return false unless should_log?(log)
+
+      begin
+        @notifier.notify!(make_hash(log))
+      rescue => e
+        $logger.error "Semlog::Appender::GelflogAppender >EXCEPTION> #{e}"
+      end
+
+      true
+    end
+
+    # Returns the Graylog level for the supplied log message
+    def map_level(log)
+      LEVEL_MAP[log.level]
+    end
+
+  end
+end

data/lib/semlog/rabbit_notifier.rb

@@ -0,0 +1,78 @@
+require 'bunny'
+require 'oj'
+require 'awesome_print'
+
+Oj.default_options = {:mode => :compat}
+
+module Semlog
+
+
+  class RabbitNotifier
+
+    attr_accessor :connection, :host, :port, :vhost, :exhange_name, :user, :pw, :default_options
+
+    def initialize host:, port:, vhost:, exchange_name:, user:, pw:
+      @connection = nil
+      @host = host
+      @port = port
+      @vhost = vhost
+      @exhange_name = exchange_name
+      @user = user
+      @pw = pw
+
+      $logger.debug "RabbitNotifier>host: #{@host} port #{@port} vhost #{@vhost} "
+
+      @default_options = {}
+      @default_options['version'] = "1.1"
+      @default_options['host'] ||= Socket.gethostname
+      @default_options['level'] ||= Semlog::UNKNOWN
+      @default_options['facility'] ||= 'RabbitNotifier'
+
+    end
+
+    def connect
+      unless @connection
+        @connection = Bunny.new(:host => @host, :vhost => @vhost, :user => @user, :password => @pw)
+        @connection.start
+      end
+      @connection
+    end
+
+    def gelfify(data)
+      gdata = @default_options.dup
+      data.keys.each do |key|
+        value, key_s = data[key], key.to_s
+        if ['host', 'level', 'version', 'short_message', 'full_message', 'timestamp', 'facility', 'line', 'file'].index(key_s)
+          gdata[key_s] = value
+        elsif key_s == 'action'
+          gdata["_application_action"] = value
+        elsif key_s == 'id'
+          gdata["_application_id"] = value
+        elsif key_s[0] != '_'
+          gdata["_#{key_s}"] = value
+        else
+          gdata[key_s] = value
+        end
+      end
+      gdata
+    end
+
+    def data_to_json(data)
+      Oj.dump(gelfify(data))
+    end
+
+    def notify!(data)
+      exchange.publish(data_to_json(data))
+    end
+
+    def channel
+      connect
+      @channel ||= @connection.create_channel
+    end
+
+    def exchange
+      @exchange ||= channel.fanout(exhange_name, durable: true)
+    end
+  end
+
+end

data/lib/semlog/severity.rb

@@ -0,0 +1,37 @@
+module Semlog
+  # There are two things you should know about log levels/severity:
+  #  - syslog defines levels from 0 (Emergency) to 7 (Debug).
+  #    0 (Emergency) and 1 (Alert) levels are reserved for OS kernel.
+  #  - Ruby default Logger defines levels from 0 (DEBUG) to 4 (FATAL) and 5 (UNKNOWN).
+  #    Note that order is inverted.
+  # For compatibility we define our constants as Ruby Logger, and convert values before
+  # generating GELF message, using defined mapping.
+
+  module Levels
+    DEBUG   = 0
+    INFO    = 1
+    WARN    = 2
+    ERROR   = 3
+    FATAL   = 4
+    UNKNOWN = 5
+  end
+
+  include Levels
+
+  # Maps Ruby Logger levels to syslog levels as SyslogLogger and syslogger gems. This one is default.
+  LOGGER_MAPPING = {DEBUG   => 7, # Debug
+                    INFO    => 6, # Info
+                    WARN    => 5, # Notice
+                    ERROR   => 4, # Warning
+                    FATAL   => 3, # Error
+                    UNKNOWN => 1} # Alert – shouldn't be used
+
+  # Maps Ruby Logger levels to syslog levels as is.
+  DIRECT_MAPPING = {DEBUG   => 7, # Debug
+                    INFO    => 6, # Info
+                    # skip 5 Notice
+                    WARN    => 4, # Warning
+                    ERROR   => 3, # Error
+                    FATAL   => 2, # Critical
+                    UNKNOWN => 1} # Alert – shouldn't be used
+end

data/lib/semlog/version.rb

@@ -0,0 +1,3 @@
+module Semlog
+  VERSION = "0.1.1"
+end

data/semlog.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'semlog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "semlog"
+  spec.version       = Semlog::VERSION
+  spec.authors       = ["leffen"]
+  spec.email         = ["leffen@gmail.com"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Plugin log module to semantic logger}
+  spec.description   = %q{Provides direct to Rabbitmq logging from semantic logger}
+  spec.homepage      = "https://github.com/leffen/semlog"
+
+  spec.files       = Dir['lib/**/*.rb'] + %w(Gemfile semlog.gemspec README.md)
+  spec.test_files  = Dir['spec/**/*.rb']
+
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "http://pagems:SuperSikkertLangtPassord!2020_@gems.asd09.com"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/semlog_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Semlog do
+  it 'has a version number' do
+    expect(Semlog::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'semlog'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: semlog
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- leffen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides direct to Rabbitmq logging from semantic logger
+email:
+- leffen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/semlog.rb
+- lib/semlog/gelflog_appender.rb
+- lib/semlog/rabbit_notifier.rb
+- lib/semlog/severity.rb
+- lib/semlog/version.rb
+- semlog.gemspec
+- spec/semlog_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/leffen/semlog
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Plugin log module to semantic logger
+test_files:
+- spec/semlog_spec.rb
+- spec/spec_helper.rb