tpt-rails 1.1.0 → 1.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0669d857b54eed34690e1f47f44c7b8fde75a7ddc612dec36db7fe3cb96e7d24'
-  data.tar.gz: 507c33fe3739bd57ff55ea7d42508f6a5394df1b7d5be1fcaf27f3beb8d792fe
+  metadata.gz: b14bdc3ce7ea3aedee1b055dfdb4ef8cdc6fbcae92fb3db5ec3751f3dda7a787
+  data.tar.gz: fd51b3732c7771868049abb884dfd37789d7199c07777f300d899d344f5ae5d4
 SHA512:
-  metadata.gz: 6ed1fa381014e4baad4c6cd3919dc1069735c19b7ddb225ae920b6bf746bdcfa02bb21badd8967876f176ee26cd27565c4e9f67240255d024f701aaeff9ab2e8
-  data.tar.gz: da2721a6091ecc9e49afec62450a66b576ab31a08e17a044110bee307b8218522a085f2b1b86aad65cf1d8021c0db6bafbf6c2eb238ebe22172151a261ca92f9
+  metadata.gz: da90f352cf93c79c434999c574279add0dd3e2af36c53f2fe8f148dfe6b981f3c83b5f454316507191c52085f1bf0fdd03c2bca5caadbb5122096cdb6b57604c
+  data.tar.gz: 88e4a35987347c990aacb29e80c80528f8e3859105b2afa01e11719d0b727ebf97623652b5d3b0cf8397498fb5a5c61ccdf08f2477486bcd0036c7ac7a8d85e1

data/README.md

@@ -100,12 +100,24 @@ 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
 
 1. Start `docker-compose up` (provides a real Redis instance for tests)
-2. Run `rails test`
+2. Run `bin/test`
 
 ### Using your local version of this gem in a local app
 
@@ -119,7 +131,7 @@ gem 'tpt-rails', path: '/your/local/path/to/tpt/rails'
 
 First ensure you have permissions to publish to rubygems.org.
 
-Then execute:
+Once you've merged, check out the `master` branch and execute:
 ```sh
 bundle exec gem bump --push --tag --version patch # patch/minor/major/X.X.X
 bundle exec gem release

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

@@ -9,7 +9,7 @@ image:
 
 environment:
   ENVIRONMENT: staging
-  APP_ENV: production
+  APP_ENV: staging
   RAILS_ENV: production
 
 postgresql:

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
@@ -67,5 +68,10 @@ module Tpt::Rails
     def config # :nodoc:
       configured? ? @config : raise(NotConfigured)
     end
+
+    # This should be set by the deployment tool. E.g. Jenkins: https://git.io/JJFiD
+    def release_version
+      ENV['TPT_RELEASE_VERSION'].presence
+    end
   end
 end

data/lib/tpt/rails/internal/datadog.rb

@@ -29,18 +29,21 @@ class Tpt::Rails::Internal::Datadog # :nodoc:
     url = @statsd_url || 'statsd://localhost'
     uri = URI.parse(url)
 
+    tags = ["env:#{Tpt::Rails.app_env}"]
+    tags << ["tpt_release_version:#{Tpt::Rails.release_version}"] if Tpt::Rails.release_version
+
     ::Datadog::Statsd.new(
       uri.host,
       uri.port || DEFAULT_STATSD_PORT,
-      {
-        namespace: Tpt::Rails.app_name,
-        tags: ["env:#{Tpt::Rails.app_env}"],
-      }
+      namespace: Tpt::Rails.app_name,
+      tags: tags,
     )
   end
 
   def configure_tracing
     uri = URI.parse(@trace_url)
+    tags = { 'env' => Tpt::Rails.app_env }
+    tags["tpt_release_version"] = Tpt::Rails.release_version if Tpt::Rails.release_version
 
     ::Datadog.configure do |c|
       # This will activate auto-instrumentation for Rails
@@ -53,8 +56,10 @@ class Tpt::Rails::Internal::Datadog # :nodoc:
         enabled: true,
         hostname: uri.host,
         port: uri.port || DEFAULT_TRACE_PORT,
-        tags: { 'env' => Tpt::Rails.app_env },
+        tags: tags,
       )
+
+      c.logger.level = ::Logger::WARN
     end
 
     ::Datadog::Pipeline.before_flush(

data/lib/tpt/rails/internal/error_reporter.rb

@@ -49,6 +49,7 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
     Bugsnag.configure do |config|
       config.api_key = @bugsnag_api_key
+      config.app_version = Tpt::Rails.release_version if Tpt::Rails.release_version
     end
   end
 
@@ -58,8 +59,10 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
     Rollbar.configure do |config|
       config.access_token = @rollbar_access_token
+      config.code_version = Tpt::Rails.release_version if Tpt::Rails.release_version
       config.enabled = @rollbar_enabled
       config.environment = Tpt::Rails.app_env
+      config.populate_empty_backtraces = true
     end
   end
 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.4.0.rc1'
   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.4.0.rc1
 platform: ruby
 authors:
 - TpT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: 6.0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: 6.0.3.3
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.40'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -126,10 +126,11 @@ 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:
-- None
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -142,11 +143,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Utils for TpT Rails apps