lumberjack_data_dog_device 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c74e54590298ee33cfbb9d042360094f58277417e7ce3827fd3c65d26a0f0d
-  data.tar.gz: 772bed3d6c5f1908b9929e55dae07479ae02ce04942cd515b6c587cc1792b044
+  metadata.gz: addf5b5690d7de27ea3f61b97f0df001a6f8315b6b47cc5252a013ab3dfa9036
+  data.tar.gz: db399010d354397291f19a9173691b875939e33e2db33152dd932d4969371856
 SHA512:
-  metadata.gz: f542690e1f9b8ad79c0673d59ab4fbf42f6733e98fda5f4845c00aad05fbb5da2a7b8db67bd19452a5b31269d48cafe015733539669527bd05e6cfc65fe4e3b7
-  data.tar.gz: 760efdee4a408fa4b52c123a0da1f7daee2a123c657c75cf145770e19959e1e62e734d902aa54dfb86deeb5dfa926d69ab50b2d244fdace2c5b4833a35a4e8ee
+  metadata.gz: 4b7c71c685bc86d831d346911cde9dfd6d101a61b7ff1c5df244c13252446628ca10e186a5107de16c12d9aff79848b820ce183ebaec26b6067a7b37ff3eecb1
+  data.tar.gz: 17c5c871ded8343cb7f8ba1b21162f3eeca41244a313932b0c1f3a3328edc74b449ea23cc79bdf87bae4ff5559bd30ba613568f50375efb96ce6d2fe7eadd38e

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Dependabot update strategy
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    allow:
+      # Automatically keep all runtime dependencies updated
+      - dependency-name: "*"
+        dependency-type: "production"
+    versioning-strategy: lockfile-only

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,46 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+      - actions-*
+    tags:
+      - v*
+  pull_request:
+    branches-ignore:
+      - actions-*
+  workflow_dispatch:
+
+env:
+  BUNDLE_CLEAN: "true"
+  BUNDLE_PATH: vendor/bundle
+  BUNDLE_JOBS: 3
+  BUNDLE_RETRY: 3
+
+jobs:
+  build:
+    name: ${{ matrix.ruby }} build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - ruby: "ruby"
+            standardrb: true
+          - ruby: "3.0"
+          - ruby: "2.7"
+          - ruby: "2.5"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby}}
+    - name: Install gems
+      run: |
+        bundle install
+    - name: Run Tests
+      run: bundle exec rake
+    - name: standardrb
+      if: matrix.standardrb
+      run:  bundle exec standardrb

data/.standard.yml

@@ -0,0 +1,8 @@
+ruby_version: 2.5
+
+format: progress
+
+ignore:
+  - 'spec/**/*':
+    - Lint/UselessAssignment
+    - Lint/Void

data/CHANGE_LOG.md

@@ -1,3 +1,31 @@
-# 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).
+
+## 1.1.0
+
+### Fixed
+
+- Fixed the stack trace on errors to be logged in the correct `error.stack` tag rather than `error.trace`.
+
+### Removed
+
+- Removed support for Ruby 2.4.
+
+## 1.0.1
+
+### Added
+
+- Add optional max_message_length to limit the length of message payload.
+
+### Changed
+
+- Format non-hashes in log messages as strings to prevent stack overflow on objects that cannot be serialized to JSON.
+
+## 1.0.0
+
+### Added
+
+- Initial release

data/README.md

@@ -1,10 +1,14 @@
 # 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)
+[![Continuous Integration](https://github.com/bdurand/lumberjack_data_dog_device/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/lumberjack_data_dog_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_data_dog_device.svg)](https://badge.fury.io/rb/lumberjack_data_dog_device)
 
 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/).
 
+> [!WARNING]
+> This gem is no longer being maintained. It has been replaced by the [`lumberjack_data_dog`](https://github.com/bdurand/lumberjack_data_dog) gem.
+
 * 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).
@@ -21,7 +25,9 @@ This gem provides a logging device that produces JSON output that matches the st
 
 * 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.
+This device extends from [`Lumberjack::JsonDevice`](https://github.com/bdurand/lumberjack_json_device). 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.
+
+You can optionally specify a maximum message length with the `max_message_length` option on the device. Doing so will trucate the message payload to keep it under this number of characters. This option is provided because JSON payloads get messed up and cannot be parsed if they get too big.
 
 ## Example
 
@@ -35,3 +41,31 @@ logger.tag("http.method" => request.method, "http.url" => request.url) do
   )
 end
 ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lumberjack_data_dog_device"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install lumberjack_data_dog_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
+1.1.0

data/lib/lumberjack_data_dog_device.rb

@@ -8,39 +8,48 @@ module Lumberjack
   #
   # 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
+        if trace && device&.respond_to?(:backtrace_cleaner) && device.backtrace_cleaner
           trace = device.backtrace_cleaner.call(trace)
         end
-        hash["trace"] = trace if trace
+        hash["stack"] = 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 }
+          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
@@ -115,7 +124,7 @@ module Lumberjack
         if value.is_a?(Numeric)
           value = (value.to_f * @multiplier).round
         end
-        { "duration" => value }
+        {"duration" => value}
       end
     end
 
@@ -124,14 +133,19 @@ module Lumberjack
     # 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)
+
+    # 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, **args)
+      super(stream_or_device, mapping: data_dog_mapping, **args)
       self.backtrace_cleaner = backtrace_cleaner
+      self.max_message_length = max_message_length
     end
-    
+
     private
-    
+
     def data_dog_mapping
       {
         time: "timestamp",

data/lumberjack_data_dog_device.gemspec

@@ -1,8 +1,8 @@
 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.name = "lumberjack_data_dog_device"
+  spec.version = File.read(File.join(__dir__, "VERSION")).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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   # 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(
+  ignore_files = %w[
     .gitignore
     .travis.yml
     Appraisals
@@ -19,15 +19,14 @@ Gem::Specification.new do |spec|
     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) } }
+  ]
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency "lumberjack_json_device", ">=1.0"
+  spec.required_ruby_version = ">= 2.5"
 
-  spec.add_development_dependency("rspec", ["~> 3.0"])
-  spec.add_development_dependency "rake"
+  spec.add_dependency "lumberjack_json_device", ">=2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_data_dog_device
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2025-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack_json_device
@@ -16,51 +16,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.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: 
+        version: '2.0'
+description:
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".standard.yml"
 - CHANGE_LOG.md
-- MIT_LICENSE
+- MIT_LICENSE.txt
 - README.md
 - VERSION
 - lib/lumberjack_data_dog_device.rb
@@ -69,7 +44,7 @@ homepage: https://github.com/bdurand/lumberjack_data_dog_device
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,15 +52,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 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.4.10
+signing_key:
 specification_version: 4
 summary: A logging device for sending logs to DataDog in JSON format.
 test_files: []