elastic-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 330784ef74bac199f5f7e8f9312eb147561da20f
+  data.tar.gz: 92371c2783a123baa12582c0884975adfe62ca18
+SHA512:
+  metadata.gz: ac919df31c20c1541f51d6b572905828e2b22ea1f36e82d5a3f3ec64a5ce4a2692d51745a7d975b532c8b79241a85211a8b4ecf607ab2c45af1f9156632a2761
+  data.tar.gz: 4960f05cff16ed38c99b5c210e2c41827f1dbdbc061ef1f9402ba8d867dd24589d0c13129e7d8cef2fd332eea701f115cb18822b24eff55256146c884fc680c0

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/README.md

@@ -0,0 +1,76 @@
+# ElasticLogger
+
+ElasticLogger is a simple and elastic (;)) solusion for sending JSON logs to elasticsearch but not only there. It works based on writers. Each writer is used to send logs to diffrent destination. Gem is released with two writers one for ElasticSearch and one for standard log files. You can also create your own Writer and use it in config file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elastic-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastic-logger
+
+## Usage Examples
+
+```ruby
+require 'elastic-logger'
+
+# Configuration
+ElasticLogger.configure do |config|
+  config.host = '192.168.60.10:9200'
+  types_file = 'config/elastic_log_config.yml'
+  path = 'log'
+end
+```
+
+### Config file
+With this file we create two logs, one which will log to elastic, and one to standard log file.
+
+```yml
+sidekiq_monitor:
+  writer: 'InfaktLogger::ElastickWriter'
+  rotate_type: 'rotate'
+  rotate: 1
+  backup: false
+api_requests:
+  writer: 'InfaktLogger::DiskWriter'
+  rotate_type: 'rotate'
+  rotate: 3
+  backup: false
+```
+### Usage
+
+```ruby
+logger = ElasticLogger::Logger.new('sidekiq_monitor')
+logger.log(foo: :bar)
+```
+
+### Writers
+
+#### ElastickWriter
+
+Creates daily index named after log name. For sidekiq_monitor it will creates `sidekiq_monitr-%Y.%m.%d` index each day, with `sidekiq_monitor` type and injects there hashes from user input. Next you can go to Kibana and search in it.
+
+#### DiskWriter
+
+It is use by us mostly on devels, when we don't want to use elk for logs. Internally it use ruby `Logger`.
+
+#### Custom Writer
+
+You can create your own writer. It needs two mtethods:
+* `initialize` with `name` and `config` named params
+* `log` with one params with is hash to log.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/elastic-logger.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastic-logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastic-logger"
+  spec.version       = ElasticLogger::VERSION
+  spec.authors       = ["Radosław Woźnik", "Infakt DevTeam"]
+  spec.email         = ["p@infakt.pl"]
+
+  spec.summary       = %q{Elastic Logger, logs to elasticsearch or files}
+  spec.description   = %q{Elastic Logger, logs to elasticsearch or files}
+  spec.homepage      = "https://github.com/infakt/elastic-logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_dependency "elasticsearch", "~> 5.0"
+end

data/lib/elastic-logger.rb

@@ -0,0 +1,16 @@
+require 'elastic_logger/disk_writer'
+require 'elastic_logger/elk_writer'
+
+module ElasticLogger
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/elastic-logger/configuration.rb

@@ -0,0 +1,11 @@
+module ElasticLogger
+  class Configuration
+    attr_accessor :host, :types_file, :path
+
+    def initialize
+      @host = 'localhost:9200'
+      @types_file = 'config/elastic_log_types.yml'
+      @path = 'log'
+    end
+  end
+end

data/lib/elastic-logger/disk_writer.rb

@@ -0,0 +1,25 @@
+module ElasticLogger
+  class DiskWriter
+    def initialize(name:, config:)
+      @config = config
+      @name = name
+    end
+
+    def log(hash)
+      logger.info(hash)
+    end
+
+    private
+    attr_reader :config, :name
+
+    def logger
+      @logger ||= ::Logger.new(path_with(name), 'monthly').tap { |lgger|
+        lgger.formatter = lambda { |_, _, _, msg| msg.to_h.to_json + "\n" }
+      }
+    end
+
+    def path_with(name)
+      Pathname.new(config.path).join("#{name}.log")
+    end
+  end
+end

data/lib/elastic-logger/elk_writer.rb

@@ -0,0 +1,23 @@
+module ElasticLogger
+  class ElkWriter
+    def initialize(name:, config:)
+      @config = config
+      @name = name
+    end
+
+    def log(hash)
+      client.index(index: index, type: name, body: hash)
+    end
+
+    private
+    attr_reader :config, :name
+
+    def client
+      @client ||= Elasticsearch::Client.new(host: config.host)
+    end
+
+    def index
+      "#{name}-#{Date.today.strftime('%Y.%m.%d')}"
+    end
+  end
+end

data/lib/elastic-logger/logger.rb

@@ -0,0 +1,34 @@
+module ElasticLogger
+  class Logger
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def log(hash)
+      writer.log(hash)
+    end
+    alias_method :debug, :log
+    alias_method :info, :log
+    alias_method :warn, :log
+
+    private
+    attr_reader :name
+
+    def writer
+      writer = logs.fetch(name, default).fetch("writer")
+      Object.const_get(writer).new(name: name, config: config)
+    end
+
+    def config
+      @config ||= ElasticLogger.configuration
+    end
+
+    def logs
+      @@logs ||= YAML.load_file(config.types_file)
+    end
+
+    def default
+      { "writer" => "ElasticLogger::NullLogger" }
+    end
+  end
+end

data/lib/elastic-logger/null_writer.rb

@@ -0,0 +1,6 @@
+module ElasticLogger
+  class NullLogger
+    def initialize(name:, config:); end
+    def log(hash); end
+  end
+end

data/lib/elastic-logger/version.rb

@@ -0,0 +1,3 @@
+module ElasticLogger
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: elastic-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Radosław Woźnik
+- Infakt DevTeam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-10 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: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Elastic Logger, logs to elasticsearch or files
+email:
+- p@infakt.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- elastic-logger.gemspec
+- lib/elastic-logger.rb
+- lib/elastic-logger/configuration.rb
+- lib/elastic-logger/disk_writer.rb
+- lib/elastic-logger/elk_writer.rb
+- lib/elastic-logger/logger.rb
+- lib/elastic-logger/null_writer.rb
+- lib/elastic-logger/version.rb
+homepage: https://github.com/infakt/elastic-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
+signing_key: 
+specification_version: 4
+summary: Elastic Logger, logs to elasticsearch or files
+test_files: []