tpt-rails 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 831a524d39259635bc860e843b2d2670f6c9915cdae576077b23fbfefbf238ad
-  data.tar.gz: 8ad8e1171dbf2b6c8d2bae9ffac26a570364df1634adef7b26987fb100555077
+  metadata.gz: a17270ceace03741bb34bcac74250dd4f1b60a478a7870dde68896624bb892ca
+  data.tar.gz: ee980279b3354726a5a5050560fad3e8c5ef9324409acbf011890a8300f66bd8
 SHA512:
-  metadata.gz: 3a4b96042265fa07dc0d02263107d71946b346ca2913e89965ff0e11fb53a57f5b048df17700eb4d57f5df3af8bc34a4e7bd148b1cfe38d811db65b0eee067ca
-  data.tar.gz: ae189a0490e15964749f69eaf85431be09d2a57a25bcca5f74af42335889b7a1c44b7ce4934ee47a404a7807b433ebd24f7ffaab1e7dd7a540b19a1ea34cac72
+  metadata.gz: aa83fa139ee86f016380076133d29d2d2406d4aea9da733dd4842bd617a8c16a0418618252c87f10f5e099161bbb249bbc64955fdea15e1d8901bb26c6e6f045
+  data.tar.gz: b3b46f7c49c6d7675a84fafa0088e03b0edea729e7d3b604b568c4f9e45108cd853f43fffc1cf32d51c7c17d5f30be224eed2ac7c83c20fb7a77908088c7e982

data/README.md

@@ -16,7 +16,7 @@ rails generate tpt:rails:configuration
 
 ### Configuration
 
-Running `rails generate tpt_rails:configure` will generate `config/initializers/tpt_rails.rb`. You
+Running `rails generate tpt:rails:configuration` will generate `config/initializers/tpt_rails.rb`. You
 can configure this gem and enable optional features in that file.
 
 See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).

data/lib/generators/tpt/rails/configuration/templates/config/initializers/tpt_rails.rb

@@ -17,10 +17,12 @@ Tpt::Rails.configure do |config|
   # Either by setting a statsd url (a nil url will create a dummy statsd object):
   # config.datadog_statsd_url = "statsd://localhost:1234"
   #
-  # Or by setting a custom statsd instance:
-  # config.statsd = Tpt::Rails::DatadogFactory.make(
-  #   statsd_url: datadog_statsd_url,
-  # )
+  # Or by setting a custom statsd setup lambda (which should return a statsd object):
+  # config.datadog_statsd_setup = -> {
+  #   Tpt::Rails::DatadogFactory.make(
+  #     statsd_url: "statsd://localhost:3000",
+  #   )
+  # }
   #
   # See documentation in tpt-rails for all the options available on the make method
 

data/lib/tpt/rails/config.rb

@@ -3,6 +3,12 @@ require 'tpt/rails/internal/error_reporter'
 require 'tpt/rails/internal/health_checks'
 
 class Tpt::Rails::Config
+  class MustBeCallableError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
   #
   # You can set the following configs in your `Tpt::Rails.configure do |config|` block:
   #
@@ -13,8 +19,6 @@ class Tpt::Rails::Config
   attr_accessor :app_name
   # A project-specific api key from Bugsnag
   attr_accessor :bugsnag_api_key
-  # Allow setting a customized Statsd; supercedes setting urls
-  attr_accessor :statsd
   # Set this in the form of: statsd://[host]:[port]
   attr_accessor :datadog_statsd_url
   # Set this in the form of: datadog://[host]:[port]
@@ -27,6 +31,10 @@ class Tpt::Rails::Config
   attr_accessor :rollbar_access_token
   # Allow enabling/disabling Rollbar. Defaults to false.
   attr_accessor :rollbar_enabled
+  # Allows running a custom lambda to setup datadog statsd in configuration
+  attr_accessor :datadog_statsd_setup
+  # Allows running a custom lambda to setup datadog tracing in configuration
+  attr_accessor :datadog_trace_setup
 
   # Add a health check to the endpoint provided at `/internal/health-check` by
   # Tpt::Rails::HealthChecksController.
@@ -60,8 +68,18 @@ class Tpt::Rails::Config
       Redis.current = Redis.new(url: redis_url, driver: :hiredis)
     end
 
-    if statsd
-      @statsd = statsd
+    if !datadog_statsd_setup.nil?
+      if datadog_statsd_setup.respond_to?(:call)
+        @statsd = datadog_statsd_setup.call
+        datadog_statsd_setup = nil
+
+        unless @statsd.class == Datadog::Statsd
+          raise "datadog_statsd_setup MUST return a #{Datadog::Statsd.to_s} object! Instead, returned a #{@statsd.class}"
+        end
+      else
+        msg = "datadog_statsd_setup must be nil or callable. You should provide a lambda that returns a statsd object, probably from calling Tpt::Rails::DatadogFactory.make"
+        raise(MustBeCallableError.new(msg))
+      end
     else
       @statsd = Tpt::Rails::DatadogFactory.make(
         statsd_url: datadog_statsd_url,
@@ -70,6 +88,14 @@ class Tpt::Rails::Config
 
     if datadog_disable_trace
       Tpt::Rails::DatadogFactory.disable_tracing
+    elsif !datadog_trace_setup.nil?
+      if datadog_trace_setup.respond_to?(:call)
+        datadog_trace_setup.call
+        datadog_trace_setup = nil
+      else
+        msg = "datadog_trace_setup must be nil or callable. You should provide a lambda which calls Tpt::Rails::DatadogFactory.configure_tracing"
+        raise(MustBeCallableError.new(msg))
+      end
     elsif datadog_trace_url
       Tpt::Rails::DatadogFactory.configure_tracing(trace_url: datadog_trace_url)
     end

data/lib/tpt/rails/datadog_factory.rb

@@ -6,6 +6,12 @@ require 'datadog/statsd'
 require 'ddtrace'
 
 class Tpt::Rails::DatadogFactory
+  class DatadogFactoryNotConfigured < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
   DEFAULT_STATSD_PORT = 8125
   DEFAULT_TRACE_PORT = 8126
 
@@ -23,6 +29,11 @@ class Tpt::Rails::DatadogFactory
       # @return {Datadog::Statsd}
       ###
     def make(statsd_url: nil, environment: nil, statsd_tags: nil)
+      if !Tpt::Rails::configured?
+        msg = "Tpt::Rails is not configured. Either run make after configuration, or set a lamda for config.datadog_statsd_setup which will defer setup."
+        raise(DatadogFactoryNotConfigured.new(msg))
+      end
+
       statsd_tags = Array.wrap(statsd_tags)
 
       # Fall back to a dummy client so callers don't have to worry about null checking the client
@@ -52,6 +63,11 @@ class Tpt::Rails::DatadogFactory
     # @param {&block}: Pass to set custom configuration for tracing as part of a .configure call.
     #                  Accepts one parameter that is the configuration object.
     def configure_tracing(trace_url: nil, environment:nil, trace_tags: nil, trace_debug: false)
+      if !Tpt::Rails::configured?
+        msg = "Tpt::Rails is not configured. Either run configure_tracing after configuration, or set a lamda for config.datadog_trace_setup which will defer setup."
+        raise(DatadogFactoryNotConfigured.new(msg))
+      end
+
       uri = URI.parse(trace_url)
       tags = { 'env' => to_env(environment) }
       tags["tpt_release_version"] = Tpt::Rails.release_version if Tpt::Rails.release_version

data/lib/tpt/rails/version.rb

@@ -1,6 +1,6 @@
 module Tpt
   module Rails
     # Do not change this manually. Our tooling will do it automatically.
-    VERSION = '1.7.0'
+    VERSION = '1.7.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - TpT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails