log4r-logdna 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84a0ba052d0d47e86acdd7acdbeced554ee18b2f
+  data.tar.gz: acd2d877b46bf786ad6b36e6e422be408e505008
+SHA512:
+  metadata.gz: 91fd882cddd984df9548a7d195c211d4055d7f8a8407a7b99d062f8b97511571cf76e1f232cea201252d59fea8c3b1e41379253ec144f0239111a65d1283231a
+  data.tar.gz: 60208838b08c28df7e43e5d60267311f38a711c9ab0cf5daebb450763dcad2321c9941c2e5a3ac60db1ab664175245854a66e08b71641c2b98b825f31bcc9afc

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.generators
+.idea
+.rspec
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in log4r-logdna.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mike Machado
+
+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,70 @@
+# Log4r::Logdna
+
+Log4r appender that outputs to LogDNA service. Sends all the Log4r logging context data as LogDNA data
+via the JSON API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log4r-logdna'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log4r-logdna
+
+## Usage
+
+Add the LogdnaOutputter to your log4r configuration:
+
+
+```yaml
+  outputters:
+    - type: LogdnaOutputter
+      name: logdna_output
+```
+
+The LogDNA API key can be set with the `logdna_key` outputter option, or simply by setting the `LOGDNA_KEY` environment
+ variable.
+
+By default, the LogDNA `env` is detected using the `RACK_ENV` environment variable but can be changed via the Outputter
+configuration options.
+
+The LogDNA `app` field is set to the name of the Log4r logger. 
+
+Since LogDNA shows the app name and log level outside of the message, an optimization is to use the `PatternFormatter`
+to drop the logger name and log level, such as:
+
+```yaml
+  outputters:
+    - type: LogdnaOutputter
+      name: logdna_output
+      formatter   :
+        pattern     : '%m'
+        type        : PatternFormatter
+```
+
+Supported optional Outputter options:
+
+<pre>
+  logdna_key: LogDNA API key, if not using the LOGDNA_KEY environment variable
+  hostname: Override auto-detected hostname 
+  ip: Send IP information to LogDNA
+  mac: Send MAC information to LogDNA
+  env: Override auto-detected RACK_ENV value
+</pre>
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LeadDyno/log4r-logdna.
+
+## 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 "log4r/logdna"
+
+# 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(__FILE__)

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/lib/log4r-logdna.rb

@@ -0,0 +1 @@
+require 'log4r-logdna/logdna_outputter'

data/lib/log4r-logdna/logdna_outputter.rb

@@ -0,0 +1,103 @@
+require 'logdna/client'
+require 'log4r/outputter/outputter'
+
+module Log4r
+
+  class LogdnaOutputter < Log4r::Outputter
+
+    def initialize(_name, hash={})
+      super(_name, hash)
+
+      logdna_key = hash['logdna_key'] || ENV['LOGDNA_KEY']
+      opts = {}
+      opts[:hostname] = hash['hostname'] if hash['hostname']
+      opts[:ip] = hash['ip'] if hash['ip']
+      opts[:mac] = hash['mac'] if hash['mac']
+      opts[:env] = hash['env'] || ENV['RACK_ENV']
+
+      @gdc_key = hash.has_key?('global_context_key') ? hash['global_context_key'] : "gdc"
+      @ndc_prefix = hash.has_key?('nested_context_prefix') ? hash['nested_context_prefix'] : "ndc_"
+      @mdc_prefix = hash.has_key?('mapped_context_prefix') ? hash['mapped_context_prefix'] : "mdc_"
+
+      @client = ::Logdna::Client.new(logdna_key, opts)
+    end
+
+    def format_attribute(value)
+      value.inspect
+    end
+
+    private
+
+    def canonical_log(logevent)
+
+      msg = {
+          :level => Log4r::LNAMES[logevent.level]
+      }
+
+      if logevent.data.respond_to?(:backtrace)
+        trace = logevent.data.backtrace
+        if trace
+          msg["_exception"] = format_attribute(logevent.data.class)
+          msg[:message] = "Caught #{logevent.data.class}: #{logevent.data.message}"
+          msg[:full_message] = "Backtrace:\n" + trace.join("\n")
+          msg[:file] = trace[0].split(":")[0]
+          msg[:line] = trace[0].split(":")[1]
+        end
+      end
+
+      if logevent.tracer
+        trace = logevent.tracer.join("\n")
+        msg[:full_message] = "#{msg[:full_message]}\nLog tracer:\n#{trace}"
+        msg[:file] = logevent.tracer[0].split(":")[0]
+        msg[:line] = logevent.tracer[0].split(":")[1]
+      end
+
+      gdc = Log4r::GDC.get
+      if gdc && gdc != $0 && @gdc_key
+        begin
+          msg["_#{@gdc_key}"] = format_attribute(gdc)
+        rescue
+        end
+      end
+
+      if Log4r::NDC.get_depth > 0 && @ndc_prefix
+        Log4r::NDC.clone_stack.each_with_index do |x, i|
+          begin
+            msg["_#{@ndc_prefix}#{i}"] = format_attribute(x)
+          rescue
+          end
+        end
+      end
+
+      mdc = Log4r::MDC.get_context
+      if mdc && mdc.size > 0 && @mdc_prefix
+        mdc.each do |k, v|
+          begin
+            msg["_#{@mdc_prefix}#{k}"] = format_attribute(v)
+          rescue
+          end
+        end
+      end
+
+      # Extract any context values out of the logevent's data hash.
+      if logevent.data.respond_to?(:has_key?)
+        logevent.data.each do |key, value|
+          if key.to_s =~ /^_/
+            msg[key] = value
+          end
+        end
+
+        msg[:message] = logevent.data[:message] if logevent.data.has_key?(:message)
+      end
+
+      msg[:message] = format(logevent) unless msg[:message]
+
+      @client.tobuffer(msg.to_json, {:app => logevent.fullname})
+    rescue => err
+      puts "LogDNA logger. Could not send message: " + err.message
+      puts err.backtrace.join("\n") if err.backtrace
+    end
+
+  end
+
+end

data/lib/log4r-logdna/version.rb

@@ -0,0 +1,5 @@
+module Log4r
+  module Logdna
+    VERSION = "0.3.0"
+  end
+end

data/log4r-logdna.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "log4r-logdna/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "log4r-logdna"
+  spec.version       = Log4r::Logdna::VERSION
+  spec.authors       = ["Mike Machado"]
+  spec.email         = ["mike@leaddyno.com"]
+
+  spec.summary       = %q{Log4r appender that outputs to LogDNA service.}
+  spec.description   = %q{Log4r appender that outputs to LogDNA service.}
+  spec.homepage      = "https://github.com/LeadDyno/log4r-logdna"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("log4r", '~> 1.1.10')
+  spec.add_dependency("logdna", '>= 1.0.9')
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: log4r-logdna
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Mike Machado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+- !ruby/object:Gem::Dependency
+  name: logdna
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Log4r appender that outputs to LogDNA service.
+email:
+- mike@leaddyno.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log4r-logdna.rb
+- lib/log4r-logdna/logdna_outputter.rb
+- lib/log4r-logdna/version.rb
+- log4r-logdna.gemspec
+homepage: https://github.com/LeadDyno/log4r-logdna
+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.12
+signing_key: 
+specification_version: 4
+summary: Log4r appender that outputs to LogDNA service.
+test_files: []