tpt-rails 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f941f7fce901677f655f42b56d87869e4dde19545e0547ba27d54ff1875604d
-  data.tar.gz: 79f31a854f4b9baea66dbf5d45e85332426e2061350e66cd3ad770195743e9d8
+  metadata.gz: 831a524d39259635bc860e843b2d2670f6c9915cdae576077b23fbfefbf238ad
+  data.tar.gz: 8ad8e1171dbf2b6c8d2bae9ffac26a570364df1634adef7b26987fb100555077
 SHA512:
-  metadata.gz: d7132817e8d53a875af5d13f74b1b8c8dba725aaac5b8bad18615e15342c4ca5615002226c5d8cb250bc3dd8423da5b019c13013a9f82ca9b3b1afcbf48c6e15
-  data.tar.gz: 4aaf53023b9a035e0a13f65b380c2f9046718667d73f7663c935674c21165e77c2402f2f79c6bb15f7a1c9d5139988b25a84fb8b8bd7396998eada8090bc022c
+  metadata.gz: 3a4b96042265fa07dc0d02263107d71946b346ca2913e89965ff0e11fb53a57f5b048df17700eb4d57f5df3af8bc34a4e7bd148b1cfe38d811db65b0eee067ca
+  data.tar.gz: ae189a0490e15964749f69eaf85431be09d2a57a25bcca5f74af42335889b7a1c44b7ce4934ee47a404a7807b433ebd24f7ffaab1e7dd7a540b19a1ea34cac72

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

@@ -11,4 +11,32 @@ Tpt::Rails.configure do |config|
 
   config.datadog_statsd_url = ENV["DOGSTATSD_URL"].presence
   config.datadog_trace_url = ENV["DATADOG_TRACE_URL"].presence
+
+  # Setup for Statsd
+  #
+  # 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,
+  # )
+  #
+  # See documentation in tpt-rails for all the options available on the make method
+
+  # Setup for Tracing
+  #
+  # To disable tracing (you should disable tracing in most environments):
+  # config.datadog_disable_trace = true
+  #
+  # To use default tracing options and just set url:
+  # config.datadog_trace_url =  "datadog://localhost:1234"
+  #
+  # Or for full customization:
+  # Tpt::Rails::DatadogFactory.configure_tracing(
+  #  trace_url: "datadog://localhost:1234",
+  #  environment: "my_env",
+  #  trace_tags: ["mytag1:hello", "mytag2:goodbye"],
+  #  trace_debug: true
+  # )
 end

data/lib/tpt/rails/config.rb

@@ -1,4 +1,4 @@
-require 'tpt/rails/internal/datadog'
+require 'tpt/rails/datadog_factory'
 require 'tpt/rails/internal/error_reporter'
 require 'tpt/rails/internal/health_checks'
 
@@ -13,10 +13,14 @@ class Tpt::Rails::Config
   attr_accessor :app_name
   # A project-specific api key from Bugsnag
   attr_accessor :bugsnag_api_key
-  # Set this in the form of: statsd://[host]:[port]'
+  # 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]'
+  # Set this in the form of: datadog://[host]:[port]
   attr_accessor :datadog_trace_url
+  # Set to true to disable tracing
+  attr_accessor :datadog_disable_trace
   # Set this in the form of: redis://:[password]@[hostname]:[port]/[db]
   attr_accessor :redis_url
   # A project-specific access token from rollbar
@@ -56,10 +60,19 @@ class Tpt::Rails::Config
       Redis.current = Redis.new(url: redis_url, driver: :hiredis)
     end
 
-    @datadog = Tpt::Rails::Internal::Datadog.new(
-      statsd_url: datadog_statsd_url,
-      trace_url: datadog_trace_url,
-    )
+    if statsd
+      @statsd = statsd
+    else
+      @statsd = Tpt::Rails::DatadogFactory.make(
+        statsd_url: datadog_statsd_url,
+      )
+    end
+
+    if datadog_disable_trace
+      Tpt::Rails::DatadogFactory.disable_tracing
+    elsif datadog_trace_url
+      Tpt::Rails::DatadogFactory.configure_tracing(trace_url: datadog_trace_url)
+    end
 
     @health_checks.setup
 
@@ -71,7 +84,7 @@ class Tpt::Rails::Config
   end
 
   def statsd # :nodoc:
-    @datadog.statsd
+    @statsd
   end
 
   def report(error) # :nodoc:

data/lib/tpt/rails/datadog_factory.rb

@@ -0,0 +1,100 @@
+#
+# Configures Datadog metrics and tracing
+#
+
+require 'datadog/statsd'
+require 'ddtrace'
+
+class Tpt::Rails::DatadogFactory
+  DEFAULT_STATSD_PORT = 8125
+  DEFAULT_TRACE_PORT = 8126
+
+  private_class_method :new
+
+  class << self
+    ###
+      # @description: Instantiates a datadog statsd instance. Note: has side effects, as it configures tracing.
+      # @param {statsd_url}: The url to sends stats to; if nil, a dummy url is used. Form: statsd://[host]:[port]
+      # @param {environment}: Wrapped in "env:#{environment}" and added to tags; if nil, Tpt::Rails.app_env is used;
+      #                       If using eg. reporting env this is where you put it
+      # @param {statsd_tags}: Set your own tags. If nil, default tags are used.
+      #                       If missing, no env tag is supplied, a default (optionally using environment param) is pushed into it.
+      #                       tpt-rails version is always pushed into it.
+      # @return {Datadog::Statsd}
+      ###
+    def make(statsd_url: nil, environment: nil, statsd_tags: nil)
+      statsd_tags = Array.wrap(statsd_tags)
+
+      # Fall back to a dummy client so callers don't have to worry about null checking the client
+      url = statsd_url || 'statsd://localhost'
+      uri = URI.parse(url)
+
+      tags = statsd_tags.nil? ? [] : statsd_tags
+      tags << "env:#{to_env(environment)}" unless tags.map { |t| t.split(':')[0] }.include?("env")
+      tags << "tpt-rails_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: tags,
+      )
+    end
+
+    def make_dummy
+      make
+    end
+
+    # @description: Configure tracing. Just passing trace_url: is enough for a basic config.
+    # @param {trace_url}: The url to send traces to; if nil, tracing is disabled. Form: datadog://[host]:[port]
+    # @param {trace_tags}: Set your own trace tags. If missing, default tags are used (optionally using environment param).
+    # @param {trace_debug}: boolean; passed to c.tracer enabled
+    # @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)
+      uri = URI.parse(trace_url)
+      tags = { 'env' => to_env(environment) }
+      tags["tpt_release_version"] = Tpt::Rails.release_version if Tpt::Rails.release_version
+
+      ::Datadog.configure do |c|
+        # This will activate auto-instrumentation for Rails
+        c.use :rails, {
+          analytics_enabled: true,
+          service_name: Tpt::Rails.app_name,
+        }
+
+        c.tracer(
+          enabled: true,
+          debug: trace_debug,
+          hostname: uri.host,
+          port: uri.port || DEFAULT_TRACE_PORT,
+          tags: tags,
+        )
+
+        c.logger.level = ::Logger::WARN
+
+        yield(c) if block_given?
+      end
+
+      ::Datadog::Pipeline.before_flush(
+        ::Datadog::Pipeline::SpanFilter.new { |span|
+          span.resource =~ /TptRails::HealthChecksController/
+        },
+      )
+    end
+
+    def disable_tracing
+      ::Datadog.configure { |c| c.tracer(enabled: false) }
+    end
+
+    private
+
+    def to_env(environment)
+      if environment.nil?
+        Tpt::Rails.app_env
+      else
+        environment
+      end
+    end
+  end
+end

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.6.4'
+    VERSION = '1.7.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - TpT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,9 +148,9 @@ files:
 - lib/generators/tpt/rails/postman/postman.yaml.tt
 - lib/tpt/rails.rb
 - lib/tpt/rails/config.rb
+- lib/tpt/rails/datadog_factory.rb
 - lib/tpt/rails/engine.rb
 - lib/tpt/rails/internal.rb
-- 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

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

@@ -1,71 +0,0 @@
-#
-# Configures Datadog metrics and tracing, based on Tpt::Rails.config
-#
-
-require 'datadog/statsd'
-require 'ddtrace'
-
-class Tpt::Rails::Internal::Datadog # :nodoc:
-  DEFAULT_STATSD_PORT = 8125
-  DEFAULT_TRACE_PORT = 8126
-
-  attr_reader :statsd
-
-  def initialize(statsd_url: nil, trace_url: nil)
-    @statsd_url = statsd_url
-    @trace_url = trace_url
-
-    @statsd = create_statsd
-
-    if @trace_url
-      configure_tracing
-    end
-  end
-
-  private
-
-  def create_statsd
-    # Fall back to a dummy client so callers don't have to worry about null checking the client
-    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: 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
-      c.use :rails, {
-        analytics_enabled: true,
-        service_name: Tpt::Rails.app_name,
-      }
-
-      c.tracer(
-        enabled: true,
-        hostname: uri.host,
-        port: uri.port || DEFAULT_TRACE_PORT,
-        tags: tags,
-      )
-
-      c.logger.level = ::Logger::WARN
-    end
-
-    ::Datadog::Pipeline.before_flush(
-      ::Datadog::Pipeline::SpanFilter.new { |span|
-        span.resource =~ /TptRails::HealthChecksController/
-      },
-    )
-  end
-end