semantic_logger_datadog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 601074c776382fb609d87e888c959a6d9ca99d300a651ab8ac8d68790a4d293e
+  data.tar.gz: 340850a4ddd2c82b54e15256b838d782c4869bcbf37974faf3e0ca8b6e654ac4
+SHA512:
+  metadata.gz: 2544b4d572b362228616146daeaf98d9eb598cbfbb0544455c43d2059b85793f0dedbd075d425357a45010a7a433eec1d2cae8026c049ce2e821305712bee56a
+  data.tar.gz: 5c2ad0dbac03147d1784ccee0c3e1783fb498b4b604814fecd3600e51e535d45f942b38c5f63c8574f746ef93efd4df68636049c1d32c07aa242ef87c92939c1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CargoSense, Inc.
+
+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,81 @@
+# semantic_logger_datadog
+
+**[Semantic Logger](https://logger.rocketjob.io) formatter for submitting JSON logs to [Datadog](https://www.datadoghq.com).**
+
+[![Gem](https://img.shields.io/gem/v/semantic_logger_datadog.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/semantic_logger_datadog)
+[![Downloads](https://img.shields.io/gem/dt/semantic_logger_datadog.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/semantic_logger_datadog)
+[![Build](https://img.shields.io/github/actions/workflow/status/CargoSense/semantic_logger_datadog/ci.yml?logo=github&style=for-the-badge)](https://github.com/CargoSense/semantic_logger_datadog/actions/workflows/ci.yml)
+
+## Installation
+
+Add semantic_logger_datadog to your project's `Gemfile` and run `bundle install`:
+
+```ruby
+gem "semantic_logger_datadog"
+```
+
+## Usage
+
+```ruby
+require "semantic_logger_datadog"
+
+# Set the global default log level.
+SemanticLogger.default_level = :trace
+
+# Log to a file, and use the Datadog formatter.
+SemanticLogger.add_appender(file_name: "development.log", formatter: SemanticLoggerDatadog::Formatters::Json.new)
+
+# Create an instance of a logger and add the class name to every log message.
+logger = SemanticLogger["MyClass"]
+
+# Log an info message to devleopment.log
+logger.info "Hello, world!"
+```
+
+Refer to [Semantic Logger's documentation](https://logger.rocketjob.io/customize.html) for more customization options.
+
+## Configuring Ruby on Rails
+
+In addition to semantic_logger_datadog, add the [rails_semantic_logger](https://rubygems.org/gems/rails_semantic_logger) gem to your project's Gemfile:
+
+```ruby
+gem "rails_semantic_logger"
+gem "semantic_logger_datadog"
+```
+
+Configure named tags in `config/application.rb`:
+
+```ruby
+module App
+  class Application < Rails::Application
+    # Your app's existing configuration goes here…
+
+    # Configure named tags to add to every log message.
+    config.log_tags = {
+      remote_ip: :remote_ip,
+      request_id: :request_id,
+      url: ->(request) { request.original_url },
+      useragent: ->(request) { request.headers["user-agent"] },
+    }
+  end
+end
+```
+
+### Adding custom controller action data
+
+Optionally configure user-specific data in `app/controllers/application_controller.rb` by adding [an `append_info_to_payload` method](https://logger.rocketjob.io/rails.html#adding-custom-data-to-the-rails-completed-log-message):
+
+```ruby
+def append_info_to_payload(payload)
+  super
+
+  payload[:usr] = current_user.slice(:id, :name, :email) if user_signed_in?
+end
+```
+
+> [!IMPORTANT]
+> Be extremely careful when logging personally-identifiable information. If you aren't required to log this information for legal or regulatory reasons, don't! Your logs can't leak data they never stored in the first place.
+
+## License
+
+semantic_logger_datadog is freely available under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/semantic_logger_datadog/formatters/json.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SemanticLoggerDatadog
+  module Formatters
+    class Json < Raw
+      def initialize(time_format: :iso_8601, time_key: :timestamp, **args)
+        super
+      end
+
+      # @return [String]
+      def call(*)
+        super.to_json
+      end
+    end
+  end
+end

data/lib/semantic_logger_datadog/formatters/raw.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module SemanticLoggerDatadog
+  module Formatters
+    class Raw < SemanticLogger::Formatters::Raw
+      # @return [Hash]
+      def call(*)
+        super
+
+        request_id
+        dd_hash
+        http_hash
+        logger_hash
+        usr_hash
+
+        hash
+      end
+
+      # @return [Hash{Symbol => String}, nil]
+      def dd_hash
+        hash[:dd] = log.named_tags.delete(:dd)
+      end
+
+      # @return [String, nil]
+      def duration
+        return unless log.duration
+
+        # Convert milliseconds to nanoseconds
+        hash[:duration] = log.duration * 1_000_000
+        hash[:duration_human] = log.duration_human
+      end
+
+      # @return [Hash]
+      def exception
+        return unless log.exception
+
+        kind = log.exception.class.name
+        message = log.exception.message
+        stack = log.backtrace_to_s
+
+        hash.merge!(
+          error: { kind:, message:, stack: }.compact,
+          message: [kind, message].compact.join(": ")
+        )
+      end
+
+      # @return [Hash{Symbol => Hash{Symbol => String}}]
+      def http_hash
+        method, status_code = [:method, :status].map { |key| log.payload&.delete(key) }
+        remote_ip, url, useragent = [:remote_ip, :url, :useragent].map { |key| log.named_tags.delete(key) }
+
+        http = { method:, remote_ip:, status_code:, url:, useragent: }
+
+        http.compact!
+
+        hash[:http] = http unless http.empty?
+      end
+
+      # @return [Hash{Symbol => String}]
+      def logger_hash
+        hash[:logger] = {
+          name: logger.name,
+          thread_name: log.thread_name,
+        }
+      end
+
+      # Don't log process ID.
+      #
+      # @see https://logger.rocketjob.io/customize.html#example-do-not-log-the-process-id
+      #
+      # @return [nil]
+      def pid
+      end
+
+      # @return [String]
+      def request_id
+        hash[:request_id] = log.named_tags.delete(:request_id)
+      end
+
+      # @return [Hash{Symbol => Integer, String}, nil]
+      def usr_hash
+        hash[:usr] = log.payload&.delete(:usr)
+      end
+    end
+  end
+end

data/lib/semantic_logger_datadog/railtie.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require "rails_semantic_logger"
+rescue LoadError => e
+  raise %(semantic_logger_datadog: Install the rails_semantic_logger gem to continue. (#{e}))
+end
+
+module SemanticLoggerDatadog
+  class Railtie < Rails::Railtie
+    initializer "semantic_logger_datadog.configure_rails_initialization" do |app|
+      # Set application name.
+      app.config.semantic_logger.application = Rails.application.name
+
+      # Set backtrace level to avoid memory leaks due to high object allocation.
+      #
+      # @see https://logger.rocketjob.io/rails.html#include-the-file-name-and-line-number-in-the-source-code-where-the-message-originated
+      app.config.semantic_logger.backtrace_level = :error if Rails.env.production?
+
+      # Set log output format.
+      #
+      # @see https://logger.rocketjob.io/rails.html#output-format
+      app.config.rails_semantic_logger.format = SemanticLoggerDatadog::Formatters::Json.new
+
+      # Log to standard output when +RAILS_LOG_TO_STDOUT+ is configured.
+      #
+      # @see https://logger.rocketjob.io/rails.html#log-to-standard-out
+      if ENV["RAILS_LOG_TO_STDOUT"].present?
+        $stdout.sync = true
+        app.config.rails_semantic_logger.add_file_appender = false
+        app.config.semantic_logger.add_appender(formatter: app.config.rails_semantic_logger.format, io: $stdout)
+      end
+    end
+  end
+end

data/lib/semantic_logger_datadog.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "semantic_logger"
+
+require_relative "semantic_logger_datadog/formatters/raw"
+require_relative "semantic_logger_datadog/formatters/json"
+
+require_relative "semantic_logger_datadog/railtie" if defined?(Rails::Railtie)

data/semantic_logger_datadog.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.name          = "semantic_logger_datadog"
+  spec.version       = "0.1.0"
+  spec.authors       = ["CargoSense"]
+  spec.email         = ["rubygems@cargosense.com"]
+
+  spec.summary       = "Semantic Logger formatter for submitting JSON logs to Datadog."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/CargoSense/semantic_logger_datadog"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["lib/**/*"].reject { |f| File.directory?(f) }
+  spec.files        += ["LICENSE", "README.md"]
+  spec.files        += ["semantic_logger_datadog.gemspec"]
+
+  spec.require_paths = ["lib"]
+
+  spec.metadata = {
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/releases",
+    "documentation_uri" => "https://rubydoc.info/gems/#{spec.name}/#{spec.version}",
+    "homepage_uri" => spec.homepage,
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
+  }
+
+  spec.add_dependency "semantic_logger", "~> 4.17"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: semantic_logger_datadog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CargoSense
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+description: Semantic Logger formatter for submitting JSON logs to Datadog.
+email:
+- rubygems@cargosense.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/semantic_logger_datadog.rb
+- lib/semantic_logger_datadog/formatters/json.rb
+- lib/semantic_logger_datadog/formatters/raw.rb
+- lib/semantic_logger_datadog/railtie.rb
+- semantic_logger_datadog.gemspec
+homepage: https://github.com/CargoSense/semantic_logger_datadog
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/CargoSense/semantic_logger_datadog/issues
+  changelog_uri: https://github.com/CargoSense/semantic_logger_datadog/releases
+  documentation_uri: https://rubydoc.info/gems/semantic_logger_datadog/0.1.0
+  homepage_uri: https://github.com/CargoSense/semantic_logger_datadog
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/CargoSense/semantic_logger_datadog/tree/v0.1.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Semantic Logger formatter for submitting JSON logs to Datadog.
+test_files: []