tpt-rails 1.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bac9b26e7c559bcd12c7a74894bf5596877561cfc23ba624482571ea47d3cd3
-  data.tar.gz: ce0b334eb643297400a1f8be459997dcf0011f092bd533ffd491e49f615cad48
+  metadata.gz: '069473918c000e049099c5538f36b2e10211e16f4cbfa4adfb2e3f31066b3550'
+  data.tar.gz: 1bb6905ec5f83c4e10292550999e70babf5139437878709779935557d4b335ad
 SHA512:
-  metadata.gz: ac3ad3e0d29a4aa067195668e002585bdee24c85046e4d0271492ec0d264d80d8acb8a100a832ed331bd1a3b2347ba2ebfa3b4e9874d593da24fd5fa963a40c5
-  data.tar.gz: eaeef4b7457d511b8d410e4d54ffe1fc92785107a7354aa78c6af207e9b915aa2432bd357804ed34c0194884a39f2741b4b179ea214c7e2a8ab087e9c7e73437
+  metadata.gz: f7a28b2dae2af0cd5e5904532c1706ab2b3866c061c9fcae39008e3efee9f163132443597a4e35b524a2720cc5b57c959f43fd30e8e2b415a0d40dde383c4075
+  data.tar.gz: ea76d2ca17491bd1e63e19c84913487beabb367c6e7a3a16c8ff3064d50533749c349ed915fd6b406fc979a8f0ac2d4748eb2e46aaf9ea31717b558c14c8277a

data/README.md

@@ -62,8 +62,8 @@ See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
 
 ### Error reporting (e.g. Bugsnag/Rollbar)
 
-If you configure `rollbar_access_token` or `bugsnag_api_key` then your project will be automatically
-configured to report unhandled exceptions.
+If you configure `rollbar_access_token` & `rollbar_enabled`, or `bugsnag_api_key` then your project
+will be automatically configured to report unhandled exceptions.
 
 To report handled exceptions:
 
@@ -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
@@ -19,6 +20,7 @@ module Tpt::Rails
     #     config.app_name = '…'
     #     config.app_env = '…'
     #     config.rollbar_access_token = '…'
+    #     config.rollbar_enabled = true/false
     #     config.datadog_statsd_url = '…'
     #     config.health_check(:foo) { … }
     #     …
@@ -66,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/config.rb

@@ -21,6 +21,8 @@ class Tpt::Rails::Config
   attr_accessor :redis_url
   # A project-specific access token from rollbar
   attr_accessor :rollbar_access_token
+  # Allow enabling/disabling Rollbar. Defaults to false.
+  attr_accessor :rollbar_enabled
 
   # Add a health check to the endpoint provided at `/internal/health-check` by
   # Tpt::Rails::HealthChecksController.
@@ -64,6 +66,7 @@ class Tpt::Rails::Config
     @error_reporter = Tpt::Rails::Internal::ErrorReporter.new(
       bugsnag_api_key: bugsnag_api_key.presence,
       rollbar_access_token: rollbar_access_token.presence,
+      rollbar_enabled: rollbar_enabled ? true : false,
     )
   end
 

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

@@ -29,18 +29,23 @@ 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}"],
+        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,7 +58,7 @@ 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,
       )
     end
 

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

@@ -1,7 +1,8 @@
 class Tpt::Rails::Internal::ErrorReporter # :nodoc:
-  def initialize(bugsnag_api_key: nil, rollbar_access_token: nil)
+  def initialize(bugsnag_api_key: nil, rollbar_access_token: nil, rollbar_enabled: false)
     @bugsnag_api_key = bugsnag_api_key
     @rollbar_access_token = rollbar_access_token
+    @rollbar_enabled = rollbar_enabled
 
     configure_bugsnag if bugsnag?
     configure_rollbar if rollbar?
@@ -48,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
 
@@ -57,12 +59,10 @@ class Tpt::Rails::Internal::ErrorReporter # :nodoc:
 
     Rollbar.configure do |config|
       config.access_token = @rollbar_access_token
-
-      if ::Rails.env.test? || ::Rails.env.development?
-        config.enabled = false
-      end
-
+      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.0.2'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.0
 platform: ruby
 authors:
 - TpT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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: []