fluentdly 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 288aa9cba6b56656c3e0044e0a3418ce7b80c609
+  data.tar.gz: 426f18f7573293e01a2a3da60a6f51a65379e4df
+SHA512:
+  metadata.gz: 6a81101fad25bd16404d835af2372afb31420e7849a2c60b284ec5919dd49ea63b5d142947efcc5d41fd3b03d0f4be4c651755793a8e00a864d5cace50c6ffc1
+  data.tar.gz: 157c5c791f99a12c42bfb4a3a845f78132a6e3a4825e69479a07dd305daafe3a20367e0073e0d3daf38f8662bee77b7e766df1f72d1853cb20d655e9c5fc5b33

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+* First release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 THE MOBILE TECHNOLOGY COMPANY LIMITED
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Diego Lendoiro
+
+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,80 @@
+# Fluentdly
+
+Fluentdly is a wrapper for easily structured logging HTTP and non HTTP requests using fluent-logger.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluentdly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluentdly
+
+## Examples
+###Configure logger
+
+Setup `fluent-logger` parameters. See [link](https://github.com/fluent/fluent-logger-ruby "fluent-logger doc")
+
+```ruby
+$logger = Fluentdly::Logger.new({:host => 'myhost', :port => 24224, :app_name => 'my_app'})
+
+```
+Configure fluentdly task logger:
+
+```ruby
+
+Fluentdly.configure do |config|
+  config.task_logger = $logger
+end
+
+```
+###Configure middleware HTTP params to log
+
+Custom parameters will merge with default ones: `:method, :query_string and :path`
+
+```ruby
+require 'fluentdly'
+
+  Fluentdly.configure do |config|
+    custom_parameters = {
+      :user_agent => 'HTTP_USER_AGENT',
+      :uri        => 'REQUEST_URI'
+    }
+
+    config.request_parameters custom_parameters
+  end
+```
+###Task logging example
+
+```ruby
+
+Fluentdly::Task.log(:info, {:log_param => 'log_information' ... }) do
+  your_business_logic_here
+
+  [status, result]
+end
+
+```
+
+###Setup middleware
+
+For instance in config.ru for rack applications:
+
+```ruby
+
+use Fluentdly::Rack::Middleware
+
+```
+
+## 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 "fluentdly"
+
+# 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/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/fluentdly.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluentdly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluentdly"
+  spec.version       = Fluentdly::VERSION
+  spec.authors       = ["Diego Lendoiro"]
+  spec.email         = ["diego@iadbox.com"]
+
+  spec.summary       = %q{Sends logs to fluentd agent}
+  spec.description   = %q{Allows to customize messages for sending logs to fluentd}
+  spec.homepage      = "https://github.com/iadbox/fluentdly"
+  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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluent-logger"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-coolline"
+  spec.add_development_dependency "rack"
+end

data/lib/fluentdly.rb

@@ -0,0 +1,20 @@
+require "fluentdly/version"
+require "fluentdly/severity"
+require "fluentdly/logger"
+require "fluentdly/task"
+require "fluentdly/timer"
+require "fluentdly/configuration"
+if Gem::Specification::find_all_by_name('rack').any?
+  require "fluentdly/rack/middleware"
+end
+
+module Fluentdly
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/fluentdly/configuration.rb

@@ -0,0 +1,21 @@
+module Fluentdly
+  class Configuration
+
+    attr_writer :task_logger
+    attr_accessor :request_parameters
+
+    def task_logger
+      @task_logger ||= Logger.new(:host => 'localhost', :port => '24224', :app_name => 'test')
+    end
+
+    def request_parameters custom_parameters = {}
+      @request_parameters = {
+        :method => 'REQUEST_METHOD',
+        :path   => 'PATH_INFO'
+      }
+
+      @request_parameters.merge(custom_parameters)
+    end
+
+  end
+end

data/lib/fluentdly/logger.rb

@@ -0,0 +1,86 @@
+require 'fluent-logger'
+
+module Fluentdly
+  class Logger
+
+    attr_accessor :level, :datetime_format
+
+    def initialize config
+      @host     = config.fetch(:host,     'localhost')
+      @port     = config.fetch(:port,     24224)
+      @app_name = config.fetch(:app_name, 'myapp')
+      @level    = Severity.info
+    end
+
+    def log severity, content = nil, &block
+      message = content || block.call
+      payload = format(message, severity)
+
+      if level <= severity
+        adapter.post(severity, payload)
+      end
+    end
+    alias_method :add, :log
+
+    def debug?
+      level <= Severity.debug
+    end
+    def debug (content = nil, &block)
+      log Severity.debug, content, &block
+    end
+
+    def info?
+      level <= Severity.info
+    end
+    def info (content = nil, &block)
+      log Severity.info, content, &block
+    end
+    alias_method :<<, :info
+
+    def warn?
+      level <= Severity.warn
+    end
+    def warn (content = nil, &block)
+      log Severity.warn, content, &block
+    end
+
+    def error?
+      level <= Severity.error
+    end
+    def error (content = nil, &block)
+      log Severity.error, content, &block
+    end
+
+    def fatal?
+      level <= Severity.fatal
+    end
+    def fatal (content = nil, &block)
+      log Severity.fatal, content, &block
+    end
+
+    def unknown (content = nil, &block)
+      log Severity.unknown, content, &block
+    end
+
+    def close
+      adapter.close
+    end
+
+  private
+
+    attr_reader :host, :port, :app_name
+
+    def format content, severity
+      if content.is_a?(Hash)
+        content.merge(:severity => severity, :service => app_name)
+      else
+        {:message => content, :severity => severity, :service => app_name}
+      end
+    end
+
+    def adapter
+      @adapter ||= Fluent::Logger::FluentLogger.new(app_name, :host=>host, :port=>port)
+    end
+
+  end
+end

data/lib/fluentdly/rack/middleware.rb

@@ -0,0 +1,55 @@
+require "fluentdly/rack/middleware/debug"
+require "fluentdly/rack/middleware/standard"
+
+module Fluentdly
+  module Rack
+    class Middleware
+
+      def initialize app, config = Fluentdly.configuration
+        @app        = app
+        @logger     = config.task_logger
+        @parameters = config.request_parameters
+      end
+
+      def call env
+        time, result = Timer.measure do
+          app.call(env)
+        end
+
+        logger.info(params(env, time, result))
+        result
+      end
+
+    private
+
+      def params env, time, result
+        message = format(env, time, result)
+        status  = get_status(result)
+
+        custom(env).merge :status => status, :message => message, :time => time
+      end
+
+      def format env, time, result
+        if logger.debug?
+          Debug.call(env, time, result)
+        else
+          Standard.call(env, time, result)
+        end
+      end
+
+      def get_status result
+        status, _headers, _body = result
+        status.to_s
+      end
+
+      def custom env
+        parameters.each_with_object({}) do |(k,v), result|
+          result[k] = env[v]
+        end
+      end
+
+      attr_reader :app, :logger, :parameters
+
+    end
+  end
+end

data/lib/fluentdly/rack/middleware/debug.rb

@@ -0,0 +1,42 @@
+require 'rack/request'
+
+module Fluentdly
+  module Rack
+    class Middleware
+      class Debug
+
+        def self.call *args
+          formatter = new(*args)
+          formatter.call
+        end
+
+        def initialize env, time, result
+          @env  = env
+          @time = time
+
+          @status, @headers, @body = result
+        end
+
+        def call
+          %Q(
+          Received #{data.request_method} #{data.path_info}
+            params: #{data.params.inspect}
+          Responded in #{time}ms
+            status: #{status}
+            headers: #{headers}
+            body: #{body.inspect}
+          )
+        end
+
+      private
+
+        def data
+          @data ||= ::Rack::Request.new(env)
+        end
+
+        attr_reader :env, :time, :status, :headers, :body
+
+      end
+    end
+  end
+end

data/lib/fluentdly/rack/middleware/standard.rb

@@ -0,0 +1,47 @@
+require 'rack'
+
+module Fluentdly
+  module Rack
+    class Middleware
+      class Standard
+
+        def self.call *args
+          formatter = new(*args)
+          formatter.call
+        end
+
+        def initialize env, time, result
+          @env  = env
+          @time = time
+
+          @status, _headers, _body = result
+        end
+
+        def call
+          "Completed #{method} #{path} (#{params}) with #{status} in #{time}ms"
+        end
+
+      private
+
+        def method
+          data.request_method
+        end
+
+        def path
+          data.path_info
+        end
+
+        def params
+          data.params
+        end
+
+        def data
+          @data ||= ::Rack::Request.new(env)
+        end
+
+        attr_reader :env, :time, :status
+
+      end
+    end
+  end
+end

data/lib/fluentdly/severity.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+module Fluentdly
+  module Severity
+    include Logger::Severity
+
+    def self.debug
+      DEBUG
+    end
+
+    def self.info
+      INFO
+    end
+
+    def self.warn
+      WARN
+    end
+
+    def self.error
+      ERROR
+    end
+
+    def self.fatal
+      FATAL
+    end
+
+    def self.unknown
+      UNKNOWN
+    end
+
+  end
+end

data/lib/fluentdly/task.rb

@@ -0,0 +1,38 @@
+module Fluentdly
+  class Task
+
+    def self.log severity, parameters, &block
+      task = self.new severity, parameters, block
+      task.call
+    end
+
+    attr_reader :severity, :parameters, :logger, :block
+
+    def initialize severity, parameters, block, config = Fluentdly.configuration
+      @severity   = severity
+      @parameters = parameters
+      @logger     = config.task_logger
+      @block      = block
+    end
+
+    def call
+      began_at       = Time.now
+      status, result = block.call
+      finish_at      = Time.now
+
+      time_diff = finish_at - began_at
+      content = parameters.merge(:status => status, :time => time_diff, :message => format_message(status,time_diff))
+
+      logger.log(severity, content)
+      result
+    end
+
+    private
+
+      def format_message status, time
+        formatted_parameters = parameters.map{ |k,v| "#{k}: #{v}"}.join(", ")
+
+        "Task with params #{formatted_parameters}, finished with #{status} in #{time}"
+      end
+  end
+end

data/lib/fluentdly/timer.rb

@@ -0,0 +1,14 @@
+module Fluentdly
+  class Timer
+
+    def self.measure
+      start_time = Time.now
+      result     = yield
+      end_time   = Time.now
+
+      duration = (end_time - start_time) * 1000
+      [duration, result]
+    end
+
+  end
+end

data/lib/fluentdly/version.rb

@@ -0,0 +1,3 @@
+module Fluentdly
+  VERSION = "0.1.8"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: fluentdly
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Diego Lendoiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  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.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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: Allows to customize messages for sending logs to fluentd
+email:
+- diego@iadbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluentdly.gemspec
+- lib/fluentdly.rb
+- lib/fluentdly/configuration.rb
+- lib/fluentdly/logger.rb
+- lib/fluentdly/rack/middleware.rb
+- lib/fluentdly/rack/middleware/debug.rb
+- lib/fluentdly/rack/middleware/standard.rb
+- lib/fluentdly/severity.rb
+- lib/fluentdly/task.rb
+- lib/fluentdly/timer.rb
+- lib/fluentdly/version.rb
+homepage: https://github.com/iadbox/fluentdly
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sends logs to fluentd agent
+test_files: []