lumberjack_ecs_device 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb8e82b2c9f2ddd629c9efddf43f63ac4f5b984b754a9466c5d714e22727f0b
-  data.tar.gz: 52bd32275d8e55f1e03cef9aa661e19fcf4de2fe5296c277dcf161cb523a1258
+  metadata.gz: 8ff36214ed38d35a87ea9a68e0eb234ca73b6b91421fbfa6d7e79f98e21464cf
+  data.tar.gz: 6c604f95f79e8aca48fc552c78200c9feb2ba402e13274adaf8490e920c6c060
 SHA512:
-  metadata.gz: 2f0a44ee035ae0053a1d18927051f57d470dbb12b913a18c9e363897ad1148cd74f3d7dd62929377438e9d0657596338ef11b0f32d0951959c8b72e8c7346a29
-  data.tar.gz: 3ce536acc0ba277dc0d193bc5fa1dd8fb0bf779cc53f9235b6f749d9842a11388d8b5eb03f8c53b7125d1d5f4400f6ea3fa5d3919e606800d64eda6b144129a7
+  metadata.gz: 022e7016df06cb1ae4a5b342cfde6905a1303a4ecaa585282c2ec62f089347e9dae11677ff7d75941975ee66f37fcc8493dc1ad17bfedc66d78589b9eaf3daa7
+  data.tar.gz: 715eea4f6041827a06adf890a6ffbdfae6596815e000ff6ffad16f63593cdd477f2afcb8d467a8a6debdf930c903b5dbada1f4520da1a8f5eba0d0cea54db376

data/CHANGE_LOG.md

@@ -1,3 +1,22 @@
-# 1.0.0
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Initial release
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 2.0.0
+
+### Changed
+
+- Requires lumberjack >= 2.0
+- **Breaking Change** Renamed `tags` to `attributes` in the ECS mapping.
+
+### Removed
+
+- Removed support for Ruby < 2.7.
+
+## 1.0.0
+
+### Added
+
+- Initial release

data/README.md

@@ -1,8 +1,8 @@
 # Lumberjack ECS Device
 
-![Continuous Integration](https://github.com/bdurand/lumberjack_ecs_device/workflows/Continuous%20Integration/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/97e98dc4d3d2565a3208/maintainability)](https://codeclimate.com/github/bdurand/lumberjack_ecs_device/maintainability)
+[![Continuous Integration](https://github.com/bdurand/lumberjack_ecs_device/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/lumberjack_ecs_device/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/lumberjack_ecs_device.svg)](https://badge.fury.io/rb/lumberjack_ecs_device)
 
 This gem provides a logging device that produces JSON output that matches the standard fields defined for the [Elastic Common Schema](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html). This allows logs to be sent seamlessly to Kibana or other servers that expect this format.
 
@@ -36,3 +36,31 @@ logger.tag("http.request.method" => request.method, "url.full" => request.url) d
   )
 end
 ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lumberjack_ecs_device"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install lumberjack_ecs_device
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-1.0.0
+2.0.0

data/lib/lumberjack/ecs_device.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "lumberjack_json_device"
+
+# Lumberjack is a simple, powerful, and fast logging library for Ruby.
+module Lumberjack
+  # This Lumberjack device logs output to another device as JSON formatted text that maps fields
+  # to the standard ECS JSON format.
+  #
+  # See https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html
+  class EcsDevice < JsonDevice
+    VERSION = ::File.read(::File.join(__dir__, "..", "..", "VERSION")).strip.freeze
+
+    DeviceRegistry.add(:ecs, self)
+
+    # Mixin module that provides helper methods for formatting exception objects into hash format
+    # compatible with ECS error field structure.
+    module ExceptionHash
+      protected
+
+      def exception_hash(exception, device)
+        hash = {"type" => exception.class.name}
+        hash["message"] = exception.message unless exception.message.nil?
+        trace = exception.backtrace
+        if trace && device&.respond_to?(:backtrace_cleaner) && device.backtrace_cleaner
+          trace = device.backtrace_cleaner.call(trace)
+        end
+        hash["stack_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
+
+      # Formats a message object into a hash with a "message" field and optionally an "error" field
+      # if the object is an exception.
+      #
+      # @param object [Object] The object to format (usually a message or exception)
+      # @return [Hash] A hash containing the formatted message and optional error information
+      def call(object)
+        if object.is_a?(Exception)
+          {
+            "message" => object.inspect,
+            "error" => exception_hash(object, @device)
+          }
+        elsif object.is_a?(Hash)
+          {"message" => object}
+        elsif object.nil?
+          {"message" => nil}
+        else
+          message = object.to_s
+          max_message_length = @device.max_message_length
+          if max_message_length && message.length > max_message_length
+            message = message[0, max_message_length]
+          end
+          {"message" => message}
+        end
+      end
+    end
+
+    # Formatter to remove empty attribute values and expand the error tag if it is an exception.
+    class EcsTagsFormatter
+      include ExceptionHash
+
+      def initialize(device = nil)
+        @device = device
+      end
+
+      # Processes tags by removing empty values and converting exceptions to ECS error format.
+      # Also handles nested field names using dot notation.
+      #
+      # @param tags [Hash] The tags hash to process
+      # @return [Hash] A processed hash with empty values removed and exceptions converted
+      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
+
+    # Formatter that converts duration values to ECS event.duration format with proper units.
+    class DurationFormatter
+      def initialize(multiplier)
+        @multiplier = multiplier
+      end
+
+      # Formats a numeric duration value by applying a multiplier and wrapping it in ECS event structure.
+      #
+      # @param value [Numeric, Object] The duration value to format
+      # @return [Hash] A hash containing the formatted duration in ECS event.duration format
+      def call(value)
+        if value.is_a?(Numeric)
+          value = (value.to_f * @multiplier).round
+        end
+        {"event" => {"duration" => value}}
+      end
+    end
+
+    # The default timestamp format used for ECS @timestamp field.
+    # Format: ISO 8601 with microseconds and UTC timezone (e.g., "2023-12-01T14:30:45.123456Z")
+    ECS_TIMESTAMP_FORMAT = "%Y-%m-%dT%H:%M:%S.%6NZ"
+
+    # 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
+
+    # You can specify a limit on the message size. Messages over this size will be split into multiple
+    # log entries to prevent overflowing the limit on message size which makes the log entries unparseable.
+    attr_accessor :max_message_length
+
+    def initialize(stream_or_device, backtrace_cleaner: nil, max_message_length: nil, datetime_format: ECS_TIMESTAMP_FORMAT)
+      super(output: stream_or_device, mapping: ecs_mapping, datetime_format: datetime_format)
+      self.backtrace_cleaner = backtrace_cleaner
+      self.max_message_length = max_message_length
+      @utc_timestamps = !!datetime_format.match(/[^%]Z/)
+    end
+
+    # Converts a log entry to JSON format, ensuring timestamps are in UTC if required.
+    #
+    # @param entry [Lumberjack::LogEntry] The log entry to convert
+    # @return [String] The JSON representation of the log entry
+    def entry_as_json(entry)
+      original_time = entry.time
+      begin
+        entry.time = entry.time.utc if @utc_timestamps && !entry.time.utc?
+        super
+      ensure
+        entry.time = original_time
+      end
+    end
+
+    private
+
+    def ecs_mapping
+      {
+        time: "@timestamp",
+        severity: ["log", "level"],
+        progname: ["process", "name"],
+        pid: ["process", "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: ["event", "duration"],
+        attributes: EcsTagsFormatter.new(self)
+      }
+    end
+  end
+end

data/lib/lumberjack_ecs_device.rb

@@ -1,175 +1,3 @@
 # 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 ECS JSON format.
-  #
-  # See https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html
-  class EcsDevice < JsonDevice
-    module ExceptionHash
-      protected
-
-      def exception_hash(exception, device)
-        hash = {"type" => 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["stack_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)
-          }
-        elsif object.is_a?(Hash)
-          {"message" => object}
-        elsif object.nil?
-          {"message" => nil}
-        else
-          message = object.to_s
-          max_message_length = @device.max_message_length
-          if max_message_length && message.length > max_message_length
-            message = message[0, max_message_length]
-          end
-          {"message" => message}
-        end
-      end
-    end
-
-    # Formatter to remove empty tag values and expand the error tag if it is an exception.
-    class EcsTagsFormatter
-      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
-        {"event" => {"duration" => value}}
-      end
-    end
-
-    ECS_TIMESTAMP_FORMAT = "%Y-%m-%dT%H:%M:%S.%6NZ"
-
-    # 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
-
-    # You can specify a limit on the message size. Messages over this size will be split into multiple
-    # log entries to prevent overflowing the limit on message size which makes the log entries unparseable.
-    attr_accessor :max_message_length
-
-    def initialize(stream_or_device, backtrace_cleaner: nil, max_message_length: nil, datetime_format: ECS_TIMESTAMP_FORMAT)
-      super(stream_or_device, mapping: ecs_mapping, datetime_format: datetime_format)
-      self.backtrace_cleaner = backtrace_cleaner
-      self.max_message_length = max_message_length
-      @utc_timestamps = !!datetime_format.match(/[^%]Z/)
-    end
-
-    def entry_as_json(entry)
-      original_time = entry.time
-      begin
-        entry.time = entry.time.utc if @utc_timestamps && !entry.time.utc?
-        super
-      ensure
-        entry.time = original_time
-      end
-    end
-
-    private
-
-    def ecs_mapping
-      {
-        time: "@timestamp",
-        severity: ["log", "level"],
-        progname: ["process", "name"],
-        pid: ["process", "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: ["event", "duration"],
-        tags: EcsTagsFormatter.new(self)
-      }
-    end
-  end
-end
+require_relative "lumberjack/ecs_device"

data/lumberjack_ecs_device.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "lumberjack_ecs_device"
-  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.version = File.read(File.join(__dir__, "VERSION")).strip
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/lumberjack_ecs_device"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGE_LOG.md"
+  }
+
   # 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[
@@ -24,5 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "lumberjack_json_device", ">=1.0"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.add_dependency "lumberjack_json_device", ">=3.0"
+
+  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_ecs_device
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack_json_device
@@ -16,15 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: 
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
 email:
 - bbdurand@gmail.com
 executables: []
@@ -32,16 +44,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGE_LOG.md
-- MIT_LICENSE
+- MIT_LICENSE.txt
 - README.md
 - VERSION
+- lib/lumberjack/ecs_device.rb
 - lib/lumberjack_ecs_device.rb
 - lumberjack_ecs_device.gemspec
 homepage: https://github.com/bdurand/lumberjack_ecs_device
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bdurand/lumberjack_ecs_device
+  source_code_uri: https://github.com/bdurand/lumberjack_ecs_device
+  changelog_uri: https://github.com/bdurand/lumberjack_ecs_device/blob/main/CHANGE_LOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -49,15 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A logging device for formatting logs in Elastic Container Schema (ECS) format
   for integration with Kibana.