lumberjack_data_dog_device 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60c74e54590298ee33cfbb9d042360094f58277417e7ce3827fd3c65d26a0f0d
+  data.tar.gz: 772bed3d6c5f1908b9929e55dae07479ae02ce04942cd515b6c587cc1792b044
+SHA512:
+  metadata.gz: f542690e1f9b8ad79c0673d59ab4fbf42f6733e98fda5f4845c00aad05fbb5da2a7b8db67bd19452a5b31269d48cafe015733539669527bd05e6cfc65fe4e3b7
+  data.tar.gz: 760efdee4a408fa4b52c123a0da1f7daee2a123c657c75cf145770e19959e1e62e734d902aa54dfb86deeb5dfa926d69ab50b2d244fdace2c5b4833a35a4e8ee

data/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Brian Durand
+
+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,37 @@
+# Lumberjack DataDog Device
+
+[![Build Status](https://travis-ci.org/bdurand/lumberjack_data_dog_device.svg?branch=master)](https://travis-ci.org/bdurand/lumberjack_data_dog_device)
+[![Maintainability](https://api.codeclimate.com/v1/badges/372103b5d762c765a16e/maintainability)](https://codeclimate.com/github/bdurand/lumberjack_data_dog_device/maintainability)
+
+This gem provides a logging device that produces JSON output that matches the standard fields defined for [DataDog logging](https://docs.datadoghq.com/logs/processing/attributes_naming_convention/).
+
+* The time will be sent as "timestamp" with a precision in microseconds.
+
+* The severity will be sent as "status" with a string label (DEBUG, INFO, WARN, ERROR, FATAL).
+
+* The progname will be sent as "logger.name"
+
+* The pid will be sent as "pid".
+
+* The message will be sent as "message". In addition, if the message is an exception, the error message, class, and backtrace will be sent as "error.message", "error.kind", and "error.trace".
+
+* If the "error" tag contains an exception, it will be sent as "error.message", "error.kind", and "error.trace".
+
+* A duration can be sent as a number of seconds in the "duration" tag or as a number of milliseconds in the "duration_ms" tag or as a number of microsectons in the "duration_micros" tag or as a number of nanoseconds in the "duration_ns" tag.
+
+* All other tags are sent as is. If a tag name includes a dot, it will be sent as a nested JSON structure.
+
+This device extends from [`Lumberjack::JsonDevice`](). It is not tied to Data Dog in any way other than that it is opinionated about how to map and format some log tags. It can be used with other services or pipelines without issue.
+
+## Example
+
+You could log an HTTP request to some of the DataDog standard fields like this:
+
+```ruby
+logger.tag("http.method" => request.method, "http.url" => request.url) do
+  logger.info("#{request.method} #{request.path} finished in #{elapsed_time} seconds",
+    duration: elapsed_time,
+    "http.status_code" => response.status
+  )
+end
+```

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/lumberjack_data_dog_device.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "lumberjack_json_device"
+
+module Lumberjack
+  # This Lumberjack device logs output to another device as JSON formatted text that maps fields
+  # to the standard JSON payload for DataDog log collection.
+  #
+  # See https://docs.datadoghq.com/logs/log_collection
+  class DataDogDevice < JsonDevice
+
+    module ExceptionHash
+      
+      protected
+      
+      def exception_hash(exception, device)
+        hash = {"kind" => exception.class.name}
+        hash["message"] = exception.message unless exception.message.nil?
+        trace = exception.backtrace
+        if trace && device && device.respond_to?(:backtrace_cleaner) && device.backtrace_cleaner
+          trace = device.backtrace_cleaner.call(trace)
+        end
+        hash["trace"] = trace if trace
+        hash
+      end
+    end
+    
+    # Formatter to format a messge as an error if it is an exception.
+    class MessageExceptionFormatter
+      include ExceptionHash
+      
+      def initialize(device = nil)
+        @device = device
+      end
+      
+      def call(object)
+        if object.is_a?(Exception)
+          {
+            "message" => object.inspect,
+            "error" => exception_hash(object, @device)
+          }
+        else
+          { "message" => object }
+        end
+      end
+    end
+
+    # Formatter to remove empty tag values and expand the error tag if it is an exception.
+    class DataDogTagsFormatter
+      include ExceptionHash
+
+      def initialize(device = nil)
+        @device = device
+      end
+
+      def call(tags)
+        copy = {}
+        tags.each do |name, value|
+          value = remove_empty_values(value)
+          next if value.nil?
+
+          if name == "error" && value.is_a?(Exception)
+            copy[name] = exception_hash(value, @device)
+          elsif name.include?(".")
+            names = name.split(".")
+            next_value_in_hash(copy, names, value)
+          else
+            copy[name] = value
+          end
+        end
+        copy
+      end
+
+      private
+
+      def remove_empty_values(value)
+        if value.is_a?(String)
+          value unless value.empty?
+        elsif value.is_a?(Hash)
+          new_hash = {}
+          value.each do |key, val|
+            val = remove_empty_values(val)
+            new_hash[key] = val unless val.nil?
+          end
+          new_hash unless new_hash.empty?
+        elsif value.is_a?(Array)
+          new_array = value.collect { |val| remove_empty_values(val) }
+          new_array unless new_array.empty?
+        else
+          value
+        end
+      end
+
+      def next_value_in_hash(hash, keys, value)
+        key = keys.first
+        if keys.size == 1
+          hash[key] = value
+        else
+          current = hash[key]
+          unless current.is_a?(Hash)
+            current = {}
+            hash[key] = current
+          end
+          next_value_in_hash(current, keys[1, keys.size], value)
+        end
+      end
+    end
+
+    class DurationFormatter
+      def initialize(multiplier)
+        @multiplier = multiplier
+      end
+
+      def call(value)
+        if value.is_a?(Numeric)
+          value = (value.to_f * @multiplier).round
+        end
+        { "duration" => value }
+      end
+    end
+
+    # You can specify a backtrace cleaner that will be called with exception backtraces before they
+    # are added to the payload. You can use this to remove superfluous lines, compress line length, etc.
+    # One use for it is to keep stack traces clean and prevent them from overflowing the limit on
+    # the payload size for an individual log entry.
+    attr_accessor :backtrace_cleaner
+    
+    def initialize(stream_or_device, backtrace_cleaner: nil)
+      super(stream_or_device, mapping: data_dog_mapping)
+      self.backtrace_cleaner = backtrace_cleaner
+    end
+    
+    private
+    
+    def data_dog_mapping
+      {
+        time: "timestamp",
+        severity: "status",
+        progname: ["logger", "name"],
+        pid: "pid",
+        message: MessageExceptionFormatter.new(self),
+        duration: DurationFormatter.new(1_000_000_000),
+        duration_ms: DurationFormatter.new(1_000_000),
+        duration_micros: DurationFormatter.new(1_000),
+        duration_ns: "duration",
+        tags: DataDogTagsFormatter.new(self)
+      }
+    end
+  end
+end

data/lumberjack_data_dog_device.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |spec|
+  spec.name = 'lumberjack_data_dog_device'
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ['Brian Durand']
+  spec.email = ['bbdurand@gmail.com']
+
+  spec.summary = "A logging device for sending logs to DataDog in JSON format."
+  spec.homepage = "https://github.com/bdurand/lumberjack_data_dog_device"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_files = %w(
+    .gitignore
+    .travis.yml
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    gemfiles/
+    spec/
+  )
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "lumberjack_json_device", ">=1.0"
+
+  spec.add_development_dependency("rspec", ["~> 3.0"])
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: lumberjack_data_dog_device
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lumberjack_json_device
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.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: rake
+  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: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGE_LOG.md
+- MIT_LICENSE
+- README.md
+- VERSION
+- lib/lumberjack_data_dog_device.rb
+- lumberjack_data_dog_device.gemspec
+homepage: https://github.com/bdurand/lumberjack_data_dog_device
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A logging device for sending logs to DataDog in JSON format.
+test_files: []