nexus_semantic_logger 1.11.6 → 1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f367c4597a558ce34338e3378f03c014de4745b3fa3b107629eb28c4be03d0
-  data.tar.gz: 06b199a9c633825110cefdc2bd10272dff2d6e88340b1fd91296994108236b6e
+  metadata.gz: 70e0537b45679788fc9dc6ce2c5e6ae6698e840735039bfc8d55ac324e03d062
+  data.tar.gz: 6a489153ff7db8a3d2bca5696a3ceec917014f9e10416f3a04f5446114a0514b
 SHA512:
-  metadata.gz: a071e056de2fd4a4a86112b382b3de49a3d6b0d80beca2a430141fbef69aa3075a3082d9a59f211c10040c4999a4d7eca4c7e72470275ef1f229011842a794c3
-  data.tar.gz: 2814af602f6693ab6076cbf2d1c922c5cbefb8b8ae5520bf03efc6860c8448fb95e7cee81325aae98d1bcf707ff8dc23ec4fc309ea77ab4ae7e41274501da7f3
+  metadata.gz: 25f789b5449465c5466d74c780cfb6401e4c5f4df493b40d616f55de5d986366d3d677b69ea1ce51f20e7c94ce71c7e896ec3c61470969db96c213a5c8ad26d8
+  data.tar.gz: a28d97cf7fa44c87511388145e38f2132e1787f711995523226ce388c5c4260ae59c5a975e52daa072bc11273f5fb6698b10ee5ebec3e21b43479b3f59bbfd33

data/lib/nexus_semantic_logger/version.rb

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

data/lib/puma/plugin/README.md

@@ -0,0 +1 @@
+Forked from https://github.com/yob/puma-plugin-statsd 

data/lib/puma/plugin/nexus_puma_statsd.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+require 'puma'
+require 'puma/plugin'
+require 'socket'
+require 'nexus_semantic_logger/datadog_singleton'
+
+# 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
+  def initialize(stats)
+    @stats = stats
+  end
+
+  def clustered?
+    @stats.key?(:workers)
+  end
+
+  def workers
+    @stats.fetch(:workers, 1)
+  end
+
+  def booted_workers
+    @stats.fetch(:booted_workers, 1)
+  end
+
+  def old_workers
+    @stats.fetch(:old_workers, 0)
+  end
+
+  def running
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:running, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:running, 0)
+    end
+  end
+
+  def backlog
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:backlog, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:backlog, 0)
+    end
+  end
+
+  def pool_capacity
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:pool_capacity, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:pool_capacity, 0)
+    end
+  end
+
+  def max_threads
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:max_threads, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:max_threads, 0)
+    end
+  end
+
+  def requests_count
+    if clustered?
+      @stats[:worker_status].map { |s| s[:last_status].fetch(:requests_count, 0) }.inject(0, &:+)
+    else
+      @stats.fetch(:requests_count, 0)
+    end
+  end
+end
+
+Puma::Plugin.create do
+  # We can start doing something when we have a launcher:
+  def start(launcher)
+    @launcher = launcher
+    @log_writer =
+      if Gem::Version.new(Puma::Const::PUMA_VERSION) >= Gem::Version.new(6)
+        @launcher.log_writer
+      else
+        @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
+
+    register_hooks
+  end
+
+  private
+
+  def register_hooks
+    in_background(&method(:stats_loop))
+  end
+
+  def environment_variable_tags
+    # Tags are separated by spaces, and while they are normally a tag and
+    # value separated by a ':', they can also just be tagged without any
+    # associated value.
+    #
+    # 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']}"
+    end
+
+    # Standardised datadog tag attributes, so that we can share the metric
+    # tags with the application running
+    #
+    # https://docs.datadoghq.com/agent/docker/?tab=standard#global-options
+    #
+    if ENV.key?("DD_TAGS")
+      ENV["DD_TAGS"].split(/\s+|,/).each do |t|
+        tags << t
+      end
+    end
+
+    # Support the Unified Service Tagging from Datadog, so that we can share
+    # the metric tags with the application running
+    #
+    # https://docs.datadoghq.com/getting_started/tagging/unified_service_tagging
+    if ENV.key?('DD_ENV')
+      tags << "env:#{ENV['DD_ENV']}"
+    end
+
+    if ENV.key?('DD_SERVICE')
+      tags << "service:#{ENV['DD_SERVICE']}"
+    end
+
+    if ENV.key?('DD_VERSION')
+      tags << "version:#{ENV['DD_VERSION']}"
+    end
+
+    # Support the origin detection over UDP from Datadog, it allows DogStatsD
+    # to detect where the container metrics come from, and tag metrics automatically.
+    #
+    # https://docs.datadoghq.com/developers/dogstatsd/?tab=kubernetes#origin-detection-over-udp
+    if ENV.key?('DD_ENTITY_ID')
+      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}"
+  end
+
+  # Send data to statsd every few seconds
+  def stats_loop
+    tags = environment_variable_tags
+
+    sleep(5)
+    loop do
+      @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)
+      rescue StandardError => e
+        @log_writer.unknown_error(e, nil, "! statsd: notify stats failed")
+      ensure
+        sleep(2)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.11.6
+  version: '1.12'
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -116,6 +116,8 @@ files:
 - lib/nexus_semantic_logger/logger_metrics_subscriber.rb
 - lib/nexus_semantic_logger/sneakers_metrics.rb
 - lib/nexus_semantic_logger/version.rb
+- lib/puma/plugin/README.md
+- lib/puma/plugin/nexus_puma_statsd.rb
 - nexus_semantic_logger.gemspec
 homepage: 
 licenses: []
@@ -135,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: semantic_logger usage for nexus