ddtrace 1.19.0 → 1.21.0

data/lib/datadog/opentelemetry/sdk/propagator.rb

@@ -29,9 +29,10 @@ module Datadog
           carrier, context: ::OpenTelemetry::Context.current,
           getter: ::OpenTelemetry::Context::Propagation.text_map_getter
         )
-          unless getter == ::OpenTelemetry::Context::Propagation.text_map_getter
+          if getter != ::OpenTelemetry::Context::Propagation.text_map_getter &&
+              getter != ::OpenTelemetry::Common::Propagation.rack_env_getter
             Datadog.logger.error(
-              'Custom getter is not supported. Please inform the `ddtrace` team at ' \
+              "Custom getter #{getter} is not supported. Please inform the `ddtrace` team at " \
             ' https://github.com/DataDog/dd-trace-rb of your use case so we can best support you. Using the default ' \
             'OpenTelemetry::Context::Propagation.text_map_getter as a fallback getter.'
             )

data/lib/datadog/opentelemetry.rb

@@ -8,7 +8,10 @@
 # This file activates the integrations of all OpenTelemetry
 # components supported by Datadog.
 
+# Load Tracing
 require_relative 'tracing'
+require_relative 'tracing/contrib'
+
 require_relative 'opentelemetry/api/context'
 
 # DEV: Should this be a Contrib integration, that depends on the `opentelemetry-sdk`

data/lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb

@@ -18,7 +18,6 @@ module Datadog
           no_signals_workaround_enabled:,
           thread_context_collector:,
           dynamic_sampling_rate_overhead_target_percentage:,
-          allocation_sample_every:,
           allocation_profiling_enabled:,
           # **NOTE**: This should only be used for testing; disabling the dynamic sampling rate will increase the
           # profiler overhead!
@@ -39,7 +38,6 @@ module Datadog
             no_signals_workaround_enabled,
             dynamic_sampling_rate_enabled,
             dynamic_sampling_rate_overhead_target_percentage,
-            allocation_sample_every,
             allocation_profiling_enabled,
           )
           @worker_thread = nil
@@ -102,6 +100,12 @@ module Datadog
         def stats
           self.class._native_stats(self)
         end
+
+        def stats_and_reset_not_thread_safe
+          stats = self.stats
+          self.class._native_stats_reset_not_thread_safe(self)
+          stats
+        end
       end
     end
   end

data/lib/datadog/profiling/collectors/info.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'time'
+
+module Datadog
+  module Profiling
+    module Collectors
+      # Collects information of relevance for profiler. This will get sent alongside
+      # the profile and show up in the UI or potentially influence processing in some way.
+      #
+      # Information is currently collected and frozen at construction time. A full collector
+      # could be seen as overkill for this case but it allows us to centralize information
+      # gathering and easily support more flexible/dynamic info collection in the future.
+      class Info
+        def initialize(settings)
+          @profiler_info = nil
+          @info = {
+            platform: collect_platform_info,
+            runtime: collect_runtime_info,
+            application: collect_application_info(settings),
+            profiler: collect_profiler_info(settings),
+          }.freeze
+        end
+
+        attr_reader :info
+
+        private
+
+        # Instead of trying to figure out real process start time by checking
+        # /proc or some other complex/non-portable way, approximate start time
+        # by time of requirement of this file.
+        START_TIME = Time.now.utc.freeze
+
+        def collect_platform_info
+          @platform_info ||= {
+            container_id: Datadog::Core::Environment::Container.container_id,
+            hostname: Datadog::Core::Environment::Platform.hostname,
+            kernel_name: Datadog::Core::Environment::Platform.kernel_name,
+            kernel_release: Datadog::Core::Environment::Platform.kernel_release,
+            kernel_version: Datadog::Core::Environment::Platform.kernel_version
+          }.freeze
+        end
+
+        def collect_runtime_info
+          @runtime_info ||= {
+            engine: Datadog::Core::Environment::Identity.lang_engine,
+            version: Datadog::Core::Environment::Identity.lang_version,
+            platform: Datadog::Core::Environment::Identity.lang_platform,
+          }.freeze
+        end
+
+        def collect_application_info(settings)
+          @application_info ||= {
+            start_time: START_TIME.iso8601,
+            env: settings.env,
+            service: settings.service,
+            version: settings.version,
+          }.freeze
+        end
+
+        def collect_profiler_info(settings)
+          unless @profiler_info
+            lib_datadog_gem = ::Gem.loaded_specs['libdatadog']
+            @profiler_info = {
+              version: Datadog::Core::Environment::Identity.tracer_version,
+              libdatadog: "#{lib_datadog_gem.version}-#{lib_datadog_gem.platform}",
+              settings: collect_settings_recursively(settings.profiling),
+            }.freeze
+          end
+          @profiler_info
+        end
+
+        # The settings/option model isn't directly serializable because
+        # of subsettings and options that link to full blown custom object
+        # instances without proper serialization.
+        # This method navigates a settings object recursively, converting
+        # it into more basic types that are trivially convertible to JSON.
+        def collect_settings_recursively(v)
+          v = v.options_hash if v.respond_to?(:options_hash)
+
+          if v.nil? || v.is_a?(Symbol) || v.is_a?(Numeric) || v.is_a?(String) || v.equal?(true) || v.equal?(false)
+            Core::Utils::SafeDup.frozen_or_dup(v)
+          elsif v.is_a?(Hash)
+            collected_hash = v.each_with_object({}) do |(key, value), hash|
+              collected_value = collect_settings_recursively(value)
+              hash[key] = collected_value
+            end
+            collected_hash.freeze
+          elsif v.is_a?(Enumerable)
+            collected_list = v
+              .map { |value| collect_settings_recursively(value) }
+            collected_list.freeze
+          else
+            v.inspect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/component.rb

@@ -8,11 +8,7 @@ module Datadog
       # * Code Hotspots panel in the trace viewer, as well as scoping a profile down to a span
       # * Endpoint aggregation in the profiler UX, including normalization (resource per endpoint call)
       def self.build_profiler_component(settings:, agent_settings:, optional_tracer:) # rubocop:disable Metrics/MethodLength
-        require_relative '../profiling/diagnostics/environment_logger'
-
-        Profiling::Diagnostics::EnvironmentLogger.collect_and_log!
-
-        return unless settings.profiling.enabled
+        return [nil, { profiling_enabled: false }] unless settings.profiling.enabled
 
         # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
         # dependency on individual products, in this case the Profiler.
@@ -32,7 +28,8 @@ module Datadog
         # done, then profiling may not be loaded, and thus to avoid this issue we do a require here (which is a
         # no-op if profiling is already loaded).
         require_relative '../profiling'
-        return unless Profiling.supported?
+
+        return [nil, { profiling_enabled: false }] unless Profiling.supported?
 
         # Activate forking extensions
         Profiling::Tasks::Setup.new.run
@@ -40,9 +37,8 @@ module Datadog
         # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
 
         no_signals_workaround_enabled = no_signals_workaround_enabled?(settings)
-        timeline_enabled = settings.profiling.advanced.experimental_timeline_enabled
-        allocation_sample_every = get_allocation_sample_every(settings)
-        allocation_profiling_enabled = enable_allocation_profiling?(settings, allocation_sample_every)
+        timeline_enabled = settings.profiling.advanced.timeline_enabled
+        allocation_profiling_enabled = enable_allocation_profiling?(settings)
         heap_sample_every = get_heap_sample_every(settings)
         heap_profiling_enabled = enable_heap_profiling?(settings, allocation_profiling_enabled, heap_sample_every)
         heap_size_profiling_enabled = enable_heap_size_profiling?(settings, heap_profiling_enabled)
@@ -64,22 +60,20 @@ module Datadog
           no_signals_workaround_enabled: no_signals_workaround_enabled,
           thread_context_collector: thread_context_collector,
           dynamic_sampling_rate_overhead_target_percentage: overhead_target_percentage,
-          allocation_sample_every: allocation_sample_every,
           allocation_profiling_enabled: allocation_profiling_enabled,
         )
 
         internal_metadata = {
           no_signals_workaround_enabled: no_signals_workaround_enabled,
           timeline_enabled: timeline_enabled,
-          allocation_sample_every: allocation_sample_every,
           heap_sample_every: heap_sample_every,
         }.freeze
 
-        exporter = build_profiler_exporter(settings, recorder, internal_metadata: internal_metadata)
+        exporter = build_profiler_exporter(settings, recorder, worker, internal_metadata: internal_metadata)
         transport = build_profiler_transport(settings, agent_settings)
         scheduler = Profiling::Scheduler.new(exporter: exporter, transport: transport, interval: upload_period_seconds)
 
-        Profiling::Profiler.new(worker: worker, scheduler: scheduler)
+        [Profiling::Profiler.new(worker: worker, scheduler: scheduler), { profiling_enabled: true }]
       end
 
       private_class_method def self.build_thread_context_collector(settings, recorder, optional_tracer, timeline_enabled)
@@ -92,12 +86,15 @@ module Datadog
         )
       end
 
-      private_class_method def self.build_profiler_exporter(settings, recorder, internal_metadata:)
+      private_class_method def self.build_profiler_exporter(settings, recorder, worker, internal_metadata:)
+        info_collector = Profiling::Collectors::Info.new(settings)
         code_provenance_collector =
           (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
 
         Profiling::Exporter.new(
           pprof_recorder: recorder,
+          worker: worker,
+          info_collector: info_collector,
           code_provenance_collector: code_provenance_collector,
           internal_metadata: internal_metadata,
         )
@@ -129,16 +126,6 @@ module Datadog
         end
       end
 
-      private_class_method def self.get_allocation_sample_every(settings)
-        allocation_sample_rate = settings.profiling.advanced.experimental_allocation_sample_rate
-
-        if allocation_sample_rate <= 0
-          raise ArgumentError, "Allocation sample rate must be a positive integer. Was #{allocation_sample_rate}"
-        end
-
-        allocation_sample_rate
-      end
-
       private_class_method def self.get_heap_sample_every(settings)
         heap_sample_rate = settings.profiling.advanced.experimental_heap_sample_rate
 
@@ -147,8 +134,8 @@ module Datadog
         heap_sample_rate
       end
 
-      private_class_method def self.enable_allocation_profiling?(settings, allocation_sample_every)
-        unless settings.profiling.advanced.experimental_allocation_enabled
+      private_class_method def self.enable_allocation_profiling?(settings)
+        unless settings.profiling.allocation_enabled
           # Allocation profiling disabled, short-circuit out
           return false
         end
@@ -192,10 +179,7 @@ module Datadog
           )
         end
 
-        Datadog.logger.warn(
-          "Enabled experimental allocation profiling: allocation_sample_rate=#{allocation_sample_every}. This is " \
-          'experimental, not recommended, and will increase overhead!'
-        )
+        Datadog.logger.debug('Enabled allocation profiling')
 
         true
       end

data/lib/datadog/profiling/exporter.rb

@@ -23,31 +23,39 @@ module Datadog
         :time_provider,
         :last_flush_finish_at,
         :created_at,
-        :internal_metadata
+        :internal_metadata,
+        :info_json
 
       public
 
       def initialize(
         pprof_recorder:,
+        worker:,
+        info_collector:,
         code_provenance_collector:,
         internal_metadata:,
         minimum_duration_seconds: PROFILE_DURATION_THRESHOLD_SECONDS,
         time_provider: Time
       )
         @pprof_recorder = pprof_recorder
+        @worker = worker
         @code_provenance_collector = code_provenance_collector
         @minimum_duration_seconds = minimum_duration_seconds
         @time_provider = time_provider
         @last_flush_finish_at = nil
         @created_at = time_provider.now.utc
         @internal_metadata = internal_metadata
+        # NOTE: At the time of this comment collected info does not change over time so we'll hardcode
+        #       it on startup to prevent serializing the same info on every flush.
+        @info_json = JSON.fast_generate(info_collector.info).freeze
       end
 
       def flush
-        start, finish, uncompressed_pprof = pprof_recorder.serialize
+        worker_stats = @worker.stats_and_reset_not_thread_safe
+        start, finish, compressed_pprof = pprof_recorder.serialize
         @last_flush_finish_at = finish
 
-        return if uncompressed_pprof.nil? # We don't want to report empty profiles
+        return if compressed_pprof.nil? # We don't want to report empty profiles
 
         if duration_below_threshold?(start, finish)
           Datadog.logger.debug('Skipped exporting profiling events as profile duration is below minimum')
@@ -60,11 +68,17 @@ module Datadog
           start: start,
           finish: finish,
           pprof_file_name: Datadog::Profiling::Ext::Transport::HTTP::PPROF_DEFAULT_FILENAME,
-          pprof_data: uncompressed_pprof.to_s,
+          pprof_data: compressed_pprof.to_s,
           code_provenance_file_name: Datadog::Profiling::Ext::Transport::HTTP::CODE_PROVENANCE_FILENAME,
           code_provenance_data: uncompressed_code_provenance,
           tags_as_array: Datadog::Profiling::TagBuilder.call(settings: Datadog.configuration).to_a,
-          internal_metadata: internal_metadata,
+          internal_metadata: internal_metadata.merge(
+            {
+              worker_stats: worker_stats,
+              gc: GC.stat,
+            }
+          ),
+          info_json: info_json,
         )
       end
 

data/lib/datadog/profiling/ext.rb

@@ -23,6 +23,8 @@ module Datadog
           FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'
           FORM_FIELD_TAG_SERVICE = 'service'
           FORM_FIELD_TAG_VERSION = 'version'
+          TAG_GIT_REPOSITORY_URL = 'git.repository_url'
+          TAG_GIT_COMMIT_SHA = 'git.commit.sha'
 
           PPROF_DEFAULT_FILENAME = 'rubyprofile.pprof'
           CODE_PROVENANCE_FILENAME = 'code-provenance.json'

data/lib/datadog/profiling/flush.rb

@@ -14,7 +14,8 @@ module Datadog
         :code_provenance_file_name,
         :code_provenance_data, # gzipped json bytes
         :tags_as_array,
-        :internal_metadata_json
+        :internal_metadata_json,
+        :info_json
 
       def initialize(
         start:,
@@ -24,7 +25,8 @@ module Datadog
         code_provenance_file_name:,
         code_provenance_data:,
         tags_as_array:,
-        internal_metadata:
+        internal_metadata:,
+        info_json:
       )
         @start = start
         @finish = finish
@@ -33,7 +35,8 @@ module Datadog
         @code_provenance_file_name = code_provenance_file_name
         @code_provenance_data = code_provenance_data
         @tags_as_array = tags_as_array
-        @internal_metadata_json = JSON.fast_generate(internal_metadata.map { |k, v| [k, v.to_s] }.to_h)
+        @internal_metadata_json = JSON.fast_generate(internal_metadata)
+        @info_json = info_json
       end
     end
   end

data/lib/datadog/profiling/http_transport.rb

@@ -43,6 +43,8 @@ module Datadog
 
           tags_as_array: flush.tags_as_array,
           internal_metadata_json: flush.internal_metadata_json,
+
+          info_json: flush.info_json
         )
 
         if status == :ok
@@ -117,7 +119,8 @@ module Datadog
         code_provenance_file_name:,
         code_provenance_data:,
         tags_as_array:,
-        internal_metadata_json:
+        internal_metadata_json:,
+        info_json:
       )
         self.class._native_do_export(
           exporter_configuration,
@@ -132,6 +135,7 @@ module Datadog
           code_provenance_data,
           tags_as_array,
           internal_metadata_json,
+          info_json,
         )
       end
 

data/lib/datadog/profiling/load_native_extension.rb

@@ -1,23 +1,23 @@
 # This file is used to load the profiling native extension. It works in two steps:
 #
-# 1. Load the ddtrace_profiling_loader extension. This extension will be used to load the actual extension, but in
-#    a special way that avoids exposing native-level code symbols. See `ddtrace_profiling_loader.c` for more details.
+# 1. Load the datadog_profiling_loader extension. This extension will be used to load the actual extension, but in
+#    a special way that avoids exposing native-level code symbols. See `datadog_profiling_loader.c` for more details.
 #
-# 2. Use the Datadog::Profiling::Loader exposed by the ddtrace_profiling_loader extension to load the actual
+# 2. Use the Datadog::Profiling::Loader exposed by the datadog_profiling_loader extension to load the actual
 #    profiling native extension.
 #
 # All code on this file is on-purpose at the top-level; this makes it so this file is executed only once,
 # the first time it gets required, to avoid any issues with the native extension being initialized more than once.
 
 begin
-  require "ddtrace_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+  require "datadog_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
 rescue LoadError => e
   raise LoadError,
     'Failed to load the profiling loader extension. To fix this, please remove and then reinstall ddtrace ' \
     "(Details: #{e.message})"
 end
 
-extension_name = "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+extension_name = "datadog_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
 full_file_path = "#{__dir__}/../../#{extension_name}.#{RbConfig::CONFIG['DLEXT']}"
 init_function_name = "Init_#{extension_name.split('.').first}"
 

data/lib/datadog/profiling/native_extension.rb

@@ -3,7 +3,7 @@
 module Datadog
   module Profiling
     # This module contains classes and methods which are implemented using native code in the
-    # ext/ddtrace_profiling_native_extension folder, as well as some Ruby-level utilities that don't make sense to
+    # ext/datadog_profiling_native_extension folder, as well as some Ruby-level utilities that don't make sense to
     # write using C
     module NativeExtension
       private_class_method def self.working?

data/lib/datadog/profiling/tag_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../core/utils'
+require_relative '../core/environment/git'
 
 module Datadog
   module Profiling
@@ -23,6 +24,8 @@ module Datadog
         runtime_id: Core::Environment::Identity.id,
         runtime_platform: Core::Environment::Identity.lang_platform,
         runtime_version: Core::Environment::Identity.lang_version,
+        git_repository_url: Core::Environment::Git.git_repository_url,
+        git_commit_sha: Core::Environment::Git.git_commit_sha,
         # User-provided tags
         user_tags: settings.tags
       )
@@ -42,6 +45,8 @@ module Datadog
         tags[FORM_FIELD_TAG_ENV] = env if env
         tags[FORM_FIELD_TAG_SERVICE] = service if service
         tags[FORM_FIELD_TAG_VERSION] = version if version
+        tags[TAG_GIT_REPOSITORY_URL] = git_repository_url if git_repository_url
+        tags[TAG_GIT_COMMIT_SHA] = git_commit_sha if git_commit_sha
 
         # Make sure everything is an utf-8 string, to avoid encoding issues in native code/libddprof/further downstream
         user_tags.merge(tags).map do |key, value|

data/lib/datadog/profiling/tasks/exec.rb

@@ -1,7 +1,7 @@
 module Datadog
   module Profiling
     module Tasks
-      # Wraps command with Datadog tracing
+      # Wraps command with Datadog profiling
       class Exec
         attr_reader :args
 
@@ -36,10 +36,10 @@ module Datadog
         def exec_with_error_handling(args)
           Kernel.exec(*args)
         rescue Errno::ENOENT => e
-          Kernel.warn "ddtracerb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
           Kernel.exit 127
         rescue Errno::EACCES, Errno::ENOEXEC => e
-          Kernel.warn "ddtracerb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
           Kernel.exit 126
         end
       end

data/lib/datadog/profiling/tasks/help.rb

@@ -1,12 +1,12 @@
 module Datadog
   module Profiling
     module Tasks
-      # Prints help message for usage of `ddtrace`
+      # Prints help message for usage of `ddprofrb`
       class Help
         def run
           puts %(
-  Usage: ddtracerb [command] [arguments]
-    exec [command]: Executes command with tracing & profiling preloaded.
+  Usage: ddprofrb [command] [arguments]
+    exec [command]: Executes command with profiling preloaded.
     help:           Prints this help message.
           )
         end

data/lib/datadog/profiling.rb

@@ -77,7 +77,7 @@ module Datadog
 
     private_class_method def self.try_reading_skipped_reason_file(file_api = File)
       # This file, if it exists, is recorded by extconf.rb during compilation of the native extension
-      skipped_reason_file = "#{__dir__}/../../ext/ddtrace_profiling_native_extension/skipped_reason.txt"
+      skipped_reason_file = "#{__dir__}/../../ext/datadog_profiling_native_extension/skipped_reason.txt"
 
       begin
         return unless file_api.exist?(skipped_reason_file)
@@ -123,13 +123,13 @@ module Datadog
       return false unless supported?
 
       require_relative 'profiling/ext/forking'
+      require_relative 'profiling/collectors/info'
       require_relative 'profiling/collectors/code_provenance'
       require_relative 'profiling/collectors/cpu_and_wall_time_worker'
       require_relative 'profiling/collectors/dynamic_sampling_rate'
       require_relative 'profiling/collectors/idle_sampling_helper'
       require_relative 'profiling/collectors/stack'
       require_relative 'profiling/collectors/thread_context'
-      require_relative 'profiling/diagnostics/environment_logger'
       require_relative 'profiling/stack_recorder'
       require_relative 'profiling/exporter'
       require_relative 'profiling/flush'

data/lib/datadog/tracing/configuration/ext.rb

@@ -18,7 +18,6 @@ module Datadog
           ENV_PEER_SERVICE_MAPPING = 'DD_TRACE_PEER_SERVICE_MAPPING'
         end
 
-        # @public_api
         module Analytics
           ENV_TRACE_ANALYTICS_ENABLED = 'DD_TRACE_ANALYTICS_ENABLED'
         end

data/lib/datadog/tracing/configuration/settings.rb

@@ -23,10 +23,11 @@ module Datadog
               # @configure_with {Datadog::Tracing}
               # @deprecated Use [Trace Retention and Ingestion](https://docs.datadoghq.com/tracing/trace_retention_and_ingestion/)
               #   controls.
-              # @public_api
+              # @!visibility private
               settings :analytics do
                 # @default `DD_TRACE_ANALYTICS_ENABLED` environment variable, otherwise `nil`
                 # @return [Boolean,nil]
+                # @!visibility private
                 option :enabled do |o|
                   o.type :bool, nilable: true
                   o.env Tracing::Configuration::Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/action_cable/configuration/settings.rb

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/action_cable/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_ACTION_CABLE_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_CABLE_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_CABLE_ANALYTICS_SAMPLE_RATE'
           SPAN_ACTION = 'action_cable.action'

data/lib/datadog/tracing/contrib/action_mailer/configuration/settings.rb

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/action_mailer/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_ACTION_MAILER_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_MAILER_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'
           SPAN_PROCESS = 'action_mailer.process'

data/lib/datadog/tracing/contrib/action_pack/configuration/settings.rb

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/action_pack/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_ACTION_PACK_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_PACK_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_PACK_ANALYTICS_SAMPLE_RATE'
           SPAN_ACTION_CONTROLLER = 'rails.action_controller'

data/lib/datadog/tracing/contrib/action_view/configuration/settings.rb

@@ -15,6 +15,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/action_view/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_ACTION_VIEW_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_VIEW_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_VIEW_ANALYTICS_SAMPLE_RATE'
           SPAN_RENDER_PARTIAL = 'rails.render_partial'

data/lib/datadog/tracing/contrib/active_job/configuration/settings.rb

@@ -18,6 +18,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED

data/lib/datadog/tracing/contrib/active_job/ext.rb

@@ -7,6 +7,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'
+          # @!visibility private
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'
 

data/lib/datadog/tracing/contrib/active_model_serializers/configuration/settings.rb

@@ -17,6 +17,7 @@ module Datadog
               o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
               o.type :bool
               o.env Ext::ENV_ANALYTICS_ENABLED