nexus_semantic_logger 1.2.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb3fba7b28b1b186a3e601dc9901c94acf9db07c5f40b2a4c2357104fcda507
-  data.tar.gz: d32b561ab333d7240b4d752e3a3faffa1ad95102882644eb045224f3bb493f44
+  metadata.gz: e650ec4b4c57cb7d85a5abde066ef34219502ff5d995e37fdf2b431833b2a086
+  data.tar.gz: 6285058765fa7ff89bf071714bcdd1978c83b4f64dfd17c2ddffc5a3843e190b
 SHA512:
-  metadata.gz: 23af7bf651c2f48db0411ae861d36a81d652de9af6da5c275b04f66781d45657abecbf31521cb825a7977a90fa32dac3872f3fe47fc3ec07396928b717abb648
-  data.tar.gz: 9523b13f81fb98da9712e0af779f3b59ff85ae7ba23269c3c2f2845ac91b2ec77674e4cf5985334c1445273d1f12f81dbdba6049d6270ccfb5a6ff454ec30136
+  metadata.gz: dfbe1816ddd0f82a9009e863b94d4efe76551a35511df893a74ef328b1fee41964b2b0bdeaa219355da3e3fa03e00e9e2fb3b129d2459bbea1332ba37069c6f4
+  data.tar.gz: 70bc5a9ba7bc1d24b8dbac2fc84afbf7bb94c39a48d34036ca6b59446d1293778802984268f38ef7b80adcb74397a04225edfc3173be481d830d0180c79b2e25

data/README.md

@@ -2,6 +2,27 @@
 
 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:

data/lib/nexus_semantic_logger/datadog_singleton.rb

@@ -3,7 +3,8 @@ require 'singleton'
 
 module NexusSemanticLogger
   # Application wide location to get datadog objects.
-  # Can be moved to its own gem in future, and there is scope to make the usage code even leaner.
+  # 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
@@ -12,8 +13,18 @@ module NexusSemanticLogger
       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)
+    # Delegate to statsd (if available).
+    # @param [String] metric Metric name.
+    def increment(metric)
+      statsd&.increment(metric, tags: tags)
+      flush
+    end
+
+    # Delegate to statsd (if available).
+    # @param [String] metric Metric name.
+    # @param [Integer] ms Timing in milliseconds.
+    def timing(metric, ms)
+      statsd&.timing(metric, ms, tags: tags)
       flush
     end
   end

data/lib/nexus_semantic_logger/version.rb

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

data/lib/nexus_semantic_logger.rb

@@ -6,4 +6,8 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: semantic_logger usage for nexus