elklogger 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ae7b440b0b48762f5f4f54993167364e1617a7a
+  data.tar.gz: aa2992fcc13ce54c146e816504774ffc36bf70e0
+SHA512:
+  metadata.gz: 85c66f50d640c4349aa5d766dbe08198ff53d59bc892728dd79d09a9b58cb7cdc927232a89c96af6a6b2d232c78921c93ea3e0f7956c2d637fa7f7ccaa26ad5e
+  data.tar.gz: 2f205bbd1ce95f4bb2f8c4967b88a644a4111a9692505d7c242194ce1ec54996ec9bf11eabc6eb993aafa71ecab11763aff19e0263c83542988ed80a300056fa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG

@@ -0,0 +1,9 @@
+VERSION 0.0.5
+  * Use logfile name as thread name for Ruby projects.
+  * Automatically generate logstash input file path in *.conf.
+VERSION 0.0.4
+  * Fix redefine ElkLogger class.
+VERSION 0.0.3
+  * Don't add +try+ method when it's been defined (such as in a RAILS application).
+  * Change class name to +ElkLogger+ .
+  * Add config generator, now you can use +elklogger config:install+ to generate config file.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hayden Wei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# ElkLogger
+
+A formatted logger for ELK-stack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elklogger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elklogger
+
+## Usage
+
+First, execute the following command to generate config file:
+
+```shel
+elklogger config:install
+```
+
+then you can use it like this in your ruby source files:
+
+```ruby
+logger = ElkLogger.new('/tmp/filename.log.elk') # Create log file, filename MUST be ending with '.elk'
+logger.info 'hello logger!'  # Use 'info' level to log information
+logger.close
+```
+
+**NOTE:** logfile's postfix MUST BE `.elk`, this is important, because only `.elk` files will be supported.
+
+And the supported log levels are (ordered by level ASC):
+
+- debug
+- info
+- warn
+- error
+
+## 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/gnodiah/elklogger.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elklogger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/elklogger

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+require "#{lib}/elklogger/generator/install_config"
+require "#{lib}/elklogger/version"
+
+if ARGV.size != 1
+  puts "Wrong number of arguments (#{ARGV.size} for 1), type 'elklogger -h' for more help."
+elsif ARGV.first != 'config:install'
+  if ARGV.first == '-h'
+    puts <<-EOF
+Usage:
+  elklogger config:install,    Add elklogger config file
+  elklogger -v,                Show ElkLogger version
+  elklogger -h,                Show help information
+EOF
+  elsif ARGV.first == '-v'
+    puts ElkLogger::VERSION
+  else
+    puts "Wrong argument: #{ARGV.first}, type 'elklogger -h' for more help."
+  end
+else
+  Elklogger::Generator.install
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elklogger.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elklogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elklogger"
+  spec.version       = ElkLogger::VERSION
+  spec.authors       = ["Hayden Wei"]
+  spec.email         = ["haidongrun@gmail.com"]
+
+  spec.summary       = %q{Specific formatted logger for ELK-stack.}
+  spec.description   = %q{Write formatted log infos to log file, used by ELK-stack.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = %w(elklogger) # spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/elklogger/core_ext/object/try.rb

@@ -0,0 +1,15 @@
+class Object
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      __send__(*a, &b)
+    end
+  end
+end
+
+class NilClass
+  def try(*args)
+    nil
+  end
+end

data/lib/elklogger/generator/install_config.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+
+# Install ElkLogger's config file.
+module Elklogger
+  class Generator
+    def self.install
+      src_root = File.dirname(__FILE__)
+      dst_root = FileUtils.pwd #defined?(Rails) ? Rails.root : src_root
+      src = "#{src_root}/template/custom_log.conf"
+      dst = "#{dst_root}/config/elklogger"
+
+      FileUtils.mkdir_p(dst) unless File.directory?(dst)
+      dst += '/custom_log.conf'
+      FileUtils.copy_file(src, dst)
+
+      # Automatically generate logstash input files path, it will be
+      #   "#{the_current_dir}/log/*.log.elk"
+      contents = File.read(dst)
+      contents.gsub!('your_ruby_project_absolute_path', dst_root)
+      File.open(dst, 'w') { |f| f.write contents }
+
+      # TODO Automatically generate kafka servers
+
+      puts "Created config file: #{File.expand_path(dst)}"
+    end
+  end
+end

data/lib/elklogger/generator/template/custom_log.conf

@@ -0,0 +1,25 @@
+input {
+  file {
+    path => "your_ruby_project_absolute_path/log/*.log.elk"
+    # start_position => "beginning"
+  }
+}
+
+filter {
+  json {
+    source => "message"
+    remove_field => ["@version", "@timestamp", "path", "host", "message"]
+  }
+
+}
+
+output {
+  kafka {
+    bootstrap_servers => "your_kafka_bootstrap_servers"
+    topic_id => "EAGLEYE_LOG_CHANNEL"
+  }
+
+  # stdout {
+  #   codec => rubydebug
+  # }
+}

data/lib/elklogger/version.rb

@@ -0,0 +1,6 @@
+require 'logger'
+
+class ElkLogger < Logger
+  SUPER_VERSION = VERSION # keep superclass (Logger) version
+  VERSION = "0.0.6"
+end

data/lib/elklogger.rb

@@ -0,0 +1,112 @@
+require "elklogger/version"
+require "elklogger/core_ext/object/try" unless defined?(try)
+require 'date'
+require 'json/ext'
+require 'socket'
+require 'pathname'
+
+class Logger
+
+  class LogDevice
+    private
+
+    def add_log_header(file); "\n"; end
+  end
+end
+
+class ElkLogger
+
+  module LoggerInfo
+    def ruby_pid; $$.to_s; end
+
+    # In fact, we should record thread's name here. But actually
+    # we don't care about thread name in Ruby, we even more care
+    # about logfile's name. So, here we use logfile name instead
+    # of thread name.
+    # If you want to record thread name, just uncomment the lines
+    # in the following method.
+    def thread_name
+      # Thread.current.inspect.match(/Thread:\w+/).to_s
+    end
+
+    # def method_name; __callee__; end
+    # def class_name; end
+
+    def ipv4_address
+      # First IPv4 address
+      # ipv4_addr = Socket.ip_address_list.detect { |intf| intf.ipv4_private? }
+
+      ipv4_addr = Socket.ip_address_list.detect { |intf|
+        intf.ipv4? and !intf.ipv4_loopback? and !intf.ipv4_multicast?
+        # and !intf.ipv4_private?
+      }
+      ipv4_addr.ip_address unless ipv4_addr.nil?
+    end
+
+    def appname
+      app_name = defined?(Settings) && Settings.try(:elklogger).try(:appname)
+      app_name ? app_name.strip : 'elklogger-not-specified'
+    end
+
+    # TODO How to number each line of log files?
+    def counter_number
+      0
+    end
+  end
+  include LoggerInfo
+
+  undef <<
+  undef fatal?
+  undef fatal
+  undef unknown
+  undef datetime_format=
+  undef datetime_format
+
+  attr_reader :calling_mname, :calling_cname, :filename
+
+  def initialize(logdev, shift_age = 0, shift_size = 1048576)
+    @calling_mname = nil   # calling method name
+    @calling_cname = nil   # calling class name
+    @filename = logdev
+
+    super(logdev, shift_age, shift_size)
+  end
+
+  def format_message(severity, datetime, progname, msg)
+    {
+      :body => msg.to_s,
+      :head => {
+        :app => appname,
+        :level => severity,
+        :counter => counter_number,
+        :tname => thread_name || filename.to_s.split('/').last.to_s.gsub(/\.log\.elk$/, ''),
+        :pid => ruby_pid,
+        :mname => calling_mname,
+        :cname => calling_cname,
+        :ip => ipv4_address.to_s
+      },
+      :timestamp => datetime.to_datetime.strftime("%Q").to_i
+    }.to_json + "\n"
+  end
+
+  private
+
+  SEV_LABEL = %w(DEBUG INFO WARN ERROR ANY)
+
+  def add(severity, message = nil, progname = nil, &block)
+    caller_info = caller_locations(2, 1).first
+    @calling_mname = caller_info.try(:label).to_s
+
+    @calling_cname = caller_info.try(:path).to_s
+    if defined?(Rails) && !@calling_cname.empty?
+      @calling_cname = Pathname.new(@calling_cname).relative_path_from(Rails.root)
+    end
+    @calling_cname = @calling_cname.to_s + ":#{caller_info.try(:lineno).to_s}"
+
+    super(severity, message, progname, &block)
+  end
+
+  class Configuration
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: elklogger
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Hayden Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Write formatted log infos to log file, used by ELK-stack.
+email:
+- haidongrun@gmail.com
+executables:
+- elklogger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/elklogger
+- bin/setup
+- elklogger.gemspec
+- lib/elklogger.rb
+- lib/elklogger/core_ext/object/try.rb
+- lib/elklogger/generator/install_config.rb
+- lib/elklogger/generator/template/custom_log.conf
+- lib/elklogger/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Specific formatted logger for ELK-stack.
+test_files: []
+has_rdoc: