tpt-rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0669d857b54eed34690e1f47f44c7b8fde75a7ddc612dec36db7fe3cb96e7d24'
-  data.tar.gz: 507c33fe3739bd57ff55ea7d42508f6a5394df1b7d5be1fcaf27f3beb8d792fe
+  metadata.gz: 8f34cc827a621a48f4a71602ddf6de4c8da4738a1644708136cb5d0e716795be
+  data.tar.gz: 165dbfd4ffc8e3a149ae0c4a88600ee39319b21ba99882846902ec7d1511fd74
 SHA512:
-  metadata.gz: 6ed1fa381014e4baad4c6cd3919dc1069735c19b7ddb225ae920b6bf746bdcfa02bb21badd8967876f176ee26cd27565c4e9f67240255d024f701aaeff9ab2e8
-  data.tar.gz: da2721a6091ecc9e49afec62450a66b576ab31a08e17a044110bee307b8218522a085f2b1b86aad65cf1d8021c0db6bafbf6c2eb238ebe22172151a261ca92f9
+  metadata.gz: a9a6507480b7e46bee217c524c243b89c7994135cd06c1353e30b97fa4b57088cf6dcfac699f1bd10407da15fd0d1c872922bf9ad6d52d4d8a1b8680926da1fc
+  data.tar.gz: bcf18231087259a786e1254c3d81520f383163928043cf42415a0ab4e0af199e28b8aea695ebfa9c2d660c9e5a1e847ddfcb0d0b99a6effd00ebfc3da11d3934

data/README.md

@@ -100,6 +100,18 @@ Tpt::Rails provides the following endpoint:
 
 This endpoint reports an error via `Tpt::Rails.report` and emits a metric to Datadog.
 
+### Puma instrumentation
+
+Add the following to `config/puma.rb` to have Puma metrics sent to Datadog:
+
+```ruby
+before_fork do
+  Tpt::Rails::PumaStatsCollector.run(metrics_client: Tpt::Rails.statsd)
+end
+```
+
+Note: this currently only collects metrics when running Puma in _clustered_ mode (i.e. w/ more than one worker)
+
 ## Developing this Gem
 
 ### Running tests

data/lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.yaml.tt

@@ -70,13 +70,14 @@ service:
 resources:
   # requests is guaranteed. kubernetes will only put your pod on a node where it can guarantee these
   # amounts.
-  requests:
-    memory: 256Mi
-    cpu: 200m
-  # limits is when your pod gets killed for using too many resources
-  limits:
+  requests: &requests
     memory: 512Mi
-    cpu: 1
+    cpu: 500m
+  # limits is when your pod gets killed for using too many resources. normally these should be set
+  # the same as the "requests" limit, but if you have a unique workload that requires burstable
+  # limits then consult with CloudOps
+  limits:
+    *requests
 
 app:
   # this configures your service to be available at <%= Tpt::Rails.app_name %>.<ingress_dns_name>

data/lib/tpt/rails.rb

@@ -6,6 +6,7 @@ end
 require 'tpt/rails/engine'
 require 'tpt/rails/internal'
 require 'tpt/rails/config'
+require 'tpt/rails/puma_stats_collector'
 
 module Tpt::Rails
   class NotConfigured < StandardError; end

data/lib/tpt/rails/puma_stats_collector.rb

@@ -0,0 +1,86 @@
+module Tpt::Rails::PumaStatsCollector # :nodoc:
+  class PumaStats
+    def initialize(stats)
+      @stats = JSON.parse(stats, symbolize_names: true)
+    end
+
+    def clustered?
+      @stats.has_key?(:workers)
+    end
+
+    def workers
+      @stats.fetch(:workers, 1)
+    end
+
+    def booted_workers
+      @stats.fetch(:booted_workers, 1)
+    end
+
+    def running
+      get_stat(:running)
+    end
+
+    def backlog
+      get_stat(:backlog)
+    end
+
+    def pool_capacity
+      get_stat(:pool_capacity)
+    end
+
+    def max_threads
+      get_stat(:max_threads)
+    end
+
+    def to_s
+      {
+        workers: workers,
+        booted_workers: booted_workers,
+        running: running,
+        backlog: backlog,
+        pool_capacity: pool_capacity,
+        max_threads: max_threads
+      }.to_json
+    end
+
+    private
+    def get_stat(name)
+      if clustered?
+        @stats[:worker_status].map { |s| s[:last_status].fetch(name, 0) }.sum
+      else
+        @stats.fetch(name, 0)
+      end
+    end
+  end
+
+  class << self
+    def run(metrics_client:, start_delay: 10, collect_interval: 30)
+      Thread.new do
+        # Give Puma time to start
+        sleep start_delay
+
+        # Get pod name if set
+        pod_name = ENV["KUBE_POD"]
+
+        loop do
+          begin
+            stats = PumaStats.new(Puma.stats)
+
+            tags = []
+            # Add pod_name tag if set
+            tags << "pod_name:#{pod_name}" if pod_name
+
+            metrics_client.gauge("puma.workers", stats.workers, tags: tags)
+            metrics_client.gauge("puma.booted_workers", stats.booted_workers, tags: tags)
+            metrics_client.gauge("puma.running", stats.running, tags: tags)
+            metrics_client.gauge("puma.backlog", stats.backlog, tags: tags)
+            metrics_client.gauge("puma.pool_capacity", stats.pool_capacity, tags: tags)
+            metrics_client.gauge("puma.max_threads", stats.max_threads, tags: tags)
+          end
+
+          sleep collect_interval
+        end
+      end
+    end
+  end
+end

data/lib/tpt/rails/version.rb

@@ -1,5 +1,5 @@
 module Tpt
   module Rails
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - TpT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,6 +126,7 @@ files:
 - lib/tpt/rails/internal/datadog.rb
 - lib/tpt/rails/internal/error_reporter.rb
 - lib/tpt/rails/internal/health_checks.rb
+- lib/tpt/rails/puma_stats_collector.rb
 - lib/tpt/rails/version.rb
 homepage: https://github.com/TeachersPayTeachers/tpt-rails
 licenses: