nexus_semantic_logger 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb3fba7b28b1b186a3e601dc9901c94acf9db07c5f40b2a4c2357104fcda507
-  data.tar.gz: d32b561ab333d7240b4d752e3a3faffa1ad95102882644eb045224f3bb493f44
+  metadata.gz: 6d90e3661ba7e5c82b2e1777d465df8f88617a3ad8287f8d0b9bdd461f0729a6
+  data.tar.gz: 1217216fdf855b72558510e52a50f0308c10b3e07ccbc80369fb228f0fe51040
 SHA512:
-  metadata.gz: 23af7bf651c2f48db0411ae861d36a81d652de9af6da5c275b04f66781d45657abecbf31521cb825a7977a90fa32dac3872f3fe47fc3ec07396928b717abb648
-  data.tar.gz: 9523b13f81fb98da9712e0af779f3b59ff85ae7ba23269c3c2f2845ac91b2ec77674e4cf5985334c1445273d1f12f81dbdba6049d6270ccfb5a6ff454ec30136
+  metadata.gz: a4261cc18604aade1ebd48efcd2cbb680ee26da22c366bcb544c786d42bffdad1a57ec2249f53347f1bcb5dadd2b0c13ff20f8699a7e30131e1e85fb7f1d2244
+  data.tar.gz: f2ea77247cc5e769e1dc7706595b85dc62179ceef8d05f11d78904632cd6cb39c837d64e401e278edf52333a75552dc6de41634f8b6862ac26155d528de9397b

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

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.0 in order for CI process to replace with the tagged version.
+  VERSION = '1.3.0'
 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 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.0
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-09-01 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