datadog 2.48.0 → 2.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (277) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +47 -1
  3. data/ext/datadog_profiling_native_extension/collectors_stack.c +1 -1
  4. data/ext/datadog_profiling_native_extension/collectors_stack.h +4 -2
  5. data/ext/datadog_profiling_native_extension/extconf.rb +3 -0
  6. data/ext/datadog_profiling_native_extension/private_vm_api_access.c +13 -21
  7. data/ext/libdatadog_api/extconf.rb +2 -0
  8. data/ext/libdatadog_api/feature_flags.c +137 -0
  9. data/ext/libdatadog_api/process_discovery.c +3 -3
  10. data/ext/libdatadog_extconf_helpers.rb +1 -1
  11. data/lib/datadog/ai_guard/contrib/rack/patcher.rb +3 -5
  12. data/lib/datadog/ai_guard/contrib/rails/patcher.rb +7 -9
  13. data/lib/datadog/ai_guard/contrib/ruby_llm/patcher.rb +3 -5
  14. data/lib/datadog/ai_guard/metrics/telemetry.rb +2 -4
  15. data/lib/datadog/appsec/actions_handler.rb +5 -7
  16. data/lib/datadog/appsec/api_security/endpoint_collection/grape_route_serializer.rb +1 -3
  17. data/lib/datadog/appsec/api_security/endpoint_collection/rails_route_serializer.rb +1 -3
  18. data/lib/datadog/appsec/api_security/endpoint_collection/sinatra_route_serializer.rb +1 -3
  19. data/lib/datadog/appsec/assets.rb +8 -10
  20. data/lib/datadog/appsec/configuration.rb +1 -1
  21. data/lib/datadog/appsec/context.rb +63 -6
  22. data/lib/datadog/appsec/contrib/active_record/instrumentation.rb +1 -3
  23. data/lib/datadog/appsec/contrib/active_record/patcher.rb +21 -24
  24. data/lib/datadog/appsec/contrib/aws_lambda/patcher.rb +3 -5
  25. data/lib/datadog/appsec/contrib/aws_lambda/waf_addresses.rb +9 -11
  26. data/lib/datadog/appsec/contrib/devise/configuration.rb +2 -4
  27. data/lib/datadog/appsec/contrib/devise/patcher.rb +3 -5
  28. data/lib/datadog/appsec/contrib/excon/patcher.rb +3 -5
  29. data/lib/datadog/appsec/contrib/faraday/patcher.rb +4 -6
  30. data/lib/datadog/appsec/contrib/graphql/patcher.rb +3 -5
  31. data/lib/datadog/appsec/contrib/rack/input_peeker.rb +3 -5
  32. data/lib/datadog/appsec/contrib/rack/patcher.rb +3 -5
  33. data/lib/datadog/appsec/contrib/rack/request_body_middleware.rb +5 -4
  34. data/lib/datadog/appsec/contrib/rack/request_middleware.rb +6 -7
  35. data/lib/datadog/appsec/contrib/rails/patcher.rb +19 -16
  36. data/lib/datadog/appsec/contrib/rails/patches/live_thread_patch.rb +33 -0
  37. data/lib/datadog/appsec/contrib/rest_client/patcher.rb +3 -5
  38. data/lib/datadog/appsec/contrib/sinatra/patcher.rb +4 -6
  39. data/lib/datadog/appsec/default_header_tags.rb +2 -4
  40. data/lib/datadog/appsec/metrics/exporter.rb +4 -6
  41. data/lib/datadog/appsec/metrics/telemetry.rb +1 -3
  42. data/lib/datadog/appsec/metrics/telemetry_exporter.rb +2 -4
  43. data/lib/datadog/appsec/route_normalizer/route_text.rb +1 -3
  44. data/lib/datadog/appsec/route_normalizer.rb +4 -6
  45. data/lib/datadog/appsec/utils/http/body_reader.rb +3 -5
  46. data/lib/datadog/appsec/utils/http/url_encoded.rb +2 -4
  47. data/lib/datadog/core/borrowing_token_bucket.rb +60 -0
  48. data/lib/datadog/core/chunker.rb +1 -3
  49. data/lib/datadog/core/configuration/components.rb +48 -17
  50. data/lib/datadog/core/configuration/settings.rb +2 -1
  51. data/lib/datadog/core/configuration/supported_configurations.rb +2 -0
  52. data/lib/datadog/core/diagnostics/environment_logger.rb +1 -6
  53. data/lib/datadog/core/encoding.rb +8 -12
  54. data/lib/datadog/core/environment/cgroup.rb +3 -5
  55. data/lib/datadog/core/environment/container.rb +9 -11
  56. data/lib/datadog/core/environment/ext.rb +1 -6
  57. data/lib/datadog/core/environment/gc.rb +2 -4
  58. data/lib/datadog/core/environment/identity.rb +13 -15
  59. data/lib/datadog/core/environment/platform.rb +10 -12
  60. data/lib/datadog/core/environment/socket.rb +3 -5
  61. data/lib/datadog/core/environment/thread_count.rb +2 -4
  62. data/lib/datadog/core/environment/variable_helpers.rb +2 -6
  63. data/lib/datadog/core/environment/vm_cache.rb +5 -7
  64. data/lib/datadog/core/environment/yjit.rb +25 -24
  65. data/lib/datadog/core/logger.rb +5 -2
  66. data/lib/datadog/core/metrics/client.rb +8 -16
  67. data/lib/datadog/core/metrics/helpers.rb +3 -0
  68. data/lib/datadog/core/metrics/metric.rb +3 -1
  69. data/lib/datadog/core/rate_limiter.rb +9 -31
  70. data/lib/datadog/core/refillable_bucket.rb +72 -0
  71. data/lib/datadog/core/remote/client/capabilities.rb +4 -0
  72. data/lib/datadog/core/remote/client.rb +1 -5
  73. data/lib/datadog/core/remote/transport/http.rb +2 -4
  74. data/lib/datadog/core/tag_normalizer.rb +0 -2
  75. data/lib/datadog/core/telemetry/configuration_value.rb +1 -3
  76. data/lib/datadog/core/telemetry/transport/http.rb +2 -4
  77. data/lib/datadog/core/telemetry/worker.rb +30 -24
  78. data/lib/datadog/core/transport/http.rb +2 -4
  79. data/lib/datadog/core/utils/at_fork_monkey_patch.rb +2 -2
  80. data/lib/datadog/core/utils/forking.rb +1 -1
  81. data/lib/datadog/core/utils/lru_cache.rb +2 -2
  82. data/lib/datadog/core/utils/network.rb +1 -1
  83. data/lib/datadog/core/utils/time.rb +2 -2
  84. data/lib/datadog/core/utils/truncation.rb +1 -3
  85. data/lib/datadog/core/workers/async.rb +16 -14
  86. data/lib/datadog/core/workers/runtime_metrics.rb +1 -1
  87. data/lib/datadog/data_streams/transport/http.rb +1 -3
  88. data/lib/datadog/di/component.rb +14 -2
  89. data/lib/datadog/di/context.rb +50 -0
  90. data/lib/datadog/di/contrib.rb +2 -2
  91. data/lib/datadog/di/correlation_sampler/trace_budget.rb +75 -0
  92. data/lib/datadog/di/correlation_sampler/trace_budget_ledger/entry.rb +34 -0
  93. data/lib/datadog/di/correlation_sampler/trace_budget_ledger.rb +104 -0
  94. data/lib/datadog/di/correlation_sampler.rb +224 -0
  95. data/lib/datadog/di/guardrails_telemetry/reason.rb +8 -3
  96. data/lib/datadog/di/instrumenter.rb +294 -109
  97. data/lib/datadog/di/probe.rb +13 -2
  98. data/lib/datadog/di/probe_builder.rb +6 -8
  99. data/lib/datadog/di/probe_file_loader.rb +2 -2
  100. data/lib/datadog/di/probe_manager.rb +7 -30
  101. data/lib/datadog/di/probe_notification_builder.rb +42 -11
  102. data/lib/datadog/di/probe_notifier_worker.rb +11 -0
  103. data/lib/datadog/di/snapshot_pruner/node.rb +190 -0
  104. data/lib/datadog/di/snapshot_pruner/node_queue.rb +104 -0
  105. data/lib/datadog/di/snapshot_pruner/parser.rb +102 -0
  106. data/lib/datadog/di/snapshot_pruner.rb +128 -0
  107. data/lib/datadog/di/transport/input.rb +75 -15
  108. data/lib/datadog/di/utils.rb +3 -3
  109. data/lib/datadog/di.rb +29 -0
  110. data/lib/datadog/error_tracking/filters.rb +6 -8
  111. data/lib/datadog/open_feature/agentless/parser.rb +2 -4
  112. data/lib/datadog/open_feature/component.rb +24 -2
  113. data/lib/datadog/open_feature/configuration.rb +13 -0
  114. data/lib/datadog/open_feature/evaluation_engine.rb +5 -5
  115. data/lib/datadog/open_feature/exposure_hook.rb +146 -0
  116. data/lib/datadog/open_feature/exposures/event.rb +10 -8
  117. data/lib/datadog/open_feature/exposures/reporter.rb +34 -25
  118. data/lib/datadog/open_feature/ext.rb +12 -0
  119. data/lib/datadog/open_feature/flag_evaluation/aggregator.rb +10 -8
  120. data/lib/datadog/open_feature/flag_evaluation/writer.rb +9 -6
  121. data/lib/datadog/open_feature/hooks/exposure_logging_hook.rb +58 -0
  122. data/lib/datadog/open_feature/hooks/flag_eval_evp_hook.rb +4 -2
  123. data/lib/datadog/open_feature/hooks/flag_eval_metrics_hook.rb +3 -5
  124. data/lib/datadog/open_feature/hooks/span_enrichment_hook/codec.rb +3 -5
  125. data/lib/datadog/open_feature/native_evaluator.rb +30 -2
  126. data/lib/datadog/open_feature/noop_evaluator.rb +3 -1
  127. data/lib/datadog/open_feature/provider.rb +54 -4
  128. data/lib/datadog/open_feature/resolution_details.rb +1 -0
  129. data/lib/datadog/open_feature/split_features.rb +76 -0
  130. data/lib/datadog/opentelemetry/sdk/propagator.rb +5 -2
  131. data/lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb +28 -31
  132. data/lib/datadog/profiling/component.rb +31 -9
  133. data/lib/datadog/profiling/profiler.rb +6 -0
  134. data/lib/datadog/profiling/remote.rb +381 -0
  135. data/lib/datadog/profiling/worker_state.rb +65 -0
  136. data/lib/datadog/profiling.rb +1 -0
  137. data/lib/datadog/symbol_database/file_hash.rb +1 -3
  138. data/lib/datadog/tracing/component.rb +14 -16
  139. data/lib/datadog/tracing/configuration/settings.rb +2 -2
  140. data/lib/datadog/tracing/contrib/action_cable/events/broadcast.rb +4 -6
  141. data/lib/datadog/tracing/contrib/action_cable/events/perform_action.rb +4 -6
  142. data/lib/datadog/tracing/contrib/action_cable/events/transmit.rb +4 -6
  143. data/lib/datadog/tracing/contrib/action_cable/events.rb +3 -5
  144. data/lib/datadog/tracing/contrib/action_cable/patcher.rb +2 -4
  145. data/lib/datadog/tracing/contrib/action_mailer/events/deliver.rb +5 -7
  146. data/lib/datadog/tracing/contrib/action_mailer/events/process.rb +4 -6
  147. data/lib/datadog/tracing/contrib/action_mailer/events.rb +3 -5
  148. data/lib/datadog/tracing/contrib/action_mailer/patcher.rb +2 -4
  149. data/lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb +2 -4
  150. data/lib/datadog/tracing/contrib/action_pack/action_controller/patcher.rb +2 -4
  151. data/lib/datadog/tracing/contrib/action_pack/action_dispatch/instrumentation.rb +2 -4
  152. data/lib/datadog/tracing/contrib/action_pack/action_dispatch/patcher.rb +2 -4
  153. data/lib/datadog/tracing/contrib/action_pack/patcher.rb +2 -4
  154. data/lib/datadog/tracing/contrib/action_view/events/render_partial.rb +3 -5
  155. data/lib/datadog/tracing/contrib/action_view/events/render_template.rb +3 -5
  156. data/lib/datadog/tracing/contrib/action_view/events.rb +3 -5
  157. data/lib/datadog/tracing/contrib/action_view/patcher.rb +3 -5
  158. data/lib/datadog/tracing/contrib/action_view/utils.rb +1 -3
  159. data/lib/datadog/tracing/contrib/active_job/events/discard.rb +3 -5
  160. data/lib/datadog/tracing/contrib/active_job/events/enqueue.rb +3 -5
  161. data/lib/datadog/tracing/contrib/active_job/events/enqueue_at.rb +3 -5
  162. data/lib/datadog/tracing/contrib/active_job/events/enqueue_retry.rb +3 -5
  163. data/lib/datadog/tracing/contrib/active_job/events/perform.rb +3 -5
  164. data/lib/datadog/tracing/contrib/active_job/events/retry_stopped.rb +3 -5
  165. data/lib/datadog/tracing/contrib/active_job/events.rb +3 -5
  166. data/lib/datadog/tracing/contrib/active_job/patcher.rb +4 -6
  167. data/lib/datadog/tracing/contrib/active_model_serializers/events/render.rb +4 -6
  168. data/lib/datadog/tracing/contrib/active_model_serializers/events/serialize.rb +4 -6
  169. data/lib/datadog/tracing/contrib/active_model_serializers/events.rb +3 -5
  170. data/lib/datadog/tracing/contrib/active_model_serializers/patcher.rb +3 -5
  171. data/lib/datadog/tracing/contrib/active_record/events/instantiation.rb +4 -6
  172. data/lib/datadog/tracing/contrib/active_record/events/sql.rb +3 -5
  173. data/lib/datadog/tracing/contrib/active_record/events.rb +3 -5
  174. data/lib/datadog/tracing/contrib/active_record/patcher.rb +2 -4
  175. data/lib/datadog/tracing/contrib/active_support/cache/events/cache.rb +8 -10
  176. data/lib/datadog/tracing/contrib/active_support/cache/events.rb +3 -5
  177. data/lib/datadog/tracing/contrib/active_support/cache/instrumentation.rb +5 -7
  178. data/lib/datadog/tracing/contrib/active_support/cache/patcher.rb +4 -6
  179. data/lib/datadog/tracing/contrib/active_support/patcher.rb +2 -4
  180. data/lib/datadog/tracing/contrib/analytics.rb +4 -6
  181. data/lib/datadog/tracing/contrib/aws/patcher.rb +5 -7
  182. data/lib/datadog/tracing/contrib/concurrent_ruby/patcher.rb +5 -7
  183. data/lib/datadog/tracing/contrib/configuration/settings.rb +17 -0
  184. data/lib/datadog/tracing/contrib/dalli/patcher.rb +2 -4
  185. data/lib/datadog/tracing/contrib/dalli/quantize.rb +1 -3
  186. data/lib/datadog/tracing/contrib/delayed_job/patcher.rb +4 -6
  187. data/lib/datadog/tracing/contrib/elasticsearch/patcher.rb +3 -5
  188. data/lib/datadog/tracing/contrib/elasticsearch/quantize.rb +6 -8
  189. data/lib/datadog/tracing/contrib/ethon/patcher.rb +2 -4
  190. data/lib/datadog/tracing/contrib/excon/patcher.rb +3 -5
  191. data/lib/datadog/tracing/contrib/faraday/patcher.rb +4 -6
  192. data/lib/datadog/tracing/contrib/grape/patcher.rb +2 -4
  193. data/lib/datadog/tracing/contrib/graphql/patcher.rb +4 -6
  194. data/lib/datadog/tracing/contrib/graphql/trace_patcher.rb +1 -3
  195. data/lib/datadog/tracing/contrib/graphql/tracing_patcher.rb +1 -3
  196. data/lib/datadog/tracing/contrib/graphql/unified_trace_patcher.rb +1 -3
  197. data/lib/datadog/tracing/contrib/grpc/patcher.rb +3 -5
  198. data/lib/datadog/tracing/contrib/hanami/patcher.rb +2 -4
  199. data/lib/datadog/tracing/contrib/http/patcher.rb +2 -4
  200. data/lib/datadog/tracing/contrib/httpclient/patcher.rb +2 -4
  201. data/lib/datadog/tracing/contrib/httprb/patcher.rb +2 -4
  202. data/lib/datadog/tracing/contrib/kafka/events/connection/request.rb +4 -6
  203. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_batch.rb +3 -5
  204. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_message.rb +3 -5
  205. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/heartbeat.rb +3 -5
  206. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/join_group.rb +2 -4
  207. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/leave_group.rb +2 -4
  208. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/sync_group.rb +2 -4
  209. data/lib/datadog/tracing/contrib/kafka/events/produce_operation/send_messages.rb +4 -6
  210. data/lib/datadog/tracing/contrib/kafka/events/producer/deliver_messages.rb +4 -6
  211. data/lib/datadog/tracing/contrib/kafka/events.rb +3 -5
  212. data/lib/datadog/tracing/contrib/kafka/patcher.rb +4 -6
  213. data/lib/datadog/tracing/contrib/karafka/patcher.rb +2 -4
  214. data/lib/datadog/tracing/contrib/lograge/patcher.rb +2 -4
  215. data/lib/datadog/tracing/contrib/mongodb/parsers.rb +5 -7
  216. data/lib/datadog/tracing/contrib/mongodb/patcher.rb +3 -5
  217. data/lib/datadog/tracing/contrib/mysql2/patcher.rb +3 -5
  218. data/lib/datadog/tracing/contrib/opensearch/patcher.rb +1 -3
  219. data/lib/datadog/tracing/contrib/opensearch/quantize.rb +5 -7
  220. data/lib/datadog/tracing/contrib/pg/patcher.rb +3 -5
  221. data/lib/datadog/tracing/contrib/presto/patcher.rb +1 -3
  222. data/lib/datadog/tracing/contrib/que/patcher.rb +2 -4
  223. data/lib/datadog/tracing/contrib/racecar/events/batch.rb +3 -5
  224. data/lib/datadog/tracing/contrib/racecar/events/consume.rb +3 -5
  225. data/lib/datadog/tracing/contrib/racecar/events/message.rb +3 -5
  226. data/lib/datadog/tracing/contrib/racecar/events.rb +3 -5
  227. data/lib/datadog/tracing/contrib/racecar/patcher.rb +2 -4
  228. data/lib/datadog/tracing/contrib/rack/patcher.rb +13 -19
  229. data/lib/datadog/tracing/contrib/rack/request_queue.rb +1 -3
  230. data/lib/datadog/tracing/contrib/rack/route_inference.rb +4 -6
  231. data/lib/datadog/tracing/contrib/rack/trace_proxy_middleware.rb +4 -6
  232. data/lib/datadog/tracing/contrib/rails/configuration/settings.rb +4 -0
  233. data/lib/datadog/tracing/contrib/rails/ext.rb +2 -0
  234. data/lib/datadog/tracing/contrib/rails/framework.rb +6 -8
  235. data/lib/datadog/tracing/contrib/rails/log_injection.rb +1 -3
  236. data/lib/datadog/tracing/contrib/rails/patcher.rb +9 -11
  237. data/lib/datadog/tracing/contrib/rake/patcher.rb +3 -5
  238. data/lib/datadog/tracing/contrib/redis/patcher.rb +2 -4
  239. data/lib/datadog/tracing/contrib/redis/quantize.rb +7 -9
  240. data/lib/datadog/tracing/contrib/resque/patcher.rb +2 -4
  241. data/lib/datadog/tracing/contrib/rest_client/patcher.rb +2 -4
  242. data/lib/datadog/tracing/contrib/roda/patcher.rb +2 -4
  243. data/lib/datadog/tracing/contrib/semantic_logger/patcher.rb +2 -4
  244. data/lib/datadog/tracing/contrib/sequel/patcher.rb +4 -6
  245. data/lib/datadog/tracing/contrib/shoryuken/patcher.rb +2 -4
  246. data/lib/datadog/tracing/contrib/sidekiq/patcher.rb +7 -9
  247. data/lib/datadog/tracing/contrib/sinatra/env.rb +3 -5
  248. data/lib/datadog/tracing/contrib/sinatra/patcher.rb +5 -7
  249. data/lib/datadog/tracing/contrib/sneakers/patcher.rb +2 -4
  250. data/lib/datadog/tracing/contrib/stripe/patcher.rb +2 -4
  251. data/lib/datadog/tracing/contrib/stripe/request.rb +4 -6
  252. data/lib/datadog/tracing/contrib/sucker_punch/exception_handler.rb +1 -3
  253. data/lib/datadog/tracing/contrib/sucker_punch/instrumentation.rb +1 -3
  254. data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb +3 -5
  255. data/lib/datadog/tracing/contrib/support.rb +1 -3
  256. data/lib/datadog/tracing/contrib/trilogy/configuration/settings.rb +4 -0
  257. data/lib/datadog/tracing/contrib/trilogy/instrumentation.rb +2 -1
  258. data/lib/datadog/tracing/contrib/trilogy/patcher.rb +3 -5
  259. data/lib/datadog/tracing/contrib/utils/database.rb +1 -3
  260. data/lib/datadog/tracing/contrib/utils/quantization/hash_formatter.rb +8 -10
  261. data/lib/datadog/tracing/contrib/utils/quantization/http.rb +11 -13
  262. data/lib/datadog/tracing/contrib/waterdrop/patcher.rb +3 -5
  263. data/lib/datadog/tracing/correlation.rb +3 -5
  264. data/lib/datadog/tracing/distributed/propagation.rb +2 -2
  265. data/lib/datadog/tracing/distributed/propagation_policy.rb +1 -3
  266. data/lib/datadog/tracing/distributed/trace_state/datadog.rb +5 -5
  267. data/lib/datadog/tracing/distributed/trace_state/open_telemetry.rb +2 -2
  268. data/lib/datadog/tracing/metadata/ext.rb +3 -9
  269. data/lib/datadog/tracing/remote.rb +1 -1
  270. data/lib/datadog/tracing/trace_operation.rb +11 -3
  271. data/lib/datadog/tracing/tracer.rb +9 -1
  272. data/lib/datadog/tracing/transport/http.rb +1 -3
  273. data/lib/datadog/tracing/transport/io.rb +2 -4
  274. data/lib/datadog/tracing/transport/traces.rb +1 -3
  275. data/lib/datadog/tracing/utils.rb +4 -6
  276. data/lib/datadog/version.rb +1 -1
  277. metadata +22 -6
@@ -7,6 +7,38 @@ module Datadog
7
7
  #
8
8
  # @api private
9
9
  class Context
10
+ # Initializes the context with the probe hit's state.
11
+ #
12
+ # @param probe [Datadog::DI::Probe] the probe whose hit is being
13
+ # evaluated
14
+ # @param settings [Datadog::Core::Configuration::Settings] the current
15
+ # configuration settings
16
+ # @param serializer [Datadog::DI::Serializer] the serializer for
17
+ # captured values
18
+ # @param locals [Hash{Symbol => Object}, nil] local variables captured
19
+ # at the probe hit
20
+ # @param target_self [Object, nil] the object the instrumented method
21
+ # runs on
22
+ # @param path [String, nil] actual path of the instrumented file
23
+ # @param caller_locations [Array<Thread::Backtrace::Location>, nil]
24
+ # stack frames captured at the probe hit
25
+ # @param serialized_entry_args [Hash{Symbol => Object}, nil] entry
26
+ # arguments of the instrumented method, in serialized form
27
+ # @param entry_capture_expressions [Hash{String => Object}, nil] entry
28
+ # capture expressions, in serialized form
29
+ # @param entry_capture_evaluation_errors [Array<Datadog::DI::EvaluationFailure>, nil]
30
+ # failures from evaluating the entry capture expressions
31
+ # @param admission_trace [Datadog::Tracing::TraceOperation, nil] the
32
+ # APM trace active when the sampling gate admitted the probe hit
33
+ # @param admission_span [Datadog::Tracing::SpanOperation, nil] the APM
34
+ # span active when the sampling gate admitted the probe hit
35
+ # @param return_value [Object, nil] the instrumented method's return
36
+ # value, for a method probe
37
+ # @param duration [Float, nil] the instrumented method's execution
38
+ # time, in seconds, for a method probe
39
+ # @param exception [Exception, nil] the exception raised by the
40
+ # instrumented method, for a method probe
41
+ # @return [void]
10
42
  def initialize(probe:, settings:, serializer:, locals: nil,
11
43
  # In Ruby everything is a method, therefore we should always have
12
44
  # a target self. However, if we are not capturing a snapshot,
@@ -16,6 +48,8 @@ module Datadog
16
48
  serialized_entry_args: nil,
17
49
  entry_capture_expressions: nil,
18
50
  entry_capture_evaluation_errors: nil,
51
+ admission_trace: nil,
52
+ admission_span: nil,
19
53
  return_value: nil, duration: nil, exception: nil)
20
54
  @probe = probe
21
55
  @settings = settings
@@ -27,6 +61,8 @@ module Datadog
27
61
  @serialized_entry_args = serialized_entry_args
28
62
  @entry_capture_expressions = entry_capture_expressions
29
63
  @entry_capture_evaluation_errors = entry_capture_evaluation_errors
64
+ @admission_trace = admission_trace
65
+ @admission_span = admission_span
30
66
  @return_value = return_value
31
67
  @duration = duration
32
68
  @exception = exception
@@ -52,6 +88,20 @@ module Datadog
52
88
 
53
89
  attr_reader :entry_capture_evaluation_errors
54
90
 
91
+ # The APM trace active when the probe's hit was admitted by the
92
+ # sampling gate, for a method probe; nil when the hit carried no
93
+ # admission trace.
94
+ #
95
+ # @return [Datadog::Tracing::TraceOperation, nil]
96
+ attr_reader :admission_trace
97
+
98
+ # The APM span active when the probe's hit was admitted by the
99
+ # sampling gate, for a method probe; nil when the hit carried no
100
+ # admission span.
101
+ #
102
+ # @return [Datadog::Tracing::SpanOperation, nil]
103
+ attr_reader :admission_span
104
+
55
105
  # Return value for the method, for a method probe
56
106
  attr_reader :return_value
57
107
 
@@ -5,7 +5,7 @@ require_relative "../core/contrib/rails/utils"
5
5
  module Datadog
6
6
  module DI
7
7
  module Contrib
8
- module_function def load_now_or_later
8
+ def self.load_now_or_later
9
9
  if Datadog::Core::Contrib::Rails::Utils.railtie_supported?
10
10
  Datadog.logger.debug("di: loading contrib/railtie")
11
11
  require_relative "contrib/railtie"
@@ -17,7 +17,7 @@ module Datadog
17
17
  # This method can be called more than once, to attempt to load
18
18
  # DI components that depend on third-party libraries after additional
19
19
  # dependencies are loaded (or potentially loaded).
20
- module_function def load_now
20
+ def self.load_now
21
21
  if defined?(ActiveRecord::Base)
22
22
  Datadog.logger.debug("di: loading contrib/active_record")
23
23
  require_relative "contrib/active_record"
@@ -0,0 +1,75 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Datadog
4
+ module DI
5
+ class CorrelationSampler
6
+ # Per-trace emission counters: an all counter shared by every probe,
7
+ # and a per-probe counter that starts at +per_probe_budget+ for each
8
+ # distinct probe.
9
+ #
10
+ # @api private
11
+ class TraceBudget
12
+ # Validates the budget arguments, raising ArgumentError when either
13
+ # is negative or non-Integer.
14
+ #
15
+ # @param per_probe_budget [Integer] per-probe counter start value
16
+ # @param all_budget [Integer] all-probe counter start value
17
+ # @return [void]
18
+ def self.validate_budgets!(per_probe_budget:, all_budget:)
19
+ unless per_probe_budget.is_a?(Integer) && per_probe_budget >= 0
20
+ raise ArgumentError, "per_probe_budget must be a non-negative Integer: #{per_probe_budget}"
21
+ end
22
+ unless all_budget.is_a?(Integer) && all_budget >= 0
23
+ raise ArgumentError, "all_budget must be a non-negative Integer: #{all_budget}"
24
+ end
25
+ nil
26
+ end
27
+
28
+ # Initializes the all-probe counter to +all_budget+ with each probe's
29
+ # counter starting at +per_probe_budget+.
30
+ #
31
+ # @param per_probe_budget [Integer] per-probe counter start value
32
+ # @param all_budget [Integer] all-probe counter start value
33
+ # @raise [ArgumentError] when either budget is negative or
34
+ # non-Integer
35
+ # @return [void]
36
+ def initialize(per_probe_budget:, all_budget:)
37
+ TraceBudget.validate_budgets!(per_probe_budget: per_probe_budget, all_budget: all_budget)
38
+
39
+ @all_remaining = all_budget
40
+ @per_probe_budget = per_probe_budget
41
+ @per_probe = {}
42
+ end
43
+
44
+ # Remaining all-probe counter.
45
+ #
46
+ # @return [Integer]
47
+ attr_reader :all_remaining
48
+
49
+ # Per-probe counter start value this budget was constructed with.
50
+ #
51
+ # @return [Integer]
52
+ attr_reader :per_probe_budget
53
+
54
+ # Remaining per-probe counters, keyed by probe id.
55
+ #
56
+ # @return [Hash[String, Integer]]
57
+ attr_reader :per_probe
58
+
59
+ # Consumes one per-probe and one all token for +probe_id+.
60
+ #
61
+ # @param probe_id [String]
62
+ # @return [Boolean] true when both counters had budget and were
63
+ # consumed, false when either was exhausted
64
+ def admit(probe_id)
65
+ remaining = per_probe.fetch(probe_id, per_probe_budget)
66
+ return false if remaining <= 0 || all_remaining <= 0
67
+
68
+ per_probe[probe_id] = remaining - 1
69
+ @all_remaining = all_remaining - 1
70
+ true
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Datadog
4
+ module DI
5
+ class CorrelationSampler
6
+ class TraceBudgetLedger
7
+ # Retained budget and the weak reference to its trace.
8
+ #
9
+ # @api private
10
+ class Entry
11
+ # Weak reference to the trace the budget belongs to.
12
+ #
13
+ # @return [WeakRef]
14
+ attr_reader :trace_ref
15
+
16
+ # The trace's budget.
17
+ #
18
+ # @return [TraceBudget]
19
+ attr_reader :budget
20
+
21
+ # Initializes the entry.
22
+ #
23
+ # @param trace_ref [WeakRef] weak reference to the entry's trace
24
+ # @param budget [TraceBudget] the trace's budget
25
+ # @return [void]
26
+ def initialize(trace_ref:, budget:)
27
+ @trace_ref = trace_ref
28
+ @budget = budget
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,104 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "weakref"
4
+
5
+ require_relative "trace_budget_ledger/entry"
6
+
7
+ module Datadog
8
+ module DI
9
+ class CorrelationSampler
10
+ # Store of per-trace budgets, keyed by the trace object and bound to its
11
+ # lifetime: an entry dies with its trace, and a live trace keeps its
12
+ # entry. Dead entries are dropped by a lazy sweep once the entry
13
+ # count passes the sweep high-water mark.
14
+ #
15
+ # A continued trace is a distinct trace object and establishes its own
16
+ # unit. Datadog::Tracing.continue_trace! builds a new TraceOperation
17
+ # for the same trace id, and the ledger keys that object as a separate
18
+ # trace with its own budget.
19
+ #
20
+ # @api private
21
+ class TraceBudgetLedger
22
+ # Initializes the ledger with +sweep_threshold+ as the floor of the
23
+ # sweep high-water mark.
24
+ #
25
+ # @param sweep_threshold [Integer] lower bound on the entry count that
26
+ # triggers a sweep of dead entries
27
+ # @raise [ArgumentError] when sweep_threshold is not a positive Integer
28
+ # @return [void]
29
+ def initialize(sweep_threshold)
30
+ unless sweep_threshold.is_a?(Integer) && sweep_threshold.positive?
31
+ raise ArgumentError, "sweep_threshold must be a positive Integer: #{sweep_threshold}"
32
+ end
33
+
34
+ @sweep_threshold = sweep_threshold
35
+ @entries = {}
36
+ @live_count = 0
37
+ end
38
+
39
+ # Floor of the sweep high-water mark.
40
+ #
41
+ # @return [Integer]
42
+ attr_reader :sweep_threshold
43
+
44
+ # Retained budget entries keyed by trace object id.
45
+ #
46
+ # @return [Hash[Integer, Entry]]
47
+ attr_reader :entries
48
+
49
+ # Returns the budget stored for +trace+, or nil when the trace has no
50
+ # stored budget. A dead weak reference is discarded as a miss.
51
+ #
52
+ # @param trace [Datadog::Tracing::TraceOperation] the active trace
53
+ # @return [TraceBudget, nil]
54
+ def fetch(trace)
55
+ entry = entries[trace.object_id]
56
+ return nil unless entry
57
+
58
+ if entry.trace_ref.weakref_alive? && entry.trace_ref.__getobj__.equal?(trace)
59
+ entry.budget
60
+ else
61
+ entries.delete(trace.object_id)
62
+ nil
63
+ end
64
+ end
65
+
66
+ # Stores +budget+ for +trace+.
67
+ #
68
+ # @param trace [Datadog::Tracing::TraceOperation] the active trace
69
+ # @param budget [TraceBudget] the trace's budget
70
+ # @return [void]
71
+ def store(trace, budget)
72
+ sweep if entries.size >= sweep_bound
73
+ entries[trace.object_id] = Entry.new(trace_ref: WeakRef.new(trace), budget: budget)
74
+ nil
75
+ end
76
+
77
+ private
78
+
79
+ # Live entry count after the last sweep.
80
+ #
81
+ # @return [Integer]
82
+ attr_reader :live_count
83
+
84
+ # Entry count that triggers the next sweep: at least +sweep_threshold+,
85
+ # and at least twice the live count, so an all-live store is swept once
86
+ # per doubling.
87
+ #
88
+ # @return [Integer]
89
+ def sweep_bound
90
+ [sweep_threshold, live_count * 2].max
91
+ end
92
+
93
+ # Drops entries whose trace is gone.
94
+ #
95
+ # @return [void]
96
+ def sweep
97
+ entries.delete_if { |_id, entry| !entry.trace_ref.weakref_alive? }
98
+ @live_count = entries.size
99
+ nil
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,224 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../core/rate_limiter"
4
+ require_relative "correlation_sampler/trace_budget"
5
+ require_relative "correlation_sampler/trace_budget_ledger"
6
+
7
+ module Datadog
8
+ module DI
9
+ # Sampling gate that coordinates capturing Live Debugger probe hits within
10
+ # one trace and bounds total snapshot volume with process-wide budgets.
11
+ #
12
+ # @api private
13
+ class CorrelationSampler
14
+ # Sweep floor for the per-trace budget ledger.
15
+ DEFAULT_SWEEP_THRESHOLD = 4096
16
+
17
+ # Snapshots per second, process-wide, that may establish an emitting
18
+ # trace.
19
+ TOP_RATE = 10
20
+
21
+ # Snapshots per second, process-wide, across all emits.
22
+ GLOBAL_RATE = 20
23
+
24
+ # Snapshots one probe may emit within one trace.
25
+ PER_PROBE_BUDGET = 1
26
+
27
+ # Snapshots all probes together may emit within one trace.
28
+ ALL_BUDGET = 20
29
+
30
+ # Initializes an empty per-trace ledger and full process-wide TOP/GLOBAL
31
+ # buckets.
32
+ #
33
+ # @param sweep_threshold [Integer] sweep floor for the per-trace budget
34
+ # ledger
35
+ # @param top_rate [Numeric] TOP rate limit, snapshots/second
36
+ # @param global_rate [Numeric] GLOBAL rate limit, snapshots/second
37
+ # @param per_probe_budget [Integer] per-probe counter start value for
38
+ # each trace's budget
39
+ # @param all_budget [Integer] all-probe counter start value for each
40
+ # trace's budget
41
+ # @raise [ArgumentError] when sweep_threshold is zero, negative, or
42
+ # non-Integer, or when per_probe_budget or all_budget is negative
43
+ # or non-Integer
44
+ # @return [void]
45
+ def initialize(sweep_threshold: DEFAULT_SWEEP_THRESHOLD, top_rate: TOP_RATE,
46
+ global_rate: GLOBAL_RATE, per_probe_budget: PER_PROBE_BUDGET,
47
+ all_budget: ALL_BUDGET)
48
+ TraceBudget.validate_budgets!(per_probe_budget: per_probe_budget, all_budget: all_budget)
49
+
50
+ @per_probe_budget = per_probe_budget
51
+ @all_budget = all_budget
52
+ @sweep_threshold = sweep_threshold
53
+ @top_rate = top_rate
54
+ @global_rate = global_rate
55
+ rebuild_state
56
+ end
57
+
58
+ # Decides whether this capturing probe hit emits a snapshot, and names
59
+ # the drop decision for a denial.
60
+ #
61
+ # @param probe [Datadog::DI::Probe]
62
+ # @param trace [Datadog::Tracing::TraceOperation, nil]
63
+ # @return [Array(Boolean, Symbol, nil)] the admitted flag, and the drop
64
+ # decision naming the denying limit: +:own_rate_limit+,
65
+ # +:global_budget+, +:top_gate+ or +:trace_budget+, nil when admitted
66
+ def emit_with_reason?(probe, trace)
67
+ lock.synchronize do
68
+ return emit_uncorrelated?(probe) if trace.nil?
69
+
70
+ budget = trace_budgets.fetch(trace)
71
+ if budget
72
+ emit_correlated?(budget, probe)
73
+ else
74
+ emit_first_probe?(probe, trace)
75
+ end
76
+ end
77
+ end
78
+
79
+ # Decides whether this capturing probe hit emits a snapshot.
80
+ #
81
+ # @param probe [Datadog::DI::Probe]
82
+ # @param trace [Datadog::Tracing::TraceOperation, nil]
83
+ # @return [Boolean]
84
+ def emit?(probe, trace)
85
+ admitted, = emit_with_reason?(probe, trace)
86
+ admitted
87
+ end
88
+
89
+ # Consumes one GLOBAL token for a snapshot payload the coordinated
90
+ # emit path does not gate, such as a condition-evaluation-failure
91
+ # notification with no active trace or from a non-capturing probe.
92
+ # GLOBAL admits the payload only while the balance is
93
+ # positive, matching the uncorrelated emit path, so condition-error
94
+ # payloads and capturing emits share one process-wide snapshot budget.
95
+ #
96
+ # @return [Boolean] true when the process-wide budget admits the payload
97
+ def admit_process_wide_snapshot?
98
+ lock.synchronize do
99
+ global_limiter.try_consume
100
+ end
101
+ end
102
+
103
+ # Rebuilds the process-scoped state for a freshly forked child. Must
104
+ # run while the child is single-threaded.
105
+ #
106
+ # @return [void]
107
+ def after_fork!
108
+ rebuild_state
109
+ nil
110
+ end
111
+
112
+ private
113
+
114
+ # Process-wide mutex guarding trace_budgets and the shared limiters.
115
+ # @return [Thread::Mutex]
116
+ attr_reader :lock
117
+
118
+ # Store of per-trace budgets, keyed by the trace object.
119
+ # @return [TraceBudgetLedger]
120
+ attr_reader :trace_budgets
121
+
122
+ # Process-wide TOP gate.
123
+ # @return [Datadog::Core::TokenBucket]
124
+ attr_reader :top_limiter
125
+
126
+ # Process-wide GLOBAL gate.
127
+ # @return [Datadog::Core::BorrowingTokenBucket]
128
+ attr_reader :global_limiter
129
+
130
+ # Per-probe counter start value this sampler seeds trace budgets with.
131
+ # @return [Integer]
132
+ attr_reader :per_probe_budget
133
+
134
+ # All-probe counter start value this sampler seeds trace budgets with.
135
+ # @return [Integer]
136
+ attr_reader :all_budget
137
+
138
+ # Sweep floor this sampler rebuilds the ledger with.
139
+ # @return [Integer]
140
+ attr_reader :sweep_threshold
141
+
142
+ # TOP rate this sampler rebuilds its TOP bucket with.
143
+ # @return [Numeric]
144
+ attr_reader :top_rate
145
+
146
+ # GLOBAL rate this sampler rebuilds its GLOBAL bucket with.
147
+ # @return [Numeric]
148
+ attr_reader :global_rate
149
+
150
+ # Builds the process-scoped state objects: the mutex, the per-trace
151
+ # budget ledger and the TOP/GLOBAL buckets at the configured rates.
152
+ #
153
+ # @return [void]
154
+ def rebuild_state
155
+ @lock = Mutex.new
156
+ @trace_budgets = TraceBudgetLedger.new(sweep_threshold)
157
+ @top_limiter = Core::TokenBucket.new(top_rate)
158
+ @global_limiter = Core::BorrowingTokenBucket.new(global_rate)
159
+ nil
160
+ end
161
+
162
+ # Decides a hit with no active trace through the probe's own rate
163
+ # limit and the process-wide GLOBAL budget. Must hold the lock.
164
+ #
165
+ # @param probe [Datadog::DI::Probe]
166
+ # @return [Array(Boolean, Symbol, nil)] the admitted flag and the drop
167
+ # decision, nil when admitted
168
+ def emit_uncorrelated?(probe)
169
+ return [false, :own_rate_limit] unless probe.own_rate_limit_allows?
170
+ return [false, :global_budget] unless global_limiter.try_consume
171
+
172
+ [true, nil]
173
+ end
174
+
175
+ # First capturing probe in the trace. Passes the process-wide GLOBAL and
176
+ # TOP gates to emit and seed the trace counters; on either gate's refusal,
177
+ # or when the seeded budget denies the top probe itself, marks the trace
178
+ # starved so every correlated probe in it also drops without re-querying
179
+ # the process-wide gates. The GLOBAL gate consumes its token as part of
180
+ # the check, so a hit the TOP gate refuses still spends one GLOBAL
181
+ # token, and GLOBAL refills once per hit. Must hold the lock.
182
+ #
183
+ # @param probe [Datadog::DI::Probe]
184
+ # @param trace [Datadog::Tracing::TraceOperation]
185
+ # @return [Array(Boolean, Symbol, nil)] the admitted flag and the drop
186
+ # decision, nil when admitted
187
+ def emit_first_probe?(probe, trace)
188
+ unless global_limiter.try_consume && top_limiter.allow?
189
+ store(trace, TraceBudget.new(per_probe_budget: per_probe_budget, all_budget: 0))
190
+ return [false, :top_gate]
191
+ end
192
+
193
+ budget = TraceBudget.new(per_probe_budget: per_probe_budget, all_budget: all_budget)
194
+ store(trace, budget)
195
+ return [false, :trace_budget] unless budget.admit(probe.id)
196
+
197
+ [true, nil]
198
+ end
199
+
200
+ # A capturing probe firing inside an established unit. Bounded by the
201
+ # per-probe and all counters; consumes GLOBAL on emit. Must hold the lock.
202
+ #
203
+ # @param budget [TraceBudget]
204
+ # @param probe [Datadog::DI::Probe]
205
+ # @return [Array(Boolean, Symbol, nil)] the admitted flag and the drop
206
+ # decision, nil when admitted
207
+ def emit_correlated?(budget, probe)
208
+ return [false, :trace_budget] unless budget.admit(probe.id)
209
+
210
+ global_limiter.consume
211
+ [true, nil]
212
+ end
213
+
214
+ # Stores the trace's budget in the ledger. Must hold the lock.
215
+ #
216
+ # @param trace [Datadog::Tracing::TraceOperation]
217
+ # @param budget [TraceBudget]
218
+ # @return [void]
219
+ def store(trace, budget)
220
+ trace_budgets.store(trace, budget)
221
+ end
222
+ end
223
+ end
224
+ end
@@ -16,6 +16,10 @@ module Datadog
16
16
  # process-wide rate limiter.
17
17
  RATE_LIMIT_GLOBAL = "rateLimitGlobal"
18
18
 
19
+ # Skip reason emitted when a capturing probe firing is rejected by
20
+ # the per-trace emission counters of the coordinated sampling gate.
21
+ RATE_LIMIT_TRACE_BUDGET = "rateLimitTraceBudget"
22
+
19
23
  # Skip reason emitted when an evaluation exceeds its time budget:
20
24
  # a probe condition, a capture expression (including one skipped at
21
25
  # the expired capture time budget), or a message template.
@@ -42,7 +46,8 @@ module Datadog
42
46
  QUEUE_HIGH_WATERMARK = "queueHighWatermark"
43
47
 
44
48
  # Drop reason emitted when a snapshot exceeds the serialized
45
- # payload limit.
49
+ # payload limit and pruning cannot fit it, and capture-incomplete
50
+ # reason emitted when pruning fits it.
46
51
  PAYLOAD_TOO_LARGE = "payloadTooLarge"
47
52
 
48
53
  # Drop reason naming the batch byte-cap guardrail decision.
@@ -79,8 +84,8 @@ module Datadog
79
84
  OTHER = "other"
80
85
 
81
86
  # The skip reasons the events.skipped metric tags with the firing
82
- # probe's id; every other skip reason names a process-wide
83
- # decision and carries no probe id.
87
+ # probe's id; every other skip reason names a decision shared across
88
+ # probes, process-wide or per-trace, and carries no probe id.
84
89
  PROBE_SCOPED_REASONS = [RATE_LIMIT_PROBE, EVALUATION_TIMEOUT].freeze
85
90
  end
86
91
  end