nexus_semantic_logger 1.1.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f12150f394b0f2c56570a19a1979c3f8cf0f58f3c622d6d2886ed6925041825
-  data.tar.gz: 7fc2853cb92631be96b8bc17f07d97eff6057091170704d28ef0280b673ac370
+  metadata.gz: 1f184a3b288517782bc5d96269ae0c063ce0b339beca2e3803053cf367fa07a4
+  data.tar.gz: af2f852f8f3684579a66d01ee88e93bbad5f6a77ee4ad0e6d94bd960d92ffc5c
 SHA512:
-  metadata.gz: dd9b6db086b0b1bb5f8cb760577d87a8603ae892aeeb8e01249081911f3b83068e96357ad0c13a8fa184e96a63efb9f55241bbcc1baa7aa4e513021dd713689b
-  data.tar.gz: '084c137b346270f171132a5de282a3a2019be85fe5a83de3677cedf26290f6f7b1ced55c2ede9cbd57afe9daa6ed9d5d58ddf60ce5e7954d6e3b937753302e30'
+  metadata.gz: 34d4ca84e68c661233ace84517bb97c64bb7b2094ec5074806ae2f8b7e76620f2949f1ea9b0ff1a54ec3ec51d61fee5dc58d33a818cc3784deacbd1d34043a42
+  data.tar.gz: '019e286d210008cc459e342d2af251b8bcf175afbc5b6ca6779e263fe14645bd29751d5a11444f5392fe6007b6cb2cafec2196b5b5fdba09f77288289f6b4ef5'

data/README.md

@@ -1,3 +1,57 @@
 # nexus_semantic_logger
 
 Configures a [semantic_logger](https://rubygems.org/gems/rails_semantic_logger) as required for NexusMods components.
+
+## Telemetry
+
+As well as providing a semantic logger, this gem handles datadog telemetry associated with the logging approach:
+
+* logs
+* traces
+* metrics
+   * statsd is automatically attached to datadog runtime metrics and may also be used for custom metrics.
+
+### Sending metrics
+
+Ensure the metric name is in the format: `nexus.{component}.{major}.{minor}`
+
+Where _major and minor_ are specific to the component logic e.g. `nexus.uploads.clamscan.pass`
+
+For example, to increment a count:
+
+```
+NexusSemanticLogger.metrics.increment('nexus.users.registration.complete')
+```
+
+# Local gem development
+
+Steps to run this gem from local sources in one the nexus 'staged build' rails components:
+
+## Copy gem sources to component
+
+```
+cd ~/legacy/users
+cp -r ../nexus_semantic_logger .
+```
+
+## Adjust component Dockerfile to include gem sources
+
+Within stage 1, append a COPY after the Gemfile copy:
+
+```
+COPY --chown=nexus:nexus Gemfile* ./
+COPY --chown=nexus:nexus nexus_semantic_logger/ ./nexus_semantic_logger/
+```
+
+Within stage 2, append a COPY after the bundle copy:
+
+```
+COPY --from=stage1 /usr/local/bundle /usr/local/bundle
+COPY --from=stage1 /app/nexus_semantic_logger/ /app/nexus_semantic_logger/
+```
+
+## Adjust Gemfile to use local path
+
+```
+gem 'nexus_semantic_logger', :path => "/app/nexus_semantic_logger"
+

data/lib/nexus_semantic_logger/application.rb

@@ -36,6 +36,8 @@ module NexusSemanticLogger
       dd_appender = config.semantic_logger.add_appender(io: $stdout, formatter: config.rails_semantic_logger.format)
       dd_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
 
+      NexusSemanticLogger::DatadogTracer.new(service)
+
       logger.info('SemanticLogger initialised.', level: config.log_level)
     end
 
@@ -48,13 +50,13 @@ module NexusSemanticLogger
       color_appender = config.semantic_logger.add_appender(io: $stdout, formatter: :color)
       color_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
 
-      if ENV['DD_AGENT_HOST'].present? && ENV['DD_AGENT_PORT'].present?
+      if ENV['DD_AGENT_HOST'].present? && ENV['DD_AGENT_LOGGING_PORT'].present?
         # Development logs can be sent to datadog via a TCP logging endpoint on a local agent.
         # Each port is assigned a particular service.
         # See https://logger.rocketjob.io/appenders.html
         dd_appender = config.semantic_logger.add_appender(
           appender: :tcp,
-          server: "#{ENV['DD_AGENT_HOST']}:#{ENV['DD_AGENT_PORT']}",
+          server: "#{ENV['DD_AGENT_HOST']}:#{ENV['DD_AGENT_LOGGING_PORT']}",
           formatter: config.rails_semantic_logger.format
         )
         dd_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda

data/lib/nexus_semantic_logger/datadog_singleton.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'singleton'
+
+module NexusSemanticLogger
+  # Application wide location to get datadog objects.
+  # dogstatsd-ruby maintains its own queue and thread for flushing, so the client code should never create its
+  # own statsd instance.
+  class DatadogSingleton
+    include Singleton
+    attr_accessor :statsd, :tags
+
+    def flush
+      statsd&.flush(sync: Rails.env.development?) # Force flush sync in development, speed up checks.
+    end
+
+    def increment(metric_name)
+      statsd&.increment(metric_name, tags: tags)
+      flush
+    end
+  end
+end

data/lib/nexus_semantic_logger/datadog_tracer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'datadog/statsd'
+require 'ddtrace'
+
+module NexusSemanticLogger
+  class DatadogTracer
+    def initialize(service)
+      Datadog.configure do |c|
+        if ENV['DD_AGENT_HOST'].present?
+          # To enable runtime metrics collection, set `true`. Defaults to `false`
+          # You can also set DD_RUNTIME_METRICS_ENABLED=true to configure this.
+          c.runtime_metrics.enabled = true
+
+          # Configure DogStatsD instance for sending runtime metrics.
+          # By default, runtime metrics from the application are sent to the Datadog Agent with DogStatsD on port 8125.
+          datadog_singleton = DatadogSingleton.instance
+          datadog_singleton.statsd = Datadog::Statsd.new(ENV['DD_AGENT_HOST'], 8125)
+          datadog_singleton.tags = ["env:#{Rails.env}", "service:#{service}"]
+          c.runtime_metrics.statsd = datadog_singleton.statsd
+
+          # Tracer requires configuration to a datadog agent via DD_AGENT_HOST.
+          dd_force_tracer_val = ENV.fetch('DD_FORCE_TRACER', false)
+          dd_force_tracer = dd_force_tracer_val.present? && dd_force_tracer_val.to_s == 'true'
+          c.tracer(enabled: Rails.env.production? || dd_force_tracer, env: Rails.env)
+        end
+
+        c.use(:rails, service_name: service)
+
+        c.logger.level = Logger::WARN # ddtrace info logging is too verbose.
+      end
+    end
+  end
+end

data/lib/nexus_semantic_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSemanticLogger
-  # Leave this as 1.1.0 in order for CI process to replace with the tagged version.
-  VERSION = '1.1.0'
+  # Leave this as 1.3.1 in order for CI process to replace with the tagged version.
+  VERSION = '1.3.1'
 end

data/lib/nexus_semantic_logger.rb

@@ -2,6 +2,12 @@
 require 'nexus_semantic_logger/appender_filter'
 require 'nexus_semantic_logger/application'
 require 'nexus_semantic_logger/datadog_formatter'
+require 'nexus_semantic_logger/datadog_singleton'
+require 'nexus_semantic_logger/datadog_tracer'
 
 module NexusSemanticLogger
+  # Get application wide object for sending metrics.
+  def self.metrics
+    DatadogSingleton.instance
+  end
 end

data/nexus_semantic_logger.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency('amazing_print', '~> 1.4.0')
   spec.add_dependency('rails_semantic_logger', '~> 4.10.0')
   spec.add_dependency('net_tcp_client', '~> 2.2.0') # For TCP logging.
+  spec.add_dependency('dogstatsd-ruby', '~> 5.4.0') # For custom application metrics.
   spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
 description: 
 email: john.harris@nexusmods.com
 executables: []
@@ -66,6 +80,8 @@ files:
 - lib/nexus_semantic_logger/appender_filter.rb
 - lib/nexus_semantic_logger/application.rb
 - lib/nexus_semantic_logger/datadog_formatter.rb
+- lib/nexus_semantic_logger/datadog_singleton.rb
+- lib/nexus_semantic_logger/datadog_tracer.rb
 - lib/nexus_semantic_logger/version.rb
 - nexus_semantic_logger.gemspec
 homepage: 
@@ -86,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: semantic_logger usage for nexus