semantic_logger_datadog 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601074c776382fb609d87e888c959a6d9ca99d300a651ab8ac8d68790a4d293e
-  data.tar.gz: 340850a4ddd2c82b54e15256b838d782c4869bcbf37974faf3e0ca8b6e654ac4
+  metadata.gz: 2025f51dda770776569afc5db87ded32b635dc0754070cfddbe1f471bcb6eb4c
+  data.tar.gz: 86dcb7f5a2bb59d130e07e314c7b9bbfa5faa2343a079e39ebedd1190e760ba7
 SHA512:
-  metadata.gz: 2544b4d572b362228616146daeaf98d9eb598cbfbb0544455c43d2059b85793f0dedbd075d425357a45010a7a433eec1d2cae8026c049ce2e821305712bee56a
-  data.tar.gz: 5c2ad0dbac03147d1784ccee0c3e1783fb498b4b604814fecd3600e51e535d45f942b38c5f63c8574f746ef93efd4df68636049c1d32c07aa242ef87c92939c1
+  metadata.gz: 5d9074ab8f9bcb59a4ac1285dd95c400e035dfcbfd315496354a31e05881b898103131fb837dd058af3d2184dd3548c8fe741b8383997099d4611c62f1c40abb
+  data.tar.gz: 324d9f5afcf7b3f3022462a4a17bac09cb83fd7df1f6df4127d24d1c98155186b76033bd5191fcf6ee88970c298dcceaa7dff8a717899711cf904a5186899f2a

data/README.md

@@ -1,6 +1,6 @@
 # semantic_logger_datadog
 
-**[Semantic Logger](https://logger.rocketjob.io) formatter for submitting JSON logs to [Datadog](https://www.datadoghq.com).**
+**[Semantic Logger](https://logger.reidmorrison.com) 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)
@@ -22,7 +22,7 @@ require "semantic_logger_datadog"
 # Set the global default log level.
 SemanticLogger.default_level = :trace
 
-# Log to a file, and use the Datadog formatter.
+# 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.
@@ -32,7 +32,7 @@ logger = SemanticLogger["MyClass"]
 logger.info "Hello, world!"
 ```
 
-Refer to [Semantic Logger's documentation](https://logger.rocketjob.io/customize.html) for more customization options.
+Refer to [Semantic Logger's documentation](https://logger.reidmorrison.com/config.html) for more configuration options.
 
 ## Configuring Ruby on Rails
 
@@ -43,27 +43,11 @@ 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
-```
+The included middleware configures relevant log tags using values provided by [Action Dispatch](https://api.rubyonrails.org/classes/ActionDispatch.html).
 
 ### 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):
+Optionally configure user-specific data in `app/controllers/application_controller.rb` by adding [an `append_info_to_payload` method](https://logger.reidmorrison.com/rails.html#add-custom-data-to-the-completed-message):
 
 ```ruby
 def append_info_to_payload(payload)

data/lib/semantic_logger_datadog/formatters/json.rb

@@ -7,9 +7,18 @@ module SemanticLoggerDatadog
         super
       end
 
+      # Returns log messages in JSON format.
+      #
       # @return [String]
       def call(*)
-        super.to_json
+        SemanticLogger::Utils.to_json(super)
+      end
+
+      # Returns a batch of log messages as a JSON array.
+      #
+      # @return [String]
+      def batch(logs, logger)
+        "[#{logs.map { |log| call(log, logger) }.join(",")}]"
       end
     end
   end

data/lib/semantic_logger_datadog/formatters/raw.rb

@@ -3,6 +3,8 @@
 module SemanticLoggerDatadog
   module Formatters
     class Raw < SemanticLogger::Formatters::Raw
+      # Returns log messages in Hash format.
+      #
       # @return [Hash]
       def call(*)
         super
@@ -66,7 +68,7 @@ module SemanticLoggerDatadog
 
       # Don't log process ID.
       #
-      # @see https://logger.rocketjob.io/customize.html#example-do-not-log-the-process-id
+      # @see https://logger.reidmorrison.com/config.html#:~:text=A%20common%20request%20is%20to%20leave%20out%20the%20process%20id
       #
       # @return [nil]
       def pid

data/lib/semantic_logger_datadog/middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SemanticLoggerDatadog
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+
+      hash = {
+        remote_ip: request.remote_ip,
+        request_id: request.request_id,
+        url: request.original_url,
+        useragent: request.headers["user-agent"],
+      }
+
+      SemanticLogger.named_tagged(hash) { @app.call(env) }
+    end
+  end
+end

data/lib/semantic_logger_datadog/railtie.rb

@@ -6,30 +6,30 @@ rescue LoadError => e
   raise %(semantic_logger_datadog: Install the rails_semantic_logger gem to continue. (#{e}))
 end
 
+require_relative "middleware"
+
 module SemanticLoggerDatadog
   class Railtie < Rails::Railtie
+    # Log to standard output when +RAILS_LOG_TO_STDOUT+ is configured.
+    #
+    # @see https://logger.reidmorrison.com/rails.html#output-formats
+    # @see https://logger.reidmorrison.com/rails.html#production-on-a-container-platform-docker-kubernetes-heroku
+    if ENV["RAILS_LOG_TO_STDOUT"].present?
+      config.rails_semantic_logger.appenders do |appenders|
+        appenders.add(formatter: SemanticLoggerDatadog::Formatters::Json.new, io: $stdout)
+      end
+    end
+
     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
+      # @see https://logger.reidmorrison.com/rails.html#source-file-name-and-line-number
       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
+      app.middleware.insert_before RailsSemanticLogger::Rack::Logger, SemanticLoggerDatadog::Middleware
     end
   end
 end

data/semantic_logger_datadog.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 3.1"
+  spec.required_ruby_version = ">= 3.2"
 
   spec.name          = "semantic_logger_datadog"
-  spec.version       = "0.1.0"
+  spec.version       = "1.0.0"
   spec.authors       = ["CargoSense"]
   spec.email         = ["rubygems@cargosense.com"]
 
@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
   }
 
-  spec.add_dependency "semantic_logger", "~> 4.17"
+  spec.add_dependency "semantic_logger", "~> 5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger_datadog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - CargoSense
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.17'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.17'
+        version: '5.1'
 description: Semantic Logger formatter for submitting JSON logs to Datadog.
 email:
 - rubygems@cargosense.com
@@ -35,6 +35,7 @@ files:
 - lib/semantic_logger_datadog.rb
 - lib/semantic_logger_datadog/formatters/json.rb
 - lib/semantic_logger_datadog/formatters/raw.rb
+- lib/semantic_logger_datadog/middleware.rb
 - lib/semantic_logger_datadog/railtie.rb
 - semantic_logger_datadog.gemspec
 homepage: https://github.com/CargoSense/semantic_logger_datadog
@@ -43,10 +44,10 @@ licenses:
 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
+  documentation_uri: https://rubydoc.info/gems/semantic_logger_datadog/1.0.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
+  source_code_uri: https://github.com/CargoSense/semantic_logger_datadog/tree/v1.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -54,14 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Semantic Logger formatter for submitting JSON logs to Datadog.
 test_files: []