nexus_semantic_logger 1.12 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70e0537b45679788fc9dc6ce2c5e6ae6698e840735039bfc8d55ac324e03d062
-  data.tar.gz: 6a489153ff7db8a3d2bca5696a3ceec917014f9e10416f3a04f5446114a0514b
+  metadata.gz: 027f845d9e52d9f2b489fdee4322de8da733d3d8b6b61164a26b7e65752cbd80
+  data.tar.gz: f3bab4633d763ea390e36347171b003bc046c452ffaa3c9bf2cec0c1d1ed0cdd
 SHA512:
-  metadata.gz: 25f789b5449465c5466d74c780cfb6401e4c5f4df493b40d616f55de5d986366d3d677b69ea1ce51f20e7c94ce71c7e896ec3c61470969db96c213a5c8ad26d8
-  data.tar.gz: a28d97cf7fa44c87511388145e38f2132e1787f711995523226ce388c5c4260ae59c5a975e52daa072bc11273f5fb6698b10ee5ebec3e21b43479b3f59bbfd33
+  metadata.gz: 888523a95588e73193a0e25bf788a4c1345815f67ad2815de793579394834be50ec3630a89d848a8b4b1d150deefdaad23b8be2d487863e97935c7f9f9b06e68
+  data.tar.gz: 13b686749756c64fa5011e5260da75ddacd991c38b1d944104ae3843ef606347e8b05300f485a62b3512922e5b8bd212f8917bcd1ede6b610ffaf5d100fb1a06

data/lib/nexus_semantic_logger/datadog_singleton.rb

@@ -7,7 +7,7 @@ module NexusSemanticLogger
   # own statsd instance.
   class DatadogSingleton
     include Singleton
-    attr_accessor :statsd, :global_tags
+    attr_accessor :statsd
 
     def flush
       statsd&.flush(sync: Rails.env.development?) # Force flush sync in development, speed up checks.
@@ -58,10 +58,9 @@ module NexusSemanticLogger
 
     private
 
-    # Safely combine the global tags with the supplied tags.
+    # Safely combine the supplied tags.
     def combine_tags(tags)
       final_tags = []
-      final_tags += global_tags unless global_tags.nil?
       final_tags += tags unless tags.nil?
       final_tags
     end

data/lib/nexus_semantic_logger/datadog_tracer.rb

@@ -7,6 +7,22 @@ module NexusSemanticLogger
     def initialize(service)
       Datadog.configure do |c|
         if ENV['DD_AGENT_HOST'].present?
+
+          # Container and pod names should be set as env vars via the helm chart. Tagging metrics from the app
+          # with these values helps correlation with metrics from the kubernetes cluster.
+          container_name = ENV.fetch('CONTAINER_NAME') { '' }
+          pod_name = ENV.fetch('POD_NAME') { '' }
+
+          # Configure tags to be sent on all metrics.
+          # Note that 'env' is NOT sent- that is set as the default on the agent e.g. staging, canary, production.
+          # It does not necessarily align with the Rails env, and we do not want to double tag the env.
+          global_tags = [
+            "railsenv:#{Rails.env}",
+            "service:#{service}",
+            "container_name:#{container_name}",
+            "pod_name:#{pod_name}",
+          ]
+
           # 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
@@ -16,20 +32,19 @@ module NexusSemanticLogger
           datadog_singleton = DatadogSingleton.instance
           datadog_statsd_socket_path = ENV.fetch('DD_STATSD_SOCKET_PATH') { '' }
           datadog_singleton.statsd = if datadog_statsd_socket_path.to_s.strip.empty?
-            Datadog::Statsd.new(ENV['DD_AGENT_HOST'], 8125)
+            Datadog::Statsd.new(ENV['DD_AGENT_HOST'], 8125, tags: global_tags)
           else
-            Datadog::Statsd.new(socket_path: datadog_statsd_socket_path)
+            Datadog::Statsd.new(socket_path: datadog_statsd_socket_path, tags: global_tags)
           end
           c.runtime_metrics.statsd = datadog_singleton.statsd
 
-          # Configure tags to be sent on all metrics.
-          # Note that 'env' is NOT sent- that is set as the default on the agent e.g. staging, canary, production.
-          # It does not necessarily align with the Rails env, and we do not want to double tag the env.
-          datadog_singleton.global_tags = ["railsenv:#{Rails.env}", "service:#{service}"]
           # Trace tags API is Hash<String,String>, see https://www.rubydoc.info/gems/ddtrace/Datadog/Tracing
+          # Should match the global tags, but as a Hash.
           c.tags = {
             railsenv: Rails.env,
             service: service,
+            container_name: container_name,
+            pod_name: pod_name,
           }
 
           # Tracer requires configuration to a datadog agent via DD_AGENT_HOST.

data/lib/nexus_semantic_logger/version.rb

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

data/lib/puma/plugin/nexus_puma_statsd.rb

@@ -2,40 +2,12 @@
 require 'puma'
 require 'puma/plugin'
 require 'socket'
-require 'nexus_semantic_logger/datadog_singleton'
+require 'nexus_semantic_logger'
 
 # Forked from puma-plugin-statsd.
 # Uses the same datadog settings as nexus_semantic_logger.
 # To use, add to puma.rb:
 #   plugin :nexus_puma_statsd
-class StatsdConnector
-  STATSD_TYPES = { count: 'c', gauge: 'g' }
-  METRIC_DELIMETER = "."
-
-  attr_reader :host, :port
-
-  def initialize
-    @host = ENV.fetch('DD_AGENT_HOST', '127.0.0.1')
-    @port = ENV.fetch('DD_STATSD_PORT', 8125)
-    @socket_path = ENV.fetch('DD_STATSD_SOCKET_PATH', '')
-  end
-
-  def send(metric_name:, value:, type:, tags: nil)
-    data = "#{metric_name}:#{value}|#{STATSD_TYPES.fetch(type)}"
-    data = "#{data}|##{tags}" unless tags.nil?
-
-    if @socket_path.to_s.strip.empty?
-      socket = UDPSocket.new
-      socket.send(data, 0, host, port)
-    else
-      socket = Socket.new(Socket::AF_UNIX, Socket::SOCK_DGRAM)
-      socket.connect(Socket.pack_sockaddr_un(@socket_path))
-      socket.sendmsg_nonblock(data)
-    end
-  ensure
-    socket.close
-  end
-end
 
 # Wrap puma's stats in a safe API
 class PumaStats
@@ -111,14 +83,7 @@ Puma::Plugin.create do
         @launcher.events
       end
 
-    @statsd = ::StatsdConnector.new
-    @log_writer.debug("statsd: enabled (host: #{@statsd.host})")
-
-    # Fetch global metric prefix from env variable
-    @metric_prefix = ENV.fetch('DD_STATSD_METRIC_PREFIX', nil)
-    if @metric_prefix && !@metric_prefix.end_with?(::StatsdConnector::METRIC_DELIMETER)
-      @metric_prefix += ::StatsdConnector::METRIC_DELIMETER
-    end
+    @log_writer.debug('statsd: enabled')
 
     register_hooks
   end
@@ -137,8 +102,6 @@ Puma::Plugin.create do
     # Examples: simple-tag-0 tag-key-1:tag-value-1
     #
     tags = []
-    global_tags = NexusSemanticLogger::DatadogSingleton.instance.global_tags
-    tags += global_tags unless global_tags.nil?
 
     if ENV.key?('HOSTNAME')
       tags << "pod_name:#{ENV['HOSTNAME']}"
@@ -179,15 +142,9 @@ Puma::Plugin.create do
       tags << "dd.internal.entity_id:#{ENV['DD_ENTITY_ID']}"
     end
 
-    # Return nil if we have no environment variable tags. This way we don't
-    # send an unnecessary '|' on the end of each stat
     return nil if tags.empty?
 
-    tags.join(",")
-  end
-
-  def prefixed_metric_name(puma_metric)
-    "#{@metric_prefix}#{puma_metric}"
+    tags
   end
 
   # Send data to statsd every few seconds
@@ -196,24 +153,19 @@ Puma::Plugin.create do
 
     sleep(5)
     loop do
-      @log_writer.debug("statsd: notify statsd")
+      @log_writer.debug('statsd: notify statsd')
       begin
         stats = ::PumaStats.new(Puma.stats_hash)
-        @statsd.send(metric_name: prefixed_metric_name("puma.workers"), value: stats.workers, type: :gauge, tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.booted_workers"), value: stats.booted_workers,
-type: :gauge, tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.old_workers"), value: stats.old_workers, type: :gauge,
-tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.running"), value: stats.running, type: :gauge, tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.backlog"), value: stats.backlog, type: :gauge, tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.pool_capacity"), value: stats.pool_capacity, type: :gauge,
-tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.max_threads"), value: stats.max_threads, type: :gauge,
-tags: tags)
-        @statsd.send(metric_name: prefixed_metric_name("puma.requests_count"), value: stats.requests_count,
-type: :gauge, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.workers', stats.workers, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.booted_workers', stats.booted_workers, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.old_workers', stats.old_workers, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.running', stats.running, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.backlog', stats.backlog, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.pool_capacity', stats.pool_capacity, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.max_threads', stats.max_threads, tags: tags)
+        NexusSemanticLogger.metrics.gauge('puma.requests_count', stats.requests_count, tags: tags)
       rescue StandardError => e
-        @log_writer.unknown_error(e, nil, "! statsd: notify stats failed")
+        @log_writer.unknown_error(e, nil, '! statsd: notify stats failed')
       ensure
         sleep(2)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: '1.12'
+  version: 1.12.2
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: semantic_logger usage for nexus