lumberjack_data_dog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746fb699cb9f259ed561b070a1a3939573c052a2354cc7edbe7bf2b72084cf1e
-  data.tar.gz: 0647be2db0eac1df4c77ef89e5859396cd345a5b1291419a8ece171aff3bd48a
+  metadata.gz: 53517e1a4626e2ca86c9a78968008ce667612cb8121ad769a82484056ab7d23c
+  data.tar.gz: 3ad569bd2691572c29fbb14dfd569cde90ad8c38bd36dda3f0c720ce33b19e88
 SHA512:
-  metadata.gz: 6232d656b9202c58b504c8eeb1a1904dbb85d06ed3d80d2e302d7cd0fd4657b2874685d3396e4b777ded9f7cd180fd1ddbbd1b192e78be0a160ac32b3806b4ce
-  data.tar.gz: '01209a5f00a204706e100cb6d389f5fac1b46f0ebe5ab39b12558c32811cf727813d5a1fe9b810599cd43d93b51182354a089e7de70e9d8312157c55b8aa7daf'
+  metadata.gz: b52261c574346d6dad7fc25a2d898c7ae6280a8b8487aeb4341df43ba5d1c5e6a3cb692582dc3d97d7222ab386765fc9c49147adeb1145338a8abbec3e999b22
+  data.tar.gz: 829c023744c9bc34c1c96f02fe1facde15ccd2eaab80f0e29712679d252bfcccec4d154a9dd54d5c599532fe8c8c8dbc4cd0b6dff0458569b5951e6f07a0a761

data/.github/workflows/continuous_integration.yml

@@ -3,10 +3,8 @@ name: Continuous Integration
 on:
   push:
     branches:
-      - master
+      - main
       - actions-*
-    tags:
-      - v*
   pull_request:
     branches-ignore:
       - actions-*
@@ -29,9 +27,8 @@ jobs:
             standardrb: true
           - ruby: "3.0"
           - ruby: "2.7"
-          - ruby: "2.5"
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.standard.yml

@@ -1,4 +1,4 @@
-ruby_version: 2.5
+ruby_version: 2.7
 
 format: progress
 

data/CHANGE_LOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 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
+
+### Added
+
+- Support for Lumberjack 2.0.
+
+### Changed
+
+- This is the last release for the gem under the `lumberjack_data_dog` name. Future updates are being released under the name `lumberjack_datadog`.
+
+### Removed
+
+- Support for Ruby < 2.7
+
+## 1.0.1
+
+### Added
+
+- Logger options can now be sent to `Lumberjack::DataDog.setup`.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -4,6 +4,9 @@
 [![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.svg)](https://badge.fury.io/rb/lumberjack_data_dog)
 
+> [!IMPORTANT]
+> This gem has been renamed to [`lumberjack_datadog`](https://github.com/bdurand/lumberjack_datadog). For new versions switch using that gem.
+
 This gem provides a logging setup for using the [lumberjack](https://github.com/bdurand/lumberjack) gem with DataDog. It sets up JSON logging and maps values to DataDog's [standard attributes](https://docs.datadoghq.com/logs/processing/attributes_naming_convention/).
 
 ## Features
@@ -17,7 +20,7 @@ This gem provides a logging setup for using the [lumberjack](https://github.com/
 - **Duration Logging**: Automatic conversion of duration values to nanoseconds for DataDog
 - **Configurable Message Truncation**: Limit message length to prevent oversized logs
 - **Thread Information**: Optional thread name logging
-- **Tag Remapping**: Flexible tag transformation and remapping
+- **attribute Remapping**: Flexible attribute transformation and remapping
 - **Pretty JSON**: Optional pretty-printed JSON output for development
 
 ## Usage
@@ -39,7 +42,9 @@ logger.error("Something went wrong", request_id: "abc-123")
 ### Advanced Configuration
 
 ```ruby
-logger = Lumberjack::DataDog.setup do |config|
+# The output device and logger options can be passed in the setup method.
+# These are passed through to Lumberjack::Logger.new.
+logger = Lumberjack::DataDog.setup(log_device, level: :info) do |config|
   # Truncate messages longer than 1000 characters
   config.max_message_length = 1000
 
@@ -49,12 +54,16 @@ logger = Lumberjack::DataDog.setup do |config|
   # Disable PID logging
   config.pid = false
 
-  # Remap custom tags to DataDog attributes
-  config.remap_tags(
+  # Remap custom attributes to DataDog attributes
+  config.remap_attributes(
     user_id: "usr.id",
     request_id: "http.request_id"
   )
 
+  # Add a backtrace cleaner to remove unnecessary noise when logging exceptions.
+  # The cleaner object must respond to `clean` method.
+  config.backtrace_cleaner = Rails.backtrace_cleaner
+
   # Enable pretty JSON for development
   config.pretty = true
 end
@@ -64,10 +73,8 @@ end
 
 ```ruby
 # Log to a file instead of STDOUT
-File.open("/var/log/app.log", "a") do |file|
-  logger = Lumberjack::DataDog.setup(file)
-  logger.info("Logged to file")
-end
+logger = Lumberjack::DataDog.setup("/var/log/app.log")
+logger.info("Logged to file")
 ```
 
 ### Exception Logging
@@ -102,11 +109,11 @@ logger.info("API call", duration_micros: 1500)   # microseconds
 logger.info("Function", duration_ns: 1500000)    # nanoseconds
 ```
 
-### Custom Tag Transformation
+### Custom attribute Transformation
 
 ```ruby
 logger = Lumberjack::DataDog.setup do |config|
-  config.remap_tags(
+  config.remap_attributes(
     # Simple remapping
     correlation_id: "trace.correlation_id",
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/lumberjack/data_dog.rb

@@ -15,8 +15,8 @@ module Lumberjack::DataDog
     attr_accessor :backtrace_cleaner
     attr_accessor :thread_name
     attr_accessor :pid
-    attr_accessor :allow_all_tags
-    attr_reader :tag_mapping
+    attr_accessor :allow_all_attributes
+    attr_reader :attribute_mapping
     attr_accessor :pretty
 
     def initialize
@@ -24,13 +24,13 @@ module Lumberjack::DataDog
       @backtrace_cleaner = nil
       @thread_name = false
       @pid = true
-      @allow_all_tags = true
-      @tag_mapping = {}
+      @allow_all_attributes = true
+      @attribute_mapping = {}
       @pretty = false
     end
 
-    def remap_tags(tag_mapping)
-      @tag_mapping = @tag_mapping.merge(tag_mapping)
+    def remap_attributes(attribute_mapping)
+      @attribute_mapping = @attribute_mapping.merge(attribute_mapping)
     end
 
     def validate!
@@ -45,51 +45,51 @@ module Lumberjack::DataDog
   end
 
   class << self
-    def setup(stream = $stdout, &block)
+    def setup(stream = $stdout, options = {}, &block)
       config = Config.new
       yield(config) if block_given?
       config.validate!
 
-      new_logger(stream, config)
+      new_logger(stream, options, config)
     end
 
     private
 
-    def new_logger(stream, config)
-      logger = Lumberjack::Logger.new(json_device(stream, config))
+    def new_logger(stream, options, config)
+      logger = Lumberjack::Logger.new(json_device(stream, config), **options)
 
-      # Add the error to the error tag if an exception is logged as the message.
+      # Add the error to the error attribute if an exception is logged as the message.
       logger.message_formatter.add(Exception, message_exception_formatter)
 
-      # Split the error tag up into standard attributes if it is an exception.
-      logger.tag_formatter.add(Exception, exception_tag_formatter(config))
+      # Split the error attribute up into standard attributes if it is an exception.
+      logger.attribute_formatter.add(Exception, exception_attribute_formatter(config))
 
       if config.thread_name
         if config.thread_name == :global
-          logger.tag_globally("logger.thread_name" => -> { Lumberjack::Utils.global_thread_id })
+          logger.tag!("logger.thread_name" => -> { Lumberjack::Utils.global_thread_id })
         else
-          logger.tag_globally("logger.thread_name" => -> { Lumberjack::Utils.thread_name })
+          logger.tag!("logger.thread_name" => -> { Lumberjack::Utils.thread_name })
         end
       end
 
       if config.pid == :global
-        logger.tag_globally("pid" => -> { Lumberjack::Utils.global_pid })
+        logger.tag!("pid" => -> { Lumberjack::Utils.global_pid })
       end
 
       logger
     end
 
     def json_device(stream, config)
-      Lumberjack::JsonDevice.new(stream, mapping: json_mapping(config), pretty: config.pretty)
+      Lumberjack::JsonDevice.new(output: stream, mapping: json_mapping(config), pretty: config.pretty)
     end
 
     def json_mapping(config)
-      mapping = config.tag_mapping.transform_keys(&:to_sym)
+      mapping = config.attribute_mapping.transform_keys(&:to_sym)
       mapping = mapping.merge(STANDARD_ATTRIBUTE_MAPPING)
 
       mapping.delete(:pid) if !config.pid || config.pid == :global
 
-      mapping[:tags] = "*" if config.allow_all_tags
+      mapping[:attributes] = "*" if config.allow_all_attributes
 
       mapping[:message] = if config.max_message_length
         truncate_message_transformer(config.max_message_length)
@@ -129,15 +129,15 @@ module Lumberjack::DataDog
       end
     end
 
-    def exception_tag_formatter(config)
+    def exception_attribute_formatter(config)
       lambda do |error|
-        error_tags = {"kind" => error.class.name, "message" => error.message}
+        error_attributes = {"kind" => error.class.name, "message" => error.message}
         trace = error.backtrace
         if trace
           trace = config.backtrace_cleaner.clean(trace) if config.backtrace_cleaner
-          error_tags["stack"] = trace
+          error_attributes["stack"] = trace
         end
-        error_tags
+        error_attributes
       end
     end
   end

data/lumberjack_data_dog.gemspec

@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/lumberjack_data_dog"
   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[
@@ -26,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "lumberjack_json_device", ">= 2.0.0"
+  spec.add_dependency "lumberjack_json_device", ">= 3.0.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_data_dog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-19 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,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description:
+        version: 3.0.0
 email:
 - bbdurand@gmail.com
 executables: []
@@ -44,8 +42,10 @@ files:
 homepage: https://github.com/bdurand/lumberjack_data_dog
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/lumberjack_data_dog
+  source_code_uri: https://github.com/bdurand/lumberjack_data_dog
+  changelog_uri: https://github.com/bdurand/lumberjack_data_dog/blob/main/CHANGE_LOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Lumberjack logging device that outputs JSON formatted for DataDog with standard
   attribute mapping.