ddtrace 1.0.0 → 1.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (646) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +453 -2
  3. data/LICENSE-3rdparty.csv +6 -2
  4. data/README.md +10 -5
  5. data/ext/ddtrace_profiling_loader/ddtrace_profiling_loader.c +134 -0
  6. data/ext/ddtrace_profiling_loader/extconf.rb +74 -0
  7. data/ext/ddtrace_profiling_native_extension/NativeExtensionDesign.md +79 -9
  8. data/ext/ddtrace_profiling_native_extension/clock_id.h +22 -1
  9. data/ext/ddtrace_profiling_native_extension/clock_id_from_pthread.c +33 -10
  10. data/ext/ddtrace_profiling_native_extension/clock_id_noop.c +11 -2
  11. data/ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time.c +899 -0
  12. data/ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time.h +9 -0
  13. data/ext/ddtrace_profiling_native_extension/collectors_cpu_and_wall_time_worker.c +776 -0
  14. data/ext/ddtrace_profiling_native_extension/collectors_dynamic_sampling_rate.c +142 -0
  15. data/ext/ddtrace_profiling_native_extension/collectors_dynamic_sampling_rate.h +14 -0
  16. data/ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.c +241 -0
  17. data/ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.h +3 -0
  18. data/ext/ddtrace_profiling_native_extension/collectors_stack.c +390 -0
  19. data/ext/ddtrace_profiling_native_extension/collectors_stack.h +18 -0
  20. data/ext/ddtrace_profiling_native_extension/extconf.rb +156 -114
  21. data/ext/ddtrace_profiling_native_extension/helpers.h +17 -0
  22. data/ext/ddtrace_profiling_native_extension/http_transport.c +354 -0
  23. data/ext/ddtrace_profiling_native_extension/libdatadog_helpers.h +18 -0
  24. data/ext/ddtrace_profiling_native_extension/native_extension_helpers.rb +319 -0
  25. data/ext/ddtrace_profiling_native_extension/private_vm_api_access.c +820 -9
  26. data/ext/ddtrace_profiling_native_extension/private_vm_api_access.h +42 -0
  27. data/ext/ddtrace_profiling_native_extension/profiling.c +230 -3
  28. data/ext/ddtrace_profiling_native_extension/ruby_helpers.c +110 -0
  29. data/ext/ddtrace_profiling_native_extension/ruby_helpers.h +89 -0
  30. data/ext/ddtrace_profiling_native_extension/setup_signal_handler.c +115 -0
  31. data/ext/ddtrace_profiling_native_extension/setup_signal_handler.h +11 -0
  32. data/ext/ddtrace_profiling_native_extension/stack_recorder.c +487 -0
  33. data/ext/ddtrace_profiling_native_extension/stack_recorder.h +39 -0
  34. data/ext/ddtrace_profiling_native_extension/time_helpers.c +17 -0
  35. data/ext/ddtrace_profiling_native_extension/time_helpers.h +10 -0
  36. data/lib/datadog/appsec/assets/blocked.html +98 -3
  37. data/lib/datadog/appsec/assets/blocked.json +1 -0
  38. data/lib/datadog/appsec/assets/blocked.text +5 -0
  39. data/lib/datadog/appsec/assets/waf_rules/recommended.json +1250 -300
  40. data/lib/datadog/appsec/assets/waf_rules/risky.json +78 -78
  41. data/lib/datadog/appsec/assets/waf_rules/strict.json +308 -73
  42. data/lib/datadog/appsec/assets.rb +3 -3
  43. data/lib/datadog/appsec/autoload.rb +6 -4
  44. data/lib/datadog/appsec/configuration/settings.rb +55 -19
  45. data/lib/datadog/appsec/configuration.rb +17 -3
  46. data/lib/datadog/appsec/contrib/auto_instrument.rb +1 -3
  47. data/lib/datadog/appsec/contrib/configuration/settings.rb +2 -2
  48. data/lib/datadog/appsec/contrib/integration.rb +1 -1
  49. data/lib/datadog/appsec/contrib/patcher.rb +1 -1
  50. data/lib/datadog/appsec/contrib/rack/configuration/settings.rb +3 -3
  51. data/lib/datadog/appsec/contrib/rack/ext.rb +1 -1
  52. data/lib/datadog/appsec/contrib/rack/gateway/watcher.rb +95 -47
  53. data/lib/datadog/appsec/contrib/rack/integration.rb +5 -4
  54. data/lib/datadog/appsec/contrib/rack/patcher.rb +2 -3
  55. data/lib/datadog/appsec/contrib/rack/reactive/request.rb +17 -21
  56. data/lib/datadog/appsec/contrib/rack/reactive/request_body.rb +64 -0
  57. data/lib/datadog/appsec/contrib/rack/reactive/response.rb +13 -13
  58. data/lib/datadog/appsec/contrib/rack/request.rb +27 -1
  59. data/lib/datadog/appsec/contrib/rack/request_body_middleware.rb +41 -0
  60. data/lib/datadog/appsec/contrib/rack/request_middleware.rb +92 -10
  61. data/lib/datadog/appsec/contrib/rack/response.rb +1 -1
  62. data/lib/datadog/appsec/contrib/rails/configuration/settings.rb +3 -3
  63. data/lib/datadog/appsec/contrib/rails/ext.rb +1 -1
  64. data/lib/datadog/appsec/contrib/rails/framework.rb +1 -1
  65. data/lib/datadog/appsec/contrib/rails/gateway/watcher.rb +82 -0
  66. data/lib/datadog/appsec/contrib/rails/integration.rb +5 -5
  67. data/lib/datadog/appsec/contrib/rails/patcher.rb +42 -8
  68. data/lib/datadog/appsec/contrib/rails/reactive/action.rb +68 -0
  69. data/lib/datadog/appsec/contrib/rails/request.rb +36 -0
  70. data/lib/datadog/appsec/contrib/rails/request_middleware.rb +1 -1
  71. data/lib/datadog/appsec/contrib/sinatra/configuration/settings.rb +3 -3
  72. data/lib/datadog/appsec/contrib/sinatra/ext.rb +2 -1
  73. data/lib/datadog/appsec/contrib/sinatra/framework.rb +1 -1
  74. data/lib/datadog/appsec/contrib/sinatra/gateway/watcher.rb +126 -0
  75. data/lib/datadog/appsec/contrib/sinatra/integration.rb +4 -4
  76. data/lib/datadog/appsec/contrib/sinatra/patcher.rb +84 -10
  77. data/lib/datadog/appsec/contrib/sinatra/reactive/routed.rb +63 -0
  78. data/lib/datadog/appsec/contrib/sinatra/request_middleware.rb +1 -1
  79. data/lib/datadog/appsec/event.rb +38 -27
  80. data/lib/datadog/appsec/extensions.rb +43 -26
  81. data/lib/datadog/appsec/instrumentation/gateway.rb +17 -3
  82. data/lib/datadog/appsec/processor.rb +86 -13
  83. data/lib/datadog/appsec/rate_limiter.rb +6 -1
  84. data/lib/datadog/appsec/reactive/address_hash.rb +1 -1
  85. data/lib/datadog/appsec/reactive/engine.rb +3 -3
  86. data/lib/datadog/appsec/reactive/operation.rb +5 -6
  87. data/lib/datadog/appsec/reactive/subscriber.rb +1 -1
  88. data/lib/datadog/appsec/response.rb +63 -0
  89. data/lib/datadog/appsec/utils/http/media_range.rb +201 -0
  90. data/lib/datadog/appsec/utils/http/media_type.rb +87 -0
  91. data/lib/datadog/appsec/utils/http.rb +9 -0
  92. data/lib/datadog/appsec/utils.rb +7 -0
  93. data/lib/datadog/appsec.rb +6 -6
  94. data/lib/datadog/ci/configuration/components.rb +1 -1
  95. data/lib/datadog/ci/configuration/settings.rb +1 -1
  96. data/lib/datadog/ci/contrib/cucumber/configuration/settings.rb +2 -2
  97. data/lib/datadog/ci/contrib/cucumber/formatter.rb +5 -5
  98. data/lib/datadog/ci/contrib/cucumber/instrumentation.rb +1 -1
  99. data/lib/datadog/ci/contrib/cucumber/integration.rb +4 -4
  100. data/lib/datadog/ci/contrib/cucumber/patcher.rb +2 -2
  101. data/lib/datadog/ci/contrib/rspec/configuration/settings.rb +2 -2
  102. data/lib/datadog/ci/contrib/rspec/example.rb +5 -5
  103. data/lib/datadog/ci/contrib/rspec/integration.rb +4 -4
  104. data/lib/datadog/ci/contrib/rspec/patcher.rb +2 -2
  105. data/lib/datadog/ci/ext/environment.rb +99 -27
  106. data/lib/datadog/ci/extensions.rb +4 -4
  107. data/lib/datadog/ci/flush.rb +2 -2
  108. data/lib/datadog/ci/test.rb +3 -3
  109. data/lib/datadog/ci.rb +6 -6
  110. data/lib/datadog/core/buffer/cruby.rb +1 -1
  111. data/lib/datadog/core/buffer/thread_safe.rb +1 -1
  112. data/lib/datadog/core/configuration/agent_settings_resolver.rb +9 -12
  113. data/lib/datadog/core/configuration/base.rb +14 -2
  114. data/lib/datadog/core/configuration/components.rb +123 -54
  115. data/lib/datadog/core/configuration/ext.rb +26 -0
  116. data/lib/datadog/core/configuration/option_definition.rb +12 -3
  117. data/lib/datadog/core/configuration/option_definition_set.rb +1 -1
  118. data/lib/datadog/core/configuration/options.rb +3 -3
  119. data/lib/datadog/core/configuration/settings.rb +79 -251
  120. data/lib/datadog/core/configuration.rb +16 -11
  121. data/lib/datadog/core/diagnostics/environment_logger.rb +10 -5
  122. data/lib/datadog/core/diagnostics/health.rb +5 -23
  123. data/lib/datadog/core/environment/cgroup.rb +4 -2
  124. data/lib/datadog/core/environment/container.rb +3 -2
  125. data/lib/datadog/core/environment/ext.rb +1 -1
  126. data/lib/datadog/core/environment/identity.rb +2 -2
  127. data/lib/datadog/core/environment/platform.rb +40 -0
  128. data/lib/datadog/core/environment/socket.rb +1 -1
  129. data/lib/datadog/core/environment/variable_helpers.rb +83 -11
  130. data/lib/datadog/core/error.rb +1 -1
  131. data/lib/datadog/core/extensions.rb +1 -1
  132. data/lib/datadog/core/header_collection.rb +41 -0
  133. data/lib/datadog/core/logging/ext.rb +11 -0
  134. data/lib/datadog/core/metrics/client.rb +25 -14
  135. data/lib/datadog/core/metrics/ext.rb +0 -2
  136. data/lib/datadog/core/metrics/options.rb +3 -3
  137. data/lib/datadog/core/runtime/ext.rb +1 -1
  138. data/lib/datadog/core/runtime/metrics.rb +7 -7
  139. data/lib/datadog/core/telemetry/client.rb +79 -0
  140. data/lib/datadog/core/telemetry/collector.rb +233 -0
  141. data/lib/datadog/core/telemetry/emitter.rb +48 -0
  142. data/lib/datadog/core/telemetry/event.rb +71 -0
  143. data/lib/datadog/core/telemetry/ext.rb +11 -0
  144. data/lib/datadog/core/telemetry/heartbeat.rb +37 -0
  145. data/lib/datadog/core/telemetry/http/adapters/net.rb +113 -0
  146. data/lib/datadog/core/telemetry/http/env.rb +20 -0
  147. data/lib/datadog/core/telemetry/http/ext.rb +20 -0
  148. data/lib/datadog/core/telemetry/http/response.rb +68 -0
  149. data/lib/datadog/core/telemetry/http/transport.rb +53 -0
  150. data/lib/datadog/core/telemetry/v1/app_event.rb +52 -0
  151. data/lib/datadog/core/telemetry/v1/application.rb +86 -0
  152. data/lib/datadog/core/telemetry/v1/configuration.rb +25 -0
  153. data/lib/datadog/core/telemetry/v1/dependency.rb +36 -0
  154. data/lib/datadog/core/telemetry/v1/host.rb +51 -0
  155. data/lib/datadog/core/telemetry/v1/integration.rb +58 -0
  156. data/lib/datadog/core/telemetry/v1/product.rb +28 -0
  157. data/lib/datadog/core/telemetry/v1/telemetry_request.rb +100 -0
  158. data/lib/datadog/core/utils/compression.rb +5 -1
  159. data/lib/datadog/core/utils/object_set.rb +1 -1
  160. data/lib/datadog/core/utils/sequence.rb +5 -0
  161. data/lib/datadog/core/utils/string_table.rb +1 -1
  162. data/lib/datadog/core/utils/time.rb +3 -3
  163. data/lib/datadog/core/utils.rb +1 -22
  164. data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb +2 -2
  165. data/lib/datadog/core/vendor/multipart-post/net/http/post/multipart.rb +3 -3
  166. data/lib/datadog/core/workers/async.rb +4 -4
  167. data/lib/datadog/core/workers/polling.rb +2 -2
  168. data/lib/datadog/core/workers/runtime_metrics.rb +4 -7
  169. data/lib/datadog/core.rb +28 -56
  170. data/lib/datadog/kit/appsec/events.rb +75 -0
  171. data/lib/datadog/kit/enable_core_dumps.rb +51 -0
  172. data/lib/datadog/kit/identity.rb +64 -0
  173. data/lib/datadog/kit.rb +11 -0
  174. data/lib/datadog/opentelemetry/api/context.rb +187 -0
  175. data/lib/datadog/opentelemetry/api/trace/span.rb +15 -0
  176. data/lib/datadog/opentelemetry/sdk/configurator.rb +38 -0
  177. data/lib/datadog/opentelemetry/sdk/id_generator.rb +27 -0
  178. data/lib/datadog/opentelemetry/sdk/propagator.rb +91 -0
  179. data/lib/datadog/opentelemetry/sdk/span_processor.rb +92 -0
  180. data/lib/datadog/opentelemetry.rb +48 -0
  181. data/lib/datadog/opentracer/distributed_headers.rb +7 -9
  182. data/lib/datadog/opentracer/rack_propagator.rb +10 -9
  183. data/lib/datadog/opentracer/span.rb +1 -1
  184. data/lib/datadog/opentracer/text_map_propagator.rb +13 -12
  185. data/lib/datadog/opentracer/thread_local_scope_manager.rb +26 -3
  186. data/lib/datadog/opentracer/tracer.rb +23 -23
  187. data/lib/datadog/opentracer.rb +16 -16
  188. data/lib/datadog/profiling/buffer.rb +3 -3
  189. data/lib/datadog/profiling/collectors/code_provenance.rb +1 -0
  190. data/lib/datadog/profiling/collectors/cpu_and_wall_time.rb +43 -0
  191. data/lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb +91 -0
  192. data/lib/datadog/profiling/collectors/dynamic_sampling_rate.rb +14 -0
  193. data/lib/datadog/profiling/collectors/idle_sampling_helper.rb +68 -0
  194. data/lib/datadog/profiling/collectors/old_stack.rb +305 -0
  195. data/lib/datadog/profiling/collectors/stack.rb +4 -288
  196. data/lib/datadog/profiling/encoding/profile.rb +8 -13
  197. data/lib/datadog/profiling/events/stack.rb +1 -1
  198. data/lib/datadog/profiling/exporter.rb +69 -9
  199. data/lib/datadog/profiling/ext/forking.rb +41 -42
  200. data/lib/datadog/profiling/ext.rb +4 -16
  201. data/lib/datadog/profiling/flush.rb +25 -56
  202. data/lib/datadog/profiling/http_transport.rb +132 -0
  203. data/lib/datadog/profiling/load_native_extension.rb +22 -0
  204. data/lib/datadog/profiling/old_recorder.rb +109 -0
  205. data/lib/datadog/profiling/pprof/builder.rb +4 -4
  206. data/lib/datadog/profiling/pprof/converter.rb +1 -1
  207. data/lib/datadog/profiling/pprof/message_set.rb +1 -1
  208. data/lib/datadog/profiling/pprof/stack_sample.rb +4 -4
  209. data/lib/datadog/profiling/pprof/string_table.rb +1 -1
  210. data/lib/datadog/profiling/pprof/template.rb +5 -5
  211. data/lib/datadog/profiling/preload.rb +1 -1
  212. data/lib/datadog/profiling/profiler.rb +7 -0
  213. data/lib/datadog/profiling/scheduler.rb +29 -50
  214. data/lib/datadog/profiling/stack_recorder.rb +79 -0
  215. data/lib/datadog/profiling/tag_builder.rb +53 -0
  216. data/lib/datadog/profiling/tasks/exec.rb +2 -2
  217. data/lib/datadog/profiling/tasks/setup.rb +8 -13
  218. data/lib/datadog/profiling/trace_identifiers/ddtrace.rb +2 -2
  219. data/lib/datadog/profiling/trace_identifiers/helper.rb +1 -1
  220. data/lib/datadog/profiling.rb +49 -44
  221. data/lib/datadog/tracing/analytics.rb +1 -1
  222. data/lib/datadog/tracing/buffer.rb +14 -8
  223. data/lib/datadog/tracing/client_ip.rb +164 -0
  224. data/lib/datadog/tracing/configuration/ext.rb +47 -4
  225. data/lib/datadog/tracing/configuration/settings.rb +433 -0
  226. data/lib/datadog/tracing/context.rb +1 -1
  227. data/lib/datadog/tracing/context_provider.rb +18 -2
  228. data/lib/datadog/tracing/contrib/action_cable/configuration/settings.rb +2 -2
  229. data/lib/datadog/tracing/contrib/action_cable/event.rb +4 -5
  230. data/lib/datadog/tracing/contrib/action_cable/events/broadcast.rb +4 -4
  231. data/lib/datadog/tracing/contrib/action_cable/events/perform_action.rb +3 -3
  232. data/lib/datadog/tracing/contrib/action_cable/events/transmit.rb +4 -4
  233. data/lib/datadog/tracing/contrib/action_cable/events.rb +4 -4
  234. data/lib/datadog/tracing/contrib/action_cable/instrumentation.rb +3 -4
  235. data/lib/datadog/tracing/contrib/action_cable/integration.rb +4 -4
  236. data/lib/datadog/tracing/contrib/action_cable/patcher.rb +4 -4
  237. data/lib/datadog/tracing/contrib/action_mailer/configuration/settings.rb +2 -2
  238. data/lib/datadog/tracing/contrib/action_mailer/event.rb +3 -3
  239. data/lib/datadog/tracing/contrib/action_mailer/events/deliver.rb +3 -3
  240. data/lib/datadog/tracing/contrib/action_mailer/events/process.rb +3 -3
  241. data/lib/datadog/tracing/contrib/action_mailer/events.rb +2 -2
  242. data/lib/datadog/tracing/contrib/action_mailer/integration.rb +4 -4
  243. data/lib/datadog/tracing/contrib/action_mailer/patcher.rb +3 -3
  244. data/lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb +10 -6
  245. data/lib/datadog/tracing/contrib/action_pack/action_controller/patcher.rb +2 -2
  246. data/lib/datadog/tracing/contrib/action_pack/configuration/settings.rb +2 -2
  247. data/lib/datadog/tracing/contrib/action_pack/integration.rb +4 -4
  248. data/lib/datadog/tracing/contrib/action_pack/patcher.rb +2 -2
  249. data/lib/datadog/tracing/contrib/action_pack/utils.rb +1 -1
  250. data/lib/datadog/tracing/contrib/action_view/configuration/settings.rb +2 -2
  251. data/lib/datadog/tracing/contrib/action_view/event.rb +1 -1
  252. data/lib/datadog/tracing/contrib/action_view/events/render_partial.rb +5 -5
  253. data/lib/datadog/tracing/contrib/action_view/events/render_template.rb +5 -5
  254. data/lib/datadog/tracing/contrib/action_view/events.rb +2 -2
  255. data/lib/datadog/tracing/contrib/action_view/instrumentation/partial_renderer.rb +2 -2
  256. data/lib/datadog/tracing/contrib/action_view/instrumentation/template_renderer.rb +2 -2
  257. data/lib/datadog/tracing/contrib/action_view/integration.rb +4 -4
  258. data/lib/datadog/tracing/contrib/action_view/patcher.rb +7 -8
  259. data/lib/datadog/tracing/contrib/action_view/utils.rb +1 -1
  260. data/lib/datadog/tracing/contrib/active_job/configuration/settings.rb +3 -3
  261. data/lib/datadog/tracing/contrib/active_job/event.rb +3 -3
  262. data/lib/datadog/tracing/contrib/active_job/events/discard.rb +4 -4
  263. data/lib/datadog/tracing/contrib/active_job/events/enqueue.rb +4 -4
  264. data/lib/datadog/tracing/contrib/active_job/events/enqueue_at.rb +4 -4
  265. data/lib/datadog/tracing/contrib/active_job/events/enqueue_retry.rb +4 -4
  266. data/lib/datadog/tracing/contrib/active_job/events/perform.rb +4 -4
  267. data/lib/datadog/tracing/contrib/active_job/events/retry_stopped.rb +4 -4
  268. data/lib/datadog/tracing/contrib/active_job/events.rb +6 -6
  269. data/lib/datadog/tracing/contrib/active_job/integration.rb +4 -4
  270. data/lib/datadog/tracing/contrib/active_job/log_injection.rb +0 -2
  271. data/lib/datadog/tracing/contrib/active_job/patcher.rb +4 -4
  272. data/lib/datadog/tracing/contrib/active_model_serializers/configuration/settings.rb +2 -2
  273. data/lib/datadog/tracing/contrib/active_model_serializers/event.rb +4 -5
  274. data/lib/datadog/tracing/contrib/active_model_serializers/events/render.rb +3 -3
  275. data/lib/datadog/tracing/contrib/active_model_serializers/events/serialize.rb +2 -2
  276. data/lib/datadog/tracing/contrib/active_model_serializers/events.rb +2 -2
  277. data/lib/datadog/tracing/contrib/active_model_serializers/integration.rb +3 -3
  278. data/lib/datadog/tracing/contrib/active_model_serializers/patcher.rb +3 -4
  279. data/lib/datadog/tracing/contrib/active_record/configuration/resolver.rb +4 -4
  280. data/lib/datadog/tracing/contrib/active_record/configuration/settings.rb +3 -3
  281. data/lib/datadog/tracing/contrib/active_record/event.rb +1 -1
  282. data/lib/datadog/tracing/contrib/active_record/events/instantiation.rb +4 -4
  283. data/lib/datadog/tracing/contrib/active_record/events/sql.rb +6 -6
  284. data/lib/datadog/tracing/contrib/active_record/events.rb +2 -2
  285. data/lib/datadog/tracing/contrib/active_record/integration.rb +6 -6
  286. data/lib/datadog/tracing/contrib/active_record/patcher.rb +2 -2
  287. data/lib/datadog/tracing/contrib/active_record/utils.rb +3 -3
  288. data/lib/datadog/tracing/contrib/active_record/vendor/connection_specification.rb +1 -1
  289. data/lib/datadog/tracing/contrib/active_support/cache/instrumentation.rb +19 -9
  290. data/lib/datadog/tracing/contrib/active_support/cache/patcher.rb +2 -2
  291. data/lib/datadog/tracing/contrib/active_support/cache/redis.rb +1 -1
  292. data/lib/datadog/tracing/contrib/active_support/configuration/settings.rb +2 -2
  293. data/lib/datadog/tracing/contrib/active_support/integration.rb +5 -5
  294. data/lib/datadog/tracing/contrib/active_support/notifications/event.rb +1 -1
  295. data/lib/datadog/tracing/contrib/active_support/notifications/subscriber.rb +1 -1
  296. data/lib/datadog/tracing/contrib/active_support/notifications/subscription.rb +4 -2
  297. data/lib/datadog/tracing/contrib/active_support/patcher.rb +2 -2
  298. data/lib/datadog/tracing/contrib/analytics.rb +1 -1
  299. data/lib/datadog/tracing/contrib/auto_instrument.rb +4 -4
  300. data/lib/datadog/tracing/contrib/aws/configuration/settings.rb +6 -3
  301. data/lib/datadog/tracing/contrib/aws/ext.rb +1 -0
  302. data/lib/datadog/tracing/contrib/aws/instrumentation.rb +5 -4
  303. data/lib/datadog/tracing/contrib/aws/integration.rb +3 -3
  304. data/lib/datadog/tracing/contrib/aws/patcher.rb +5 -5
  305. data/lib/datadog/tracing/contrib/aws/services.rb +0 -2
  306. data/lib/datadog/tracing/contrib/concurrent_ruby/configuration/settings.rb +2 -2
  307. data/lib/datadog/tracing/contrib/concurrent_ruby/context_composite_executor_service.rb +10 -3
  308. data/lib/datadog/tracing/contrib/concurrent_ruby/future_patch.rb +1 -1
  309. data/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb +3 -3
  310. data/lib/datadog/tracing/contrib/concurrent_ruby/patcher.rb +2 -2
  311. data/lib/datadog/tracing/contrib/configurable.rb +2 -2
  312. data/lib/datadog/tracing/contrib/configuration/resolvers/pattern_resolver.rb +1 -1
  313. data/lib/datadog/tracing/contrib/configuration/settings.rb +2 -2
  314. data/lib/datadog/tracing/contrib/dalli/configuration/settings.rb +6 -3
  315. data/lib/datadog/tracing/contrib/dalli/ext.rb +2 -0
  316. data/lib/datadog/tracing/contrib/dalli/instrumentation.rb +8 -5
  317. data/lib/datadog/tracing/contrib/dalli/integration.rb +3 -3
  318. data/lib/datadog/tracing/contrib/dalli/patcher.rb +3 -4
  319. data/lib/datadog/tracing/contrib/dalli/quantize.rb +1 -1
  320. data/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb +3 -3
  321. data/lib/datadog/tracing/contrib/delayed_job/ext.rb +2 -0
  322. data/lib/datadog/tracing/contrib/delayed_job/integration.rb +3 -3
  323. data/lib/datadog/tracing/contrib/delayed_job/patcher.rb +8 -3
  324. data/lib/datadog/tracing/contrib/delayed_job/plugin.rb +7 -4
  325. data/lib/datadog/tracing/contrib/delayed_job/server_internal_tracer/worker.rb +32 -0
  326. data/lib/datadog/tracing/contrib/elasticsearch/configuration/settings.rb +7 -3
  327. data/lib/datadog/tracing/contrib/elasticsearch/ext.rb +3 -0
  328. data/lib/datadog/tracing/contrib/elasticsearch/integration.rb +12 -6
  329. data/lib/datadog/tracing/contrib/elasticsearch/patcher.rb +47 -9
  330. data/lib/datadog/tracing/contrib/elasticsearch/quantize.rb +1 -1
  331. data/lib/datadog/tracing/contrib/ethon/configuration/settings.rb +8 -3
  332. data/lib/datadog/tracing/contrib/ethon/easy_patch.rb +6 -7
  333. data/lib/datadog/tracing/contrib/ethon/ext.rb +1 -0
  334. data/lib/datadog/tracing/contrib/ethon/integration.rb +4 -4
  335. data/lib/datadog/tracing/contrib/ethon/multi_patch.rb +5 -4
  336. data/lib/datadog/tracing/contrib/ethon/patcher.rb +3 -4
  337. data/lib/datadog/tracing/contrib/excon/configuration/settings.rb +7 -3
  338. data/lib/datadog/tracing/contrib/excon/ext.rb +1 -0
  339. data/lib/datadog/tracing/contrib/excon/integration.rb +4 -4
  340. data/lib/datadog/tracing/contrib/excon/middleware.rb +8 -7
  341. data/lib/datadog/tracing/contrib/excon/patcher.rb +2 -2
  342. data/lib/datadog/tracing/contrib/ext.rb +25 -0
  343. data/lib/datadog/tracing/contrib/extensions.rb +5 -5
  344. data/lib/datadog/tracing/contrib/faraday/configuration/settings.rb +7 -3
  345. data/lib/datadog/tracing/contrib/faraday/ext.rb +1 -0
  346. data/lib/datadog/tracing/contrib/faraday/integration.rb +4 -4
  347. data/lib/datadog/tracing/contrib/faraday/middleware.rb +8 -8
  348. data/lib/datadog/tracing/contrib/faraday/patcher.rb +5 -6
  349. data/lib/datadog/tracing/contrib/grape/configuration/settings.rb +3 -3
  350. data/lib/datadog/tracing/contrib/grape/endpoint.rb +4 -7
  351. data/lib/datadog/tracing/contrib/grape/integration.rb +3 -3
  352. data/lib/datadog/tracing/contrib/grape/patcher.rb +4 -5
  353. data/lib/datadog/tracing/contrib/graphql/configuration/settings.rb +3 -3
  354. data/lib/datadog/tracing/contrib/graphql/integration.rb +3 -3
  355. data/lib/datadog/tracing/contrib/graphql/patcher.rb +2 -4
  356. data/lib/datadog/tracing/contrib/grpc/configuration/settings.rb +10 -4
  357. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/client.rb +20 -5
  358. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/server.rb +17 -17
  359. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor.rb +7 -4
  360. data/lib/datadog/tracing/contrib/grpc/distributed/fetcher.rb +27 -0
  361. data/lib/datadog/tracing/contrib/grpc/distributed/propagation.rb +43 -0
  362. data/lib/datadog/tracing/contrib/grpc/ext.rb +4 -0
  363. data/lib/datadog/tracing/contrib/grpc/integration.rb +3 -3
  364. data/lib/datadog/tracing/contrib/grpc/patcher.rb +3 -6
  365. data/lib/datadog/tracing/contrib/hanami/action_tracer.rb +47 -0
  366. data/lib/datadog/tracing/contrib/hanami/configuration/settings.rb +22 -0
  367. data/lib/datadog/tracing/contrib/hanami/ext.rb +24 -0
  368. data/lib/datadog/tracing/contrib/hanami/integration.rb +44 -0
  369. data/lib/datadog/tracing/contrib/hanami/patcher.rb +33 -0
  370. data/lib/datadog/tracing/contrib/hanami/plugin.rb +23 -0
  371. data/lib/datadog/tracing/contrib/hanami/renderer_policy_tracing.rb +41 -0
  372. data/lib/datadog/tracing/contrib/hanami/router_tracing.rb +44 -0
  373. data/lib/datadog/tracing/contrib/http/circuit_breaker.rb +1 -2
  374. data/lib/datadog/tracing/contrib/http/configuration/settings.rb +13 -3
  375. data/lib/datadog/tracing/contrib/http/distributed/fetcher.rb +39 -0
  376. data/lib/datadog/tracing/contrib/http/distributed/propagation.rb +38 -0
  377. data/lib/datadog/tracing/contrib/http/ext.rb +2 -0
  378. data/lib/datadog/tracing/contrib/http/instrumentation.rb +8 -10
  379. data/lib/datadog/tracing/contrib/http/integration.rb +6 -6
  380. data/lib/datadog/tracing/contrib/http/patcher.rb +3 -3
  381. data/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb +13 -3
  382. data/lib/datadog/tracing/contrib/httpclient/ext.rb +2 -0
  383. data/lib/datadog/tracing/contrib/httpclient/instrumentation.rb +9 -9
  384. data/lib/datadog/tracing/contrib/httpclient/integration.rb +4 -4
  385. data/lib/datadog/tracing/contrib/httpclient/patcher.rb +3 -3
  386. data/lib/datadog/tracing/contrib/httprb/configuration/settings.rb +13 -3
  387. data/lib/datadog/tracing/contrib/httprb/ext.rb +2 -0
  388. data/lib/datadog/tracing/contrib/httprb/instrumentation.rb +9 -9
  389. data/lib/datadog/tracing/contrib/httprb/integration.rb +4 -4
  390. data/lib/datadog/tracing/contrib/httprb/patcher.rb +3 -3
  391. data/lib/datadog/tracing/contrib/integration.rb +3 -3
  392. data/lib/datadog/tracing/contrib/kafka/configuration/settings.rb +2 -2
  393. data/lib/datadog/tracing/contrib/kafka/consumer_event.rb +1 -0
  394. data/lib/datadog/tracing/contrib/kafka/event.rb +3 -3
  395. data/lib/datadog/tracing/contrib/kafka/events/connection/request.rb +2 -2
  396. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_batch.rb +3 -3
  397. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_message.rb +3 -3
  398. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/heartbeat.rb +4 -4
  399. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/join_group.rb +4 -4
  400. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/leave_group.rb +4 -4
  401. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/sync_group.rb +4 -4
  402. data/lib/datadog/tracing/contrib/kafka/events/produce_operation/send_messages.rb +3 -2
  403. data/lib/datadog/tracing/contrib/kafka/events/producer/deliver_messages.rb +3 -2
  404. data/lib/datadog/tracing/contrib/kafka/events.rb +9 -9
  405. data/lib/datadog/tracing/contrib/kafka/integration.rb +3 -3
  406. data/lib/datadog/tracing/contrib/kafka/patcher.rb +3 -4
  407. data/lib/datadog/tracing/contrib/lograge/configuration/settings.rb +2 -2
  408. data/lib/datadog/tracing/contrib/lograge/instrumentation.rb +2 -2
  409. data/lib/datadog/tracing/contrib/lograge/integration.rb +3 -3
  410. data/lib/datadog/tracing/contrib/lograge/patcher.rb +2 -2
  411. data/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb +7 -3
  412. data/lib/datadog/tracing/contrib/mongodb/ext.rb +8 -0
  413. data/lib/datadog/tracing/contrib/mongodb/instrumentation.rb +3 -3
  414. data/lib/datadog/tracing/contrib/mongodb/integration.rb +4 -4
  415. data/lib/datadog/tracing/contrib/mongodb/parsers.rb +1 -1
  416. data/lib/datadog/tracing/contrib/mongodb/patcher.rb +3 -3
  417. data/lib/datadog/tracing/contrib/mongodb/subscribers.rb +10 -4
  418. data/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb +18 -3
  419. data/lib/datadog/tracing/contrib/mysql2/ext.rb +2 -0
  420. data/lib/datadog/tracing/contrib/mysql2/instrumentation.rb +20 -5
  421. data/lib/datadog/tracing/contrib/mysql2/integration.rb +3 -3
  422. data/lib/datadog/tracing/contrib/mysql2/patcher.rb +2 -2
  423. data/lib/datadog/tracing/contrib/patcher.rb +16 -4
  424. data/lib/datadog/tracing/contrib/pg/configuration/settings.rb +50 -0
  425. data/lib/datadog/tracing/contrib/pg/ext.rb +33 -0
  426. data/lib/datadog/tracing/contrib/pg/instrumentation.rb +168 -0
  427. data/lib/datadog/tracing/contrib/pg/integration.rb +43 -0
  428. data/lib/datadog/tracing/contrib/pg/patcher.rb +31 -0
  429. data/lib/datadog/tracing/contrib/presto/configuration/settings.rb +6 -3
  430. data/lib/datadog/tracing/contrib/presto/ext.rb +1 -0
  431. data/lib/datadog/tracing/contrib/presto/instrumentation.rb +2 -3
  432. data/lib/datadog/tracing/contrib/presto/integration.rb +3 -3
  433. data/lib/datadog/tracing/contrib/presto/patcher.rb +4 -4
  434. data/lib/datadog/tracing/contrib/propagation/sql_comment/comment.rb +43 -0
  435. data/lib/datadog/tracing/contrib/propagation/sql_comment/ext.rb +33 -0
  436. data/lib/datadog/tracing/contrib/propagation/sql_comment/mode.rb +28 -0
  437. data/lib/datadog/tracing/contrib/propagation/sql_comment.rb +47 -0
  438. data/lib/datadog/tracing/contrib/qless/configuration/settings.rb +2 -2
  439. data/lib/datadog/tracing/contrib/qless/integration.rb +3 -3
  440. data/lib/datadog/tracing/contrib/qless/patcher.rb +1 -3
  441. data/lib/datadog/tracing/contrib/qless/qless_job.rb +2 -3
  442. data/lib/datadog/tracing/contrib/qless/tracer_cleaner.rb +0 -2
  443. data/lib/datadog/tracing/contrib/que/configuration/settings.rb +3 -3
  444. data/lib/datadog/tracing/contrib/que/integration.rb +4 -4
  445. data/lib/datadog/tracing/contrib/que/patcher.rb +1 -2
  446. data/lib/datadog/tracing/contrib/que/tracer.rb +3 -1
  447. data/lib/datadog/tracing/contrib/racecar/configuration/settings.rb +2 -2
  448. data/lib/datadog/tracing/contrib/racecar/event.rb +4 -5
  449. data/lib/datadog/tracing/contrib/racecar/events/batch.rb +6 -3
  450. data/lib/datadog/tracing/contrib/racecar/events/consume.rb +2 -2
  451. data/lib/datadog/tracing/contrib/racecar/events/message.rb +6 -3
  452. data/lib/datadog/tracing/contrib/racecar/events.rb +3 -3
  453. data/lib/datadog/tracing/contrib/racecar/integration.rb +3 -3
  454. data/lib/datadog/tracing/contrib/racecar/patcher.rb +3 -4
  455. data/lib/datadog/tracing/contrib/rack/configuration/settings.rb +2 -2
  456. data/lib/datadog/tracing/contrib/rack/header_collection.rb +35 -0
  457. data/lib/datadog/tracing/contrib/rack/integration.rb +4 -4
  458. data/lib/datadog/tracing/contrib/rack/middlewares.rb +129 -61
  459. data/lib/datadog/tracing/contrib/rack/patcher.rb +12 -2
  460. data/lib/datadog/tracing/contrib/rails/auto_instrument_railtie.rb +1 -1
  461. data/lib/datadog/tracing/contrib/rails/configuration/settings.rb +4 -1
  462. data/lib/datadog/tracing/contrib/rails/framework.rb +18 -22
  463. data/lib/datadog/tracing/contrib/rails/integration.rb +4 -4
  464. data/lib/datadog/tracing/contrib/rails/log_injection.rb +3 -18
  465. data/lib/datadog/tracing/contrib/rails/middlewares.rb +1 -2
  466. data/lib/datadog/tracing/contrib/rails/patcher.rb +7 -8
  467. data/lib/datadog/tracing/contrib/rails/railtie.rb +3 -3
  468. data/lib/datadog/tracing/contrib/rails/utils.rb +1 -1
  469. data/lib/datadog/tracing/contrib/rake/configuration/settings.rb +17 -2
  470. data/lib/datadog/tracing/contrib/rake/instrumentation.rb +14 -9
  471. data/lib/datadog/tracing/contrib/rake/integration.rb +3 -3
  472. data/lib/datadog/tracing/contrib/rake/patcher.rb +3 -5
  473. data/lib/datadog/tracing/contrib/redis/configuration/resolver.rb +1 -1
  474. data/lib/datadog/tracing/contrib/redis/configuration/settings.rb +6 -3
  475. data/lib/datadog/tracing/contrib/redis/ext.rb +3 -0
  476. data/lib/datadog/tracing/contrib/redis/instrumentation.rb +36 -26
  477. data/lib/datadog/tracing/contrib/redis/integration.rb +37 -4
  478. data/lib/datadog/tracing/contrib/redis/patcher.rb +57 -14
  479. data/lib/datadog/tracing/contrib/redis/quantize.rb +12 -9
  480. data/lib/datadog/tracing/contrib/redis/tags.rb +12 -10
  481. data/lib/datadog/tracing/contrib/redis/trace_middleware.rb +72 -0
  482. data/lib/datadog/tracing/contrib/resque/configuration/settings.rb +3 -3
  483. data/lib/datadog/tracing/contrib/resque/integration.rb +3 -3
  484. data/lib/datadog/tracing/contrib/resque/patcher.rb +2 -3
  485. data/lib/datadog/tracing/contrib/resque/resque_job.rb +5 -4
  486. data/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb +9 -3
  487. data/lib/datadog/tracing/contrib/rest_client/ext.rb +1 -0
  488. data/lib/datadog/tracing/contrib/rest_client/integration.rb +3 -3
  489. data/lib/datadog/tracing/contrib/rest_client/patcher.rb +2 -3
  490. data/lib/datadog/tracing/contrib/rest_client/request_patch.rb +7 -6
  491. data/lib/datadog/tracing/contrib/semantic_logger/configuration/settings.rb +2 -2
  492. data/lib/datadog/tracing/contrib/semantic_logger/instrumentation.rb +2 -2
  493. data/lib/datadog/tracing/contrib/semantic_logger/integration.rb +3 -3
  494. data/lib/datadog/tracing/contrib/semantic_logger/patcher.rb +2 -2
  495. data/lib/datadog/tracing/contrib/sequel/configuration/settings.rb +2 -2
  496. data/lib/datadog/tracing/contrib/sequel/database.rb +4 -5
  497. data/lib/datadog/tracing/contrib/sequel/dataset.rb +4 -5
  498. data/lib/datadog/tracing/contrib/sequel/integration.rb +3 -3
  499. data/lib/datadog/tracing/contrib/sequel/patcher.rb +3 -3
  500. data/lib/datadog/tracing/contrib/sequel/utils.rb +2 -2
  501. data/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb +3 -3
  502. data/lib/datadog/tracing/contrib/shoryuken/integration.rb +4 -4
  503. data/lib/datadog/tracing/contrib/shoryuken/patcher.rb +1 -1
  504. data/lib/datadog/tracing/contrib/shoryuken/tracer.rb +3 -1
  505. data/lib/datadog/tracing/contrib/sidekiq/client_tracer.rb +9 -5
  506. data/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb +4 -3
  507. data/lib/datadog/tracing/contrib/sidekiq/ext.rb +6 -0
  508. data/lib/datadog/tracing/contrib/sidekiq/integration.rb +3 -3
  509. data/lib/datadog/tracing/contrib/sidekiq/patcher.rb +14 -7
  510. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/heartbeat.rb +19 -1
  511. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/{scheduled_push.rb → redis_info.rb} +5 -6
  512. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/scheduled_poller.rb +53 -0
  513. data/lib/datadog/tracing/contrib/sidekiq/server_tracer.rb +29 -6
  514. data/lib/datadog/tracing/contrib/sidekiq/tracing.rb +2 -2
  515. data/lib/datadog/tracing/contrib/sinatra/configuration/settings.rb +2 -2
  516. data/lib/datadog/tracing/contrib/sinatra/env.rb +14 -25
  517. data/lib/datadog/tracing/contrib/sinatra/ext.rb +7 -3
  518. data/lib/datadog/tracing/contrib/sinatra/framework.rb +11 -2
  519. data/lib/datadog/tracing/contrib/sinatra/headers.rb +1 -1
  520. data/lib/datadog/tracing/contrib/sinatra/integration.rb +3 -3
  521. data/lib/datadog/tracing/contrib/sinatra/patcher.rb +7 -8
  522. data/lib/datadog/tracing/contrib/sinatra/tracer.rb +15 -88
  523. data/lib/datadog/tracing/contrib/sinatra/tracer_middleware.rb +20 -16
  524. data/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb +2 -2
  525. data/lib/datadog/tracing/contrib/sneakers/integration.rb +4 -4
  526. data/lib/datadog/tracing/contrib/sneakers/patcher.rb +2 -3
  527. data/lib/datadog/tracing/contrib/sneakers/tracer.rb +4 -3
  528. data/lib/datadog/tracing/contrib/status_code_matcher.rb +2 -2
  529. data/lib/datadog/tracing/contrib/stripe/configuration/settings.rb +33 -0
  530. data/lib/datadog/tracing/contrib/stripe/ext.rb +26 -0
  531. data/lib/datadog/tracing/contrib/stripe/integration.rb +43 -0
  532. data/lib/datadog/tracing/contrib/stripe/patcher.rb +29 -0
  533. data/lib/datadog/tracing/contrib/stripe/request.rb +67 -0
  534. data/lib/datadog/tracing/contrib/sucker_punch/configuration/settings.rb +2 -2
  535. data/lib/datadog/tracing/contrib/sucker_punch/instrumentation.rb +3 -4
  536. data/lib/datadog/tracing/contrib/sucker_punch/integration.rb +3 -3
  537. data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb +4 -6
  538. data/lib/datadog/tracing/contrib/utils/quantization/http.rb +92 -10
  539. data/lib/datadog/tracing/contrib.rb +50 -47
  540. data/lib/datadog/tracing/correlation.rb +1 -1
  541. data/lib/datadog/{core → tracing}/diagnostics/ext.rb +1 -6
  542. data/lib/datadog/tracing/diagnostics/health.rb +40 -0
  543. data/lib/datadog/tracing/distributed/b3_multi.rb +66 -0
  544. data/lib/datadog/tracing/distributed/b3_single.rb +66 -0
  545. data/lib/datadog/tracing/distributed/datadog.rb +153 -0
  546. data/lib/datadog/tracing/distributed/datadog_tags_codec.rb +85 -0
  547. data/lib/datadog/tracing/distributed/fetcher.rb +30 -0
  548. data/lib/datadog/tracing/distributed/headers/ext.rb +19 -15
  549. data/lib/datadog/tracing/distributed/helpers.rb +40 -4
  550. data/lib/datadog/tracing/distributed/none.rb +19 -0
  551. data/lib/datadog/tracing/distributed/propagation.rb +127 -0
  552. data/lib/datadog/tracing/distributed/trace_context.rb +378 -0
  553. data/lib/datadog/tracing/event.rb +3 -2
  554. data/lib/datadog/tracing/flush.rb +57 -35
  555. data/lib/datadog/tracing/metadata/analytics.rb +2 -2
  556. data/lib/datadog/tracing/metadata/errors.rb +2 -2
  557. data/lib/datadog/tracing/metadata/ext.rb +28 -1
  558. data/lib/datadog/tracing/metadata/tagging.rb +23 -2
  559. data/lib/datadog/tracing/metadata.rb +3 -3
  560. data/lib/datadog/tracing/pipeline/span_filter.rb +10 -6
  561. data/lib/datadog/tracing/pipeline.rb +3 -3
  562. data/lib/datadog/tracing/propagation/http.rb +3 -98
  563. data/lib/datadog/tracing/runtime/metrics.rb +1 -1
  564. data/lib/datadog/tracing/sampling/all_sampler.rb +1 -1
  565. data/lib/datadog/tracing/sampling/ext.rb +31 -0
  566. data/lib/datadog/tracing/sampling/priority_sampler.rb +64 -12
  567. data/lib/datadog/tracing/sampling/rate_by_key_sampler.rb +10 -11
  568. data/lib/datadog/tracing/sampling/rate_by_service_sampler.rb +32 -8
  569. data/lib/datadog/tracing/sampling/rate_limiter.rb +4 -1
  570. data/lib/datadog/tracing/sampling/rate_sampler.rb +27 -10
  571. data/lib/datadog/tracing/sampling/rule.rb +15 -9
  572. data/lib/datadog/tracing/sampling/rule_sampler.rb +11 -12
  573. data/lib/datadog/tracing/sampling/span/ext.rb +25 -0
  574. data/lib/datadog/tracing/sampling/span/matcher.rb +89 -0
  575. data/lib/datadog/tracing/sampling/span/rule.rb +82 -0
  576. data/lib/datadog/tracing/sampling/span/rule_parser.rb +104 -0
  577. data/lib/datadog/tracing/sampling/span/sampler.rb +75 -0
  578. data/lib/datadog/tracing/span.rb +24 -20
  579. data/lib/datadog/tracing/span_operation.rb +15 -16
  580. data/lib/datadog/tracing/sync_writer.rb +5 -5
  581. data/lib/datadog/tracing/trace_digest.rb +88 -2
  582. data/lib/datadog/tracing/trace_operation.rb +60 -16
  583. data/lib/datadog/tracing/trace_segment.rb +13 -8
  584. data/lib/datadog/tracing/tracer.rb +49 -21
  585. data/lib/datadog/tracing/utils.rb +50 -0
  586. data/lib/datadog/tracing/workers/trace_writer.rb +9 -9
  587. data/lib/datadog/tracing/workers.rb +3 -3
  588. data/lib/datadog/tracing/writer.rb +12 -5
  589. data/lib/datadog/tracing.rb +8 -8
  590. data/lib/ddtrace/auto_instrument.rb +9 -2
  591. data/lib/ddtrace/transport/ext.rb +7 -1
  592. data/lib/ddtrace/transport/http/adapters/net.rb +3 -2
  593. data/lib/ddtrace/transport/http/adapters/test.rb +1 -1
  594. data/lib/ddtrace/transport/http/adapters/unix_socket.rb +2 -2
  595. data/lib/ddtrace/transport/http/api/map.rb +1 -1
  596. data/lib/ddtrace/transport/http/api.rb +4 -4
  597. data/lib/ddtrace/transport/http/builder.rb +5 -5
  598. data/lib/ddtrace/transport/http/client.rb +4 -3
  599. data/lib/ddtrace/transport/http/response.rb +35 -5
  600. data/lib/ddtrace/transport/http/statistics.rb +1 -1
  601. data/lib/ddtrace/transport/http/traces.rb +5 -5
  602. data/lib/ddtrace/transport/http.rb +12 -9
  603. data/lib/ddtrace/transport/io/client.rb +5 -3
  604. data/lib/ddtrace/transport/io/response.rb +1 -1
  605. data/lib/ddtrace/transport/io/traces.rb +3 -3
  606. data/lib/ddtrace/transport/io.rb +3 -3
  607. data/lib/ddtrace/transport/statistics.rb +2 -2
  608. data/lib/ddtrace/transport/trace_formatter.rb +14 -10
  609. data/lib/ddtrace/transport/traces.rb +8 -6
  610. data/lib/ddtrace/version.rb +1 -1
  611. data/lib/ddtrace.rb +6 -5
  612. metadata +160 -44
  613. data/.editorconfig +0 -22
  614. data/.gitignore +0 -70
  615. data/CONTRIBUTING.md +0 -81
  616. data/ddtrace.gemspec +0 -59
  617. data/docs/0.x-trace.png +0 -0
  618. data/docs/1.0-trace.png +0 -0
  619. data/docs/AutoInstrumentation.md +0 -36
  620. data/docs/Deprecation.md +0 -8
  621. data/docs/DevelopmentGuide.md +0 -259
  622. data/docs/GettingStarted.md +0 -2671
  623. data/docs/ProfilingDevelopment.md +0 -110
  624. data/docs/PublicApi.md +0 -14
  625. data/docs/UpgradeGuide.md +0 -736
  626. data/lib/datadog/profiling/recorder.rb +0 -117
  627. data/lib/datadog/profiling/transport/client.rb +0 -16
  628. data/lib/datadog/profiling/transport/http/api/endpoint.rb +0 -107
  629. data/lib/datadog/profiling/transport/http/api/instance.rb +0 -38
  630. data/lib/datadog/profiling/transport/http/api/spec.rb +0 -42
  631. data/lib/datadog/profiling/transport/http/api.rb +0 -45
  632. data/lib/datadog/profiling/transport/http/builder.rb +0 -30
  633. data/lib/datadog/profiling/transport/http/client.rb +0 -35
  634. data/lib/datadog/profiling/transport/http/response.rb +0 -23
  635. data/lib/datadog/profiling/transport/http.rb +0 -112
  636. data/lib/datadog/profiling/transport/io/client.rb +0 -29
  637. data/lib/datadog/profiling/transport/io/response.rb +0 -18
  638. data/lib/datadog/profiling/transport/io.rb +0 -32
  639. data/lib/datadog/profiling/transport/parcel.rb +0 -19
  640. data/lib/datadog/profiling/transport/request.rb +0 -17
  641. data/lib/datadog/profiling/transport/response.rb +0 -10
  642. data/lib/datadog/tracing/distributed/headers/b3.rb +0 -55
  643. data/lib/datadog/tracing/distributed/headers/b3_single.rb +0 -67
  644. data/lib/datadog/tracing/distributed/headers/datadog.rb +0 -52
  645. data/lib/datadog/tracing/distributed/parser.rb +0 -70
  646. data/lib/datadog/tracing/propagation/grpc.rb +0 -88
@@ -0,0 +1,899 @@
1
+ #include <ruby.h>
2
+
3
+ #include "clock_id.h"
4
+ #include "collectors_cpu_and_wall_time.h"
5
+ #include "collectors_stack.h"
6
+ #include "helpers.h"
7
+ #include "libdatadog_helpers.h"
8
+ #include "private_vm_api_access.h"
9
+ #include "stack_recorder.h"
10
+ #include "time_helpers.h"
11
+
12
+ // Used to periodically sample threads, recording elapsed CPU-time and Wall-time between samples.
13
+ //
14
+ // This file implements the native bits of the Datadog::Profiling::Collectors::CpuAndWallTime class
15
+ //
16
+ // Triggering of this component (e.g. deciding when to take a sample) is implemented in Collectors::CpuAndWallTimeWorker.
17
+
18
+ // ---
19
+ // ## Tracking of cpu-time and wall-time spent during garbage collection
20
+ //
21
+ // This feature works by having an implicit state that a thread can be in: doing garbage collection. This state is
22
+ // tracked inside the thread's `per_thread_context.gc_tracking` data, and three functions, listed below. The functions
23
+ // will get called by the `Collectors::CpuAndWallTimeWorker` at very specific times in the VM lifetime.
24
+ //
25
+ // * `cpu_and_wall_time_collector_on_gc_start`: Called at the very beginning of the garbage collection process.
26
+ // The internal VM `during_gc` flag is set to `true`, but Ruby has not done any work yet.
27
+ // * `cpu_and_wall_time_collector_on_gc_finish`: Called at the very end of the garbage collection process.
28
+ // The internal VM `during_gc` flag is still set to `true`, but all the work has been done.
29
+ // * `cpu_and_wall_time_collector_sample_after_gc`: Called shortly after the garbage collection process.
30
+ // The internal VM `during_gc` flag is set to `false`.
31
+ //
32
+ // Inside this component, here's what happens inside those three functions:
33
+ //
34
+ // When `cpu_and_wall_time_collector_on_gc_start` gets called, the current cpu and wall-time get recorded to the thread
35
+ // context: `cpu_time_at_gc_start_ns` and `wall_time_at_gc_start_ns`.
36
+ //
37
+ // While these fields are set, regular samples (if any) do not account for any time that passes after these two
38
+ // timestamps.
39
+ //
40
+ // (Regular samples can still account for the time between the previous sample and the start of GC.)
41
+ //
42
+ // When `cpu_and_wall_time_collector_on_gc_finish` gets called, the current cpu and wall-time again get recorded to the
43
+ // thread context: `cpu_time_at_gc_finish_ns` and `wall_time_at_gc_finish_ns`.
44
+ //
45
+ // Finally, when `cpu_and_wall_time_collector_sample_after_gc` gets called, the following happens:
46
+ //
47
+ // 1. A sample gets taken, using the special `SAMPLE_IN_GC` sample type, which produces a stack with a placeholder
48
+ // `Garbage Collection` frame as the latest frame. This sample gets assigned the cpu-time and wall-time period that was
49
+ // recorded between calls to `on_gc_start` and `on_gc_finish`.
50
+ //
51
+ // 2. The thread is no longer marked as being in gc (all gc tracking fields get reset back to `INVALID_TIME`).
52
+ //
53
+ // 3. The `cpu_time_at_previous_sample_ns` and `wall_time_at_previous_sample_ns` get updated with the elapsed time in
54
+ // GC, so that all time is accounted for -- e.g. the next sample will not get "blamed" by time spent in GC.
55
+ //
56
+ // In an earlier attempt at implementing this functionality (https://github.com/DataDog/dd-trace-rb/pull/2308), we
57
+ // discovered that we needed to factor the sampling work away from `cpu_and_wall_time_collector_on_gc_finish` and into a
58
+ // separate `cpu_and_wall_time_collector_sample_after_gc` because (as documented in more detail below),
59
+ // `sample_after_gc` could trigger memory allocation in rare occasions (usually exceptions), which is actually not
60
+ // allowed to happen during Ruby's garbage collection start/finish hooks.
61
+ // ---
62
+
63
+ #define INVALID_TIME -1
64
+ #define THREAD_ID_LIMIT_CHARS 44 // Why 44? "#{2**64} (#{2**64})".size + 1 for \0
65
+ #define IS_WALL_TIME true
66
+ #define IS_NOT_WALL_TIME false
67
+ #define MISSING_TRACER_CONTEXT_KEY 0
68
+
69
+ static ID at_active_span_id; // id of :@active_span in Ruby
70
+ static ID at_active_trace_id; // id of :@active_trace in Ruby
71
+ static ID at_id_id; // id of :@id in Ruby
72
+ static ID at_resource_id; // id of :@resource in Ruby
73
+ static ID at_root_span_id; // id of :@root_span in Ruby
74
+ static ID at_type_id; // id of :@type in Ruby
75
+
76
+ // Contains state for a single CpuAndWallTime instance
77
+ struct cpu_and_wall_time_collector_state {
78
+ // Note: Places in this file that usually need to be changed when this struct is changed are tagged with
79
+ // "Update this when modifying state struct"
80
+
81
+ // Required by Datadog::Profiling::Collectors::Stack as a scratch buffer during sampling
82
+ sampling_buffer *sampling_buffer;
83
+ // Hashmap <Thread Object, struct per_thread_context>
84
+ st_table *hash_map_per_thread_context;
85
+ // Datadog::Profiling::StackRecorder instance
86
+ VALUE recorder_instance;
87
+ // If the tracer is available and enabled, this will be the fiber-local symbol for accessing its running context,
88
+ // to enable code hotspots and endpoint aggregation.
89
+ // When not available, this is set to MISSING_TRACER_CONTEXT_KEY.
90
+ ID tracer_context_key;
91
+ // Track how many regular samples we've taken. Does not include garbage collection samples.
92
+ // Currently **outside** of stats struct because we also use it to decide when to clean the contexts, and thus this
93
+ // is not (just) a stat.
94
+ unsigned int sample_count;
95
+
96
+ struct stats {
97
+ // Track how many garbage collection samples we've taken.
98
+ unsigned int gc_samples;
99
+ // See cpu_and_wall_time_collector_on_gc_start for details
100
+ unsigned int gc_samples_missed_due_to_missing_context;
101
+ } stats;
102
+ };
103
+
104
+ // Tracks per-thread state
105
+ struct per_thread_context {
106
+ char thread_id[THREAD_ID_LIMIT_CHARS];
107
+ ddog_CharSlice thread_id_char_slice;
108
+ thread_cpu_time_id thread_cpu_time_id;
109
+ long cpu_time_at_previous_sample_ns; // Can be INVALID_TIME until initialized or if getting it fails for another reason
110
+ long wall_time_at_previous_sample_ns; // Can be INVALID_TIME until initialized
111
+
112
+ struct {
113
+ // Both of these fields are set by on_gc_start and kept until sample_after_gc is called.
114
+ // Outside of this window, they will be INVALID_TIME.
115
+ long cpu_time_at_start_ns;
116
+ long wall_time_at_start_ns;
117
+
118
+ // Both of these fields are set by on_gc_finish and kept until sample_after_gc is called.
119
+ // Outside of this window, they will be INVALID_TIME.
120
+ long cpu_time_at_finish_ns;
121
+ long wall_time_at_finish_ns;
122
+ } gc_tracking;
123
+ };
124
+
125
+ // Used to correlate profiles with traces
126
+ struct trace_identifiers {
127
+ #define MAXIMUM_LENGTH_64_BIT_IDENTIFIER 21 // Why 21? 2^64 => 20 digits + 1 for \0
128
+
129
+ bool valid;
130
+ ddog_CharSlice local_root_span_id;
131
+ uint64_t span_id;
132
+ char local_root_span_id_buffer[MAXIMUM_LENGTH_64_BIT_IDENTIFIER];
133
+ VALUE trace_endpoint;
134
+ };
135
+
136
+ static void cpu_and_wall_time_collector_typed_data_mark(void *state_ptr);
137
+ static void cpu_and_wall_time_collector_typed_data_free(void *state_ptr);
138
+ static int hash_map_per_thread_context_mark(st_data_t key_thread, st_data_t _value, st_data_t _argument);
139
+ static int hash_map_per_thread_context_free_values(st_data_t _thread, st_data_t value_per_thread_context, st_data_t _argument);
140
+ static VALUE _native_new(VALUE klass);
141
+ static VALUE _native_initialize(VALUE self, VALUE collector_instance, VALUE recorder_instance, VALUE max_frames, VALUE tracer_context_key);
142
+ static VALUE _native_sample(VALUE self, VALUE collector_instance);
143
+ static VALUE _native_on_gc_start(VALUE self, VALUE collector_instance);
144
+ static VALUE _native_on_gc_finish(VALUE self, VALUE collector_instance);
145
+ static VALUE _native_sample_after_gc(DDTRACE_UNUSED VALUE self, VALUE collector_instance);
146
+ static void trigger_sample_for_thread(
147
+ struct cpu_and_wall_time_collector_state *state,
148
+ VALUE thread,
149
+ struct per_thread_context *thread_context,
150
+ ddog_Slice_I64 metric_values_slice,
151
+ sample_type type
152
+ );
153
+ static VALUE _native_thread_list(VALUE self);
154
+ static struct per_thread_context *get_or_create_context_for(VALUE thread, struct cpu_and_wall_time_collector_state *state);
155
+ static struct per_thread_context *get_context_for(VALUE thread, struct cpu_and_wall_time_collector_state *state);
156
+ static void initialize_context(VALUE thread, struct per_thread_context *thread_context);
157
+ static VALUE _native_inspect(VALUE self, VALUE collector_instance);
158
+ static VALUE per_thread_context_st_table_as_ruby_hash(struct cpu_and_wall_time_collector_state *state);
159
+ static int per_thread_context_as_ruby_hash(st_data_t key_thread, st_data_t value_context, st_data_t result_hash);
160
+ static VALUE stats_as_ruby_hash(struct cpu_and_wall_time_collector_state *state);
161
+ static void remove_context_for_dead_threads(struct cpu_and_wall_time_collector_state *state);
162
+ static int remove_if_dead_thread(st_data_t key_thread, st_data_t value_context, st_data_t _argument);
163
+ static VALUE _native_per_thread_context(VALUE self, VALUE collector_instance);
164
+ static long update_time_since_previous_sample(long *time_at_previous_sample_ns, long current_time_ns, long gc_start_time_ns, bool is_wall_time);
165
+ static long cpu_time_now_ns(struct per_thread_context *thread_context);
166
+ static long thread_id_for(VALUE thread);
167
+ static VALUE _native_stats(VALUE self, VALUE collector_instance);
168
+ static void trace_identifiers_for(struct cpu_and_wall_time_collector_state *state, VALUE thread, struct trace_identifiers *trace_identifiers_result);
169
+ static bool is_type_web(VALUE root_span_type);
170
+ static VALUE _native_reset_after_fork(DDTRACE_UNUSED VALUE self, VALUE collector_instance);
171
+
172
+ void collectors_cpu_and_wall_time_init(VALUE profiling_module) {
173
+ VALUE collectors_module = rb_define_module_under(profiling_module, "Collectors");
174
+ VALUE collectors_cpu_and_wall_time_class = rb_define_class_under(collectors_module, "CpuAndWallTime", rb_cObject);
175
+ // Hosts methods used for testing the native code using RSpec
176
+ VALUE testing_module = rb_define_module_under(collectors_cpu_and_wall_time_class, "Testing");
177
+
178
+ // Instances of the CpuAndWallTime class are "TypedData" objects.
179
+ // "TypedData" objects are special objects in the Ruby VM that can wrap C structs.
180
+ // In this case, it wraps the cpu_and_wall_time_collector_state.
181
+ //
182
+ // Because Ruby doesn't know how to initialize native-level structs, we MUST override the allocation function for objects
183
+ // of this class so that we can manage this part. Not overriding or disabling the allocation function is a common
184
+ // gotcha for "TypedData" objects that can very easily lead to VM crashes, see for instance
185
+ // https://bugs.ruby-lang.org/issues/18007 for a discussion around this.
186
+ rb_define_alloc_func(collectors_cpu_and_wall_time_class, _native_new);
187
+
188
+ rb_define_singleton_method(collectors_cpu_and_wall_time_class, "_native_initialize", _native_initialize, 4);
189
+ rb_define_singleton_method(collectors_cpu_and_wall_time_class, "_native_inspect", _native_inspect, 1);
190
+ rb_define_singleton_method(collectors_cpu_and_wall_time_class, "_native_reset_after_fork", _native_reset_after_fork, 1);
191
+ rb_define_singleton_method(testing_module, "_native_sample", _native_sample, 1);
192
+ rb_define_singleton_method(testing_module, "_native_on_gc_start", _native_on_gc_start, 1);
193
+ rb_define_singleton_method(testing_module, "_native_on_gc_finish", _native_on_gc_finish, 1);
194
+ rb_define_singleton_method(testing_module, "_native_sample_after_gc", _native_sample_after_gc, 1);
195
+ rb_define_singleton_method(testing_module, "_native_thread_list", _native_thread_list, 0);
196
+ rb_define_singleton_method(testing_module, "_native_per_thread_context", _native_per_thread_context, 1);
197
+ rb_define_singleton_method(testing_module, "_native_stats", _native_stats, 1);
198
+
199
+ at_active_span_id = rb_intern_const("@active_span");
200
+ at_active_trace_id = rb_intern_const("@active_trace");
201
+ at_id_id = rb_intern_const("@id");
202
+ at_resource_id = rb_intern_const("@resource");
203
+ at_root_span_id = rb_intern_const("@root_span");
204
+ at_type_id = rb_intern_const("@type");
205
+ }
206
+
207
+ // This structure is used to define a Ruby object that stores a pointer to a struct cpu_and_wall_time_collector_state
208
+ // See also https://github.com/ruby/ruby/blob/master/doc/extension.rdoc for how this works
209
+ static const rb_data_type_t cpu_and_wall_time_collector_typed_data = {
210
+ .wrap_struct_name = "Datadog::Profiling::Collectors::CpuAndWallTime",
211
+ .function = {
212
+ .dmark = cpu_and_wall_time_collector_typed_data_mark,
213
+ .dfree = cpu_and_wall_time_collector_typed_data_free,
214
+ .dsize = NULL, // We don't track profile memory usage (although it'd be cool if we did!)
215
+ //.dcompact = NULL, // FIXME: Add support for compaction
216
+ },
217
+ .flags = RUBY_TYPED_FREE_IMMEDIATELY
218
+ };
219
+
220
+ // This function is called by the Ruby GC to give us a chance to mark any Ruby objects that we're holding on to,
221
+ // so that they don't get garbage collected
222
+ static void cpu_and_wall_time_collector_typed_data_mark(void *state_ptr) {
223
+ struct cpu_and_wall_time_collector_state *state = (struct cpu_and_wall_time_collector_state *) state_ptr;
224
+
225
+ // Update this when modifying state struct
226
+ rb_gc_mark(state->recorder_instance);
227
+ st_foreach(state->hash_map_per_thread_context, hash_map_per_thread_context_mark, 0 /* unused */);
228
+ }
229
+
230
+ static void cpu_and_wall_time_collector_typed_data_free(void *state_ptr) {
231
+ struct cpu_and_wall_time_collector_state *state = (struct cpu_and_wall_time_collector_state *) state_ptr;
232
+
233
+ // Update this when modifying state struct
234
+
235
+ // Important: Remember that we're only guaranteed to see here what's been set in _native_new, aka
236
+ // pointers that have been set NULL there may still be NULL here.
237
+ if (state->sampling_buffer != NULL) sampling_buffer_free(state->sampling_buffer);
238
+
239
+ // Free each entry in the map
240
+ st_foreach(state->hash_map_per_thread_context, hash_map_per_thread_context_free_values, 0 /* unused */);
241
+ // ...and then the map
242
+ st_free_table(state->hash_map_per_thread_context);
243
+
244
+ ruby_xfree(state);
245
+ }
246
+
247
+ // Mark Ruby thread references we keep as keys in hash_map_per_thread_context
248
+ static int hash_map_per_thread_context_mark(st_data_t key_thread, DDTRACE_UNUSED st_data_t _value, DDTRACE_UNUSED st_data_t _argument) {
249
+ VALUE thread = (VALUE) key_thread;
250
+ rb_gc_mark(thread);
251
+ return ST_CONTINUE;
252
+ }
253
+
254
+ // Used to clear each of the per_thread_contexts inside the hash_map_per_thread_context
255
+ static int hash_map_per_thread_context_free_values(DDTRACE_UNUSED st_data_t _thread, st_data_t value_per_thread_context, DDTRACE_UNUSED st_data_t _argument) {
256
+ struct per_thread_context *per_thread_context = (struct per_thread_context*) value_per_thread_context;
257
+ ruby_xfree(per_thread_context);
258
+ return ST_CONTINUE;
259
+ }
260
+
261
+ static VALUE _native_new(VALUE klass) {
262
+ struct cpu_and_wall_time_collector_state *state = ruby_xcalloc(1, sizeof(struct cpu_and_wall_time_collector_state));
263
+
264
+ // Update this when modifying state struct
265
+ state->sampling_buffer = NULL;
266
+ state->hash_map_per_thread_context =
267
+ // "numtable" is an awful name, but TL;DR it's what should be used when keys are `VALUE`s.
268
+ st_init_numtable();
269
+ state->recorder_instance = Qnil;
270
+ state->tracer_context_key = MISSING_TRACER_CONTEXT_KEY;
271
+
272
+ return TypedData_Wrap_Struct(klass, &cpu_and_wall_time_collector_typed_data, state);
273
+ }
274
+
275
+ static VALUE _native_initialize(DDTRACE_UNUSED VALUE _self, VALUE collector_instance, VALUE recorder_instance, VALUE max_frames, VALUE tracer_context_key) {
276
+ struct cpu_and_wall_time_collector_state *state;
277
+ TypedData_Get_Struct(collector_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
278
+
279
+ int max_frames_requested = NUM2INT(max_frames);
280
+ if (max_frames_requested < 0) rb_raise(rb_eArgError, "Invalid max_frames: value must not be negative");
281
+
282
+ // Update this when modifying state struct
283
+ state->sampling_buffer = sampling_buffer_new(max_frames_requested);
284
+ // hash_map_per_thread_context is already initialized, nothing to do here
285
+ state->recorder_instance = enforce_recorder_instance(recorder_instance);
286
+
287
+ if (RTEST(tracer_context_key)) {
288
+ ENFORCE_TYPE(tracer_context_key, T_SYMBOL);
289
+ // Note about rb_to_id and dynamic symbols: calling `rb_to_id` prevents symbols from ever being garbage collected.
290
+ // In this case, we can't really escape this because as of this writing, ruby master still calls `rb_to_id` inside
291
+ // the implementation of Thread#[]= so any symbol that gets used as a key there will already be prevented from GC.
292
+ state->tracer_context_key = rb_to_id(tracer_context_key);
293
+ }
294
+
295
+ return Qtrue;
296
+ }
297
+
298
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
299
+ // It SHOULD NOT be used for other purposes.
300
+ static VALUE _native_sample(DDTRACE_UNUSED VALUE _self, VALUE collector_instance) {
301
+ cpu_and_wall_time_collector_sample(collector_instance, monotonic_wall_time_now_ns(RAISE_ON_FAILURE));
302
+ return Qtrue;
303
+ }
304
+
305
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
306
+ // It SHOULD NOT be used for other purposes.
307
+ static VALUE _native_on_gc_start(DDTRACE_UNUSED VALUE self, VALUE collector_instance) {
308
+ cpu_and_wall_time_collector_on_gc_start(collector_instance);
309
+ return Qtrue;
310
+ }
311
+
312
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
313
+ // It SHOULD NOT be used for other purposes.
314
+ static VALUE _native_on_gc_finish(DDTRACE_UNUSED VALUE self, VALUE collector_instance) {
315
+ cpu_and_wall_time_collector_on_gc_finish(collector_instance);
316
+ return Qtrue;
317
+ }
318
+
319
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
320
+ // It SHOULD NOT be used for other purposes.
321
+ static VALUE _native_sample_after_gc(DDTRACE_UNUSED VALUE self, VALUE collector_instance) {
322
+ cpu_and_wall_time_collector_sample_after_gc(collector_instance);
323
+ return Qtrue;
324
+ }
325
+
326
+ // This function gets called from the Collectors::CpuAndWallTimeWorker to trigger the actual sampling.
327
+ //
328
+ // Assumption 1: This function is called in a thread that is holding the Global VM Lock. Caller is responsible for enforcing this.
329
+ // Assumption 2: This function is allowed to raise exceptions. Caller is responsible for handling them, if needed.
330
+ // Assumption 3: This function IS NOT called from a signal handler. This function is not async-signal-safe.
331
+ // Assumption 4: This function IS NOT called in a reentrant way.
332
+ // Assumption 5: This function is called from the main Ractor (if Ruby has support for Ractors).
333
+ void cpu_and_wall_time_collector_sample(VALUE self_instance, long current_monotonic_wall_time_ns) {
334
+ struct cpu_and_wall_time_collector_state *state;
335
+ TypedData_Get_Struct(self_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
336
+
337
+ VALUE threads = ddtrace_thread_list();
338
+
339
+ const long thread_count = RARRAY_LEN(threads);
340
+ for (long i = 0; i < thread_count; i++) {
341
+ VALUE thread = RARRAY_AREF(threads, i);
342
+ struct per_thread_context *thread_context = get_or_create_context_for(thread, state);
343
+
344
+ long current_cpu_time_ns = cpu_time_now_ns(thread_context);
345
+
346
+ long cpu_time_elapsed_ns = update_time_since_previous_sample(
347
+ &thread_context->cpu_time_at_previous_sample_ns,
348
+ current_cpu_time_ns,
349
+ thread_context->gc_tracking.cpu_time_at_start_ns,
350
+ IS_NOT_WALL_TIME
351
+ );
352
+ long wall_time_elapsed_ns = update_time_since_previous_sample(
353
+ &thread_context->wall_time_at_previous_sample_ns,
354
+ current_monotonic_wall_time_ns,
355
+ thread_context->gc_tracking.wall_time_at_start_ns,
356
+ IS_WALL_TIME
357
+ );
358
+
359
+ int64_t metric_values[ENABLED_VALUE_TYPES_COUNT] = {0};
360
+
361
+ metric_values[CPU_TIME_VALUE_POS] = cpu_time_elapsed_ns;
362
+ metric_values[CPU_SAMPLES_VALUE_POS] = 1;
363
+ metric_values[WALL_TIME_VALUE_POS] = wall_time_elapsed_ns;
364
+
365
+ trigger_sample_for_thread(
366
+ state,
367
+ thread,
368
+ thread_context,
369
+ (ddog_Slice_I64) {.ptr = metric_values, .len = ENABLED_VALUE_TYPES_COUNT},
370
+ SAMPLE_REGULAR
371
+ );
372
+ }
373
+
374
+ state->sample_count++;
375
+
376
+ // TODO: This seems somewhat overkill and inefficient to do often; right now we just do it every few samples
377
+ // but there's probably a better way to do this if we actually track when threads finish
378
+ if (state->sample_count % 100 == 0) remove_context_for_dead_threads(state);
379
+ }
380
+
381
+ // This function gets called when Ruby is about to start running the Garbage Collector on the current thread.
382
+ // It updates the per_thread_context of the current thread to include the current cpu/wall times, to be used to later
383
+ // create a stack sample that blames the cpu/wall time spent from now until the end of the garbage collector work.
384
+ //
385
+ // Safety: This function gets called while Ruby is doing garbage collection. While Ruby is doing garbage collection,
386
+ // *NO ALLOCATION* is allowed. This function, and any it calls must never trigger memory or object allocation.
387
+ // This includes exceptions and use of ruby_xcalloc (because xcalloc can trigger GC)!
388
+ //
389
+ // Assumption 1: This function is called in a thread that is holding the Global VM Lock. Caller is responsible for enforcing this.
390
+ // Assumption 2: This function is called from the main Ractor (if Ruby has support for Ractors).
391
+ void cpu_and_wall_time_collector_on_gc_start(VALUE self_instance) {
392
+ struct cpu_and_wall_time_collector_state *state;
393
+ if (!rb_typeddata_is_kind_of(self_instance, &cpu_and_wall_time_collector_typed_data)) return;
394
+ // This should never fail the the above check passes
395
+ TypedData_Get_Struct(self_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
396
+
397
+ struct per_thread_context *thread_context = get_context_for(rb_thread_current(), state);
398
+
399
+ // If there was no previously-existing context for this thread, we won't allocate one (see safety). For now we just drop
400
+ // the GC sample, under the assumption that "a thread that is so new that we never sampled it even once before it triggers
401
+ // GC" is a rare enough case that we can just ignore it.
402
+ // We can always improve this later if we find that this happens often (and we have the counter to help us figure that out)!
403
+ if (thread_context == NULL) {
404
+ state->stats.gc_samples_missed_due_to_missing_context++;
405
+ return;
406
+ }
407
+
408
+ // If these fields are set, there's an existing GC sample that still needs to be written out by `sample_after_gc`.
409
+ //
410
+ // When can this happen? Because we don't have precise control over when `sample_after_gc` gets called (it will be
411
+ // called sometime after GC finishes), there is no way to guarantee that Ruby will not trigger more than one GC cycle
412
+ // before we can actually run that method.
413
+ //
414
+ // We handle this by collapsing multiple GC cycles into one. That is, if the following happens:
415
+ // `on_gc_start` (time=0) -> `on_gc_finish` (time=1) -> `on_gc_start` (time=2) -> `on_gc_finish` (time=3) -> `sample_after_gc`
416
+ // then we just use time=0 from the first on_gc_start and time=3 from the last on_gc_finish, e.g. we behave as if
417
+ // there was a single, longer GC period.
418
+ if (thread_context->gc_tracking.cpu_time_at_finish_ns != INVALID_TIME &&
419
+ thread_context->gc_tracking.wall_time_at_finish_ns != INVALID_TIME) return;
420
+
421
+ // Here we record the wall-time first and in on_gc_finish we record it second to avoid having wall-time be slightly < cpu-time
422
+ thread_context->gc_tracking.wall_time_at_start_ns = monotonic_wall_time_now_ns(DO_NOT_RAISE_ON_FAILURE);
423
+ thread_context->gc_tracking.cpu_time_at_start_ns = cpu_time_now_ns(thread_context);
424
+ }
425
+
426
+ // This function gets called when Ruby has finished running the Garbage Collector on the current thread.
427
+ // It updates the per_thread_context of the current thread to include the current cpu/wall times, to be used to later
428
+ // create a stack sample that blames the cpu/wall time spent from the start of garbage collector work until now.
429
+ //
430
+ // Safety: This function gets called while Ruby is doing garbage collection. While Ruby is doing garbage collection,
431
+ // *NO ALLOCATION* is allowed. This function, and any it calls must never trigger memory or object allocation.
432
+ // This includes exceptions and use of ruby_xcalloc (because xcalloc can trigger GC)!
433
+ //
434
+ // Assumption 1: This function is called in a thread that is holding the Global VM Lock. Caller is responsible for enforcing this.
435
+ // Assumption 2: This function is called from the main Ractor (if Ruby has support for Ractors).
436
+ void cpu_and_wall_time_collector_on_gc_finish(VALUE self_instance) {
437
+ struct cpu_and_wall_time_collector_state *state;
438
+ if (!rb_typeddata_is_kind_of(self_instance, &cpu_and_wall_time_collector_typed_data)) return;
439
+ // This should never fail the the above check passes
440
+ TypedData_Get_Struct(self_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
441
+
442
+ struct per_thread_context *thread_context = get_context_for(rb_thread_current(), state);
443
+
444
+ // If there was no previously-existing context for this thread, we won't allocate one (see safety). We keep a metric for
445
+ // how often this happens -- see on_gc_start.
446
+ if (thread_context == NULL) return;
447
+
448
+ if (thread_context->gc_tracking.cpu_time_at_start_ns == INVALID_TIME &&
449
+ thread_context->gc_tracking.wall_time_at_start_ns == INVALID_TIME) {
450
+ // If this happened, it means that on_gc_start was either never called for the thread OR it was called but no thread
451
+ // context existed at the time. The former can be the result of a bug, but since we can't distinguish them, we just
452
+ // do nothing.
453
+ return;
454
+ }
455
+
456
+ // Here we record the wall-time second and in on_gc_start we record it first to avoid having wall-time be slightly < cpu-time
457
+ thread_context->gc_tracking.cpu_time_at_finish_ns = cpu_time_now_ns(thread_context);
458
+ thread_context->gc_tracking.wall_time_at_finish_ns = monotonic_wall_time_now_ns(DO_NOT_RAISE_ON_FAILURE);
459
+ }
460
+
461
+ // This function gets called shortly after Ruby has finished running the Garbage Collector.
462
+ // It creates a new sample including the cpu and wall-time spent by the garbage collector work, and resets any
463
+ // GC-related tracking.
464
+ //
465
+ // Specifically, it will search for thread(s) which have gone through a cycle of on_gc_start/on_gc_finish
466
+ // and thus have cpu_time_at_start_ns, cpu_time_at_finish_ns, wall_time_at_start_ns, wall_time_at_finish_ns
467
+ // set on their context.
468
+ //
469
+ // Assumption 1: This function is called in a thread that is holding the Global VM Lock. Caller is responsible for enforcing this.
470
+ // Assumption 2: This function is allowed to raise exceptions. Caller is responsible for handling them, if needed.
471
+ // Assumption 3: Unlike `on_gc_start` and `on_gc_finish`, this method is allowed to allocate memory as needed.
472
+ // Assumption 4: This function is called from the main Ractor (if Ruby has support for Ractors).
473
+ VALUE cpu_and_wall_time_collector_sample_after_gc(VALUE self_instance) {
474
+ struct cpu_and_wall_time_collector_state *state;
475
+ TypedData_Get_Struct(self_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
476
+
477
+ VALUE threads = ddtrace_thread_list();
478
+ bool sampled_any_thread = false;
479
+
480
+ const long thread_count = RARRAY_LEN(threads);
481
+ for (long i = 0; i < thread_count; i++) {
482
+ VALUE thread = RARRAY_AREF(threads, i);
483
+ struct per_thread_context *thread_context = get_or_create_context_for(thread, state);
484
+
485
+ if (
486
+ thread_context->gc_tracking.cpu_time_at_start_ns == INVALID_TIME ||
487
+ thread_context->gc_tracking.cpu_time_at_finish_ns == INVALID_TIME ||
488
+ thread_context->gc_tracking.wall_time_at_start_ns == INVALID_TIME ||
489
+ thread_context->gc_tracking.wall_time_at_finish_ns == INVALID_TIME
490
+ ) continue; // Ignore threads with no/incomplete garbage collection data
491
+
492
+ sampled_any_thread = true;
493
+
494
+ long gc_cpu_time_elapsed_ns =
495
+ thread_context->gc_tracking.cpu_time_at_finish_ns - thread_context->gc_tracking.cpu_time_at_start_ns;
496
+ long gc_wall_time_elapsed_ns =
497
+ thread_context->gc_tracking.wall_time_at_finish_ns - thread_context->gc_tracking.wall_time_at_start_ns;
498
+
499
+ // We don't expect non-wall time to go backwards, so let's flag this as a bug
500
+ if (gc_cpu_time_elapsed_ns < 0) rb_raise(rb_eRuntimeError, "BUG: Unexpected negative gc_cpu_time_elapsed_ns between samples");
501
+ // Wall-time can actually go backwards (e.g. when the system clock gets set) so we can't assume time going backwards
502
+ // was a bug.
503
+ // @ivoanjo: I've also observed time going backwards spuriously on macOS, see discussion on
504
+ // https://github.com/DataDog/dd-trace-rb/pull/2336.
505
+ if (gc_wall_time_elapsed_ns < 0) gc_wall_time_elapsed_ns = 0;
506
+
507
+ if (thread_context->gc_tracking.wall_time_at_start_ns == 0 && thread_context->gc_tracking.wall_time_at_finish_ns != 0) {
508
+ // Avoid using wall-clock if we got 0 for a start (meaning there was an error) but not 0 for finish so we don't
509
+ // come up with a crazy value for the frame
510
+ rb_raise(rb_eRuntimeError, "BUG: Unexpected zero value for gc_tracking.wall_time_at_start_ns");
511
+ }
512
+
513
+ int64_t metric_values[ENABLED_VALUE_TYPES_COUNT] = {0};
514
+
515
+ metric_values[CPU_TIME_VALUE_POS] = gc_cpu_time_elapsed_ns;
516
+ metric_values[CPU_SAMPLES_VALUE_POS] = 1;
517
+ metric_values[WALL_TIME_VALUE_POS] = gc_wall_time_elapsed_ns;
518
+
519
+ trigger_sample_for_thread(
520
+ state,
521
+ thread,
522
+ thread_context,
523
+ (ddog_Slice_I64) {.ptr = metric_values, .len = ENABLED_VALUE_TYPES_COUNT},
524
+ SAMPLE_IN_GC
525
+ );
526
+
527
+ // Mark thread as no longer in GC
528
+ thread_context->gc_tracking.cpu_time_at_start_ns = INVALID_TIME;
529
+ thread_context->gc_tracking.cpu_time_at_finish_ns = INVALID_TIME;
530
+ thread_context->gc_tracking.wall_time_at_start_ns = INVALID_TIME;
531
+ thread_context->gc_tracking.wall_time_at_finish_ns = INVALID_TIME;
532
+
533
+ // Update counters so that they won't include the time in GC during the next sample
534
+ if (thread_context->cpu_time_at_previous_sample_ns != INVALID_TIME) {
535
+ thread_context->cpu_time_at_previous_sample_ns += gc_cpu_time_elapsed_ns;
536
+ }
537
+ if (thread_context->wall_time_at_previous_sample_ns != INVALID_TIME) {
538
+ thread_context->wall_time_at_previous_sample_ns += gc_wall_time_elapsed_ns;
539
+ }
540
+ }
541
+
542
+ if (sampled_any_thread) state->stats.gc_samples++;
543
+
544
+ // Return a VALUE to make it easier to call this function from Ruby APIs that expect a return value (such as rb_rescue2)
545
+ return Qnil;
546
+ }
547
+
548
+ static void trigger_sample_for_thread(
549
+ struct cpu_and_wall_time_collector_state *state,
550
+ VALUE thread,
551
+ struct per_thread_context *thread_context,
552
+ ddog_Slice_I64 metric_values_slice,
553
+ sample_type type
554
+ ) {
555
+ int max_label_count =
556
+ 1 + // thread id
557
+ 1 + // thread name
558
+ 2; // local root span id and span id
559
+ ddog_prof_Label labels[max_label_count];
560
+ int label_pos = 0;
561
+
562
+ labels[label_pos++] = (ddog_prof_Label) {
563
+ .key = DDOG_CHARSLICE_C("thread id"),
564
+ .str = thread_context->thread_id_char_slice
565
+ };
566
+
567
+ VALUE thread_name = thread_name_for(thread);
568
+ if (thread_name != Qnil) {
569
+ labels[label_pos++] = (ddog_prof_Label) {
570
+ .key = DDOG_CHARSLICE_C("thread name"),
571
+ .str = char_slice_from_ruby_string(thread_name)
572
+ };
573
+ }
574
+
575
+ struct trace_identifiers trace_identifiers_result = {.valid = false, .trace_endpoint = Qnil};
576
+ trace_identifiers_for(state, thread, &trace_identifiers_result);
577
+
578
+ if (trace_identifiers_result.valid) {
579
+ labels[label_pos++] = (ddog_prof_Label) {.key = DDOG_CHARSLICE_C("local root span id"), .str = trace_identifiers_result.local_root_span_id};
580
+ labels[label_pos++] = (ddog_prof_Label) {.key = DDOG_CHARSLICE_C("span id"), .num = trace_identifiers_result.span_id};
581
+
582
+ if (trace_identifiers_result.trace_endpoint != Qnil) {
583
+ // The endpoint gets recorded in a different way because it is mutable in the tracer and can change during a
584
+ // trace.
585
+ //
586
+ // Instead of each sample for the same local_root_span_id getting a potentially-different endpoint,
587
+ // `record_endpoint` (via libdatadog) keeps a list of local_root_span_id values and their most-recently-seen
588
+ // endpoint values, and at serialization time the most-recently-seen endpoint is applied to all relevant samples.
589
+ //
590
+ // This is why the endpoint is not directly added in this function to the labels array, although it will later
591
+ // show up in the array in the output pprof.
592
+ record_endpoint(
593
+ state->recorder_instance,
594
+ trace_identifiers_result.local_root_span_id,
595
+ char_slice_from_ruby_string(trace_identifiers_result.trace_endpoint)
596
+ );
597
+ }
598
+ }
599
+
600
+ // The number of times `label_pos++` shows up in this function needs to match `max_label_count`. To avoid "oops I
601
+ // forgot to update max_label_count" in the future, we've also added this validation.
602
+ // @ivoanjo: I wonder if C compilers are smart enough to statically prove when this check never triggers happens and
603
+ // remove it entirely.
604
+ if (label_pos > max_label_count) {
605
+ rb_raise(rb_eRuntimeError, "BUG: Unexpected label_pos (%d) > max_label_count (%d)", label_pos, max_label_count);
606
+ }
607
+
608
+ sample_thread(
609
+ thread,
610
+ state->sampling_buffer,
611
+ state->recorder_instance,
612
+ metric_values_slice,
613
+ (ddog_prof_Slice_Label) {.ptr = labels, .len = label_pos},
614
+ type
615
+ );
616
+ }
617
+
618
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
619
+ // It SHOULD NOT be used for other purposes.
620
+ static VALUE _native_thread_list(DDTRACE_UNUSED VALUE _self) {
621
+ return ddtrace_thread_list();
622
+ }
623
+
624
+ static struct per_thread_context *get_or_create_context_for(VALUE thread, struct cpu_and_wall_time_collector_state *state) {
625
+ struct per_thread_context* thread_context = NULL;
626
+ st_data_t value_context = 0;
627
+
628
+ if (st_lookup(state->hash_map_per_thread_context, (st_data_t) thread, &value_context)) {
629
+ thread_context = (struct per_thread_context*) value_context;
630
+ } else {
631
+ thread_context = ruby_xcalloc(1, sizeof(struct per_thread_context));
632
+ initialize_context(thread, thread_context);
633
+ st_insert(state->hash_map_per_thread_context, (st_data_t) thread, (st_data_t) thread_context);
634
+ }
635
+
636
+ return thread_context;
637
+ }
638
+
639
+ static struct per_thread_context *get_context_for(VALUE thread, struct cpu_and_wall_time_collector_state *state) {
640
+ struct per_thread_context* thread_context = NULL;
641
+ st_data_t value_context = 0;
642
+
643
+ if (st_lookup(state->hash_map_per_thread_context, (st_data_t) thread, &value_context)) {
644
+ thread_context = (struct per_thread_context*) value_context;
645
+ }
646
+
647
+ return thread_context;
648
+ }
649
+
650
+ static void initialize_context(VALUE thread, struct per_thread_context *thread_context) {
651
+ snprintf(thread_context->thread_id, THREAD_ID_LIMIT_CHARS, "%"PRIu64" (%lu)", native_thread_id_for(thread), (unsigned long) thread_id_for(thread));
652
+ thread_context->thread_id_char_slice = (ddog_CharSlice) {.ptr = thread_context->thread_id, .len = strlen(thread_context->thread_id)};
653
+
654
+ thread_context->thread_cpu_time_id = thread_cpu_time_id_for(thread);
655
+
656
+ // These will get initialized during actual sampling
657
+ thread_context->cpu_time_at_previous_sample_ns = INVALID_TIME;
658
+ thread_context->wall_time_at_previous_sample_ns = INVALID_TIME;
659
+
660
+ // These will only be used during a GC operation
661
+ thread_context->gc_tracking.cpu_time_at_start_ns = INVALID_TIME;
662
+ thread_context->gc_tracking.cpu_time_at_finish_ns = INVALID_TIME;
663
+ thread_context->gc_tracking.wall_time_at_start_ns = INVALID_TIME;
664
+ thread_context->gc_tracking.wall_time_at_finish_ns = INVALID_TIME;
665
+ }
666
+
667
+ static VALUE _native_inspect(DDTRACE_UNUSED VALUE _self, VALUE collector_instance) {
668
+ struct cpu_and_wall_time_collector_state *state;
669
+ TypedData_Get_Struct(collector_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
670
+
671
+ VALUE result = rb_str_new2(" (native state)");
672
+
673
+ // Update this when modifying state struct
674
+ rb_str_concat(result, rb_sprintf(" hash_map_per_thread_context=%"PRIsVALUE, per_thread_context_st_table_as_ruby_hash(state)));
675
+ rb_str_concat(result, rb_sprintf(" recorder_instance=%"PRIsVALUE, state->recorder_instance));
676
+ VALUE tracer_context_key = state->tracer_context_key == MISSING_TRACER_CONTEXT_KEY ? Qnil : ID2SYM(state->tracer_context_key);
677
+ rb_str_concat(result, rb_sprintf(" tracer_context_key=%+"PRIsVALUE, tracer_context_key));
678
+ rb_str_concat(result, rb_sprintf(" sample_count=%u", state->sample_count));
679
+ rb_str_concat(result, rb_sprintf(" stats=%"PRIsVALUE, stats_as_ruby_hash(state)));
680
+
681
+ return result;
682
+ }
683
+
684
+ static VALUE per_thread_context_st_table_as_ruby_hash(struct cpu_and_wall_time_collector_state *state) {
685
+ VALUE result = rb_hash_new();
686
+ st_foreach(state->hash_map_per_thread_context, per_thread_context_as_ruby_hash, result);
687
+ return result;
688
+ }
689
+
690
+ static int per_thread_context_as_ruby_hash(st_data_t key_thread, st_data_t value_context, st_data_t result_hash) {
691
+ VALUE thread = (VALUE) key_thread;
692
+ struct per_thread_context *thread_context = (struct per_thread_context*) value_context;
693
+ VALUE result = (VALUE) result_hash;
694
+ VALUE context_as_hash = rb_hash_new();
695
+ rb_hash_aset(result, thread, context_as_hash);
696
+
697
+ VALUE arguments[] = {
698
+ ID2SYM(rb_intern("thread_id")), /* => */ rb_str_new2(thread_context->thread_id),
699
+ ID2SYM(rb_intern("thread_cpu_time_id_valid?")), /* => */ thread_context->thread_cpu_time_id.valid ? Qtrue : Qfalse,
700
+ ID2SYM(rb_intern("thread_cpu_time_id")), /* => */ CLOCKID2NUM(thread_context->thread_cpu_time_id.clock_id),
701
+ ID2SYM(rb_intern("cpu_time_at_previous_sample_ns")), /* => */ LONG2NUM(thread_context->cpu_time_at_previous_sample_ns),
702
+ ID2SYM(rb_intern("wall_time_at_previous_sample_ns")), /* => */ LONG2NUM(thread_context->wall_time_at_previous_sample_ns),
703
+
704
+ ID2SYM(rb_intern("gc_tracking.cpu_time_at_start_ns")), /* => */ LONG2NUM(thread_context->gc_tracking.cpu_time_at_start_ns),
705
+ ID2SYM(rb_intern("gc_tracking.cpu_time_at_finish_ns")), /* => */ LONG2NUM(thread_context->gc_tracking.cpu_time_at_finish_ns),
706
+ ID2SYM(rb_intern("gc_tracking.wall_time_at_start_ns")), /* => */ LONG2NUM(thread_context->gc_tracking.wall_time_at_start_ns),
707
+ ID2SYM(rb_intern("gc_tracking.wall_time_at_finish_ns")), /* => */ LONG2NUM(thread_context->gc_tracking.wall_time_at_finish_ns)
708
+ };
709
+ for (long unsigned int i = 0; i < VALUE_COUNT(arguments); i += 2) rb_hash_aset(context_as_hash, arguments[i], arguments[i+1]);
710
+
711
+ return ST_CONTINUE;
712
+ }
713
+
714
+ static VALUE stats_as_ruby_hash(struct cpu_and_wall_time_collector_state *state) {
715
+ // Update this when modifying state struct (stats inner struct)
716
+ VALUE stats_as_hash = rb_hash_new();
717
+ VALUE arguments[] = {
718
+ ID2SYM(rb_intern("gc_samples")), /* => */ UINT2NUM(state->stats.gc_samples),
719
+ ID2SYM(rb_intern("gc_samples_missed_due_to_missing_context")), /* => */ UINT2NUM(state->stats.gc_samples_missed_due_to_missing_context),
720
+ };
721
+ for (long unsigned int i = 0; i < VALUE_COUNT(arguments); i += 2) rb_hash_aset(stats_as_hash, arguments[i], arguments[i+1]);
722
+ return stats_as_hash;
723
+ }
724
+
725
+ static void remove_context_for_dead_threads(struct cpu_and_wall_time_collector_state *state) {
726
+ st_foreach(state->hash_map_per_thread_context, remove_if_dead_thread, 0 /* unused */);
727
+ }
728
+
729
+ static int remove_if_dead_thread(st_data_t key_thread, st_data_t value_context, DDTRACE_UNUSED st_data_t _argument) {
730
+ VALUE thread = (VALUE) key_thread;
731
+ struct per_thread_context* thread_context = (struct per_thread_context*) value_context;
732
+
733
+ if (is_thread_alive(thread)) return ST_CONTINUE;
734
+
735
+ ruby_xfree(thread_context);
736
+ return ST_DELETE;
737
+ }
738
+
739
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
740
+ // It SHOULD NOT be used for other purposes.
741
+ //
742
+ // Returns the whole contents of the per_thread_context structs being tracked.
743
+ static VALUE _native_per_thread_context(DDTRACE_UNUSED VALUE _self, VALUE collector_instance) {
744
+ struct cpu_and_wall_time_collector_state *state;
745
+ TypedData_Get_Struct(collector_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
746
+
747
+ return per_thread_context_st_table_as_ruby_hash(state);
748
+ }
749
+
750
+ static long update_time_since_previous_sample(long *time_at_previous_sample_ns, long current_time_ns, long gc_start_time_ns, bool is_wall_time) {
751
+ // If we didn't have a time for the previous sample, we use the current one
752
+ if (*time_at_previous_sample_ns == INVALID_TIME) *time_at_previous_sample_ns = current_time_ns;
753
+
754
+ bool is_thread_doing_gc = gc_start_time_ns != INVALID_TIME;
755
+ long elapsed_time_ns = -1;
756
+
757
+ if (is_thread_doing_gc) {
758
+ bool previous_sample_was_during_gc = gc_start_time_ns <= *time_at_previous_sample_ns;
759
+
760
+ if (previous_sample_was_during_gc) {
761
+ elapsed_time_ns = 0; // No time to account for -- any time since the last sample is going to get assigned to GC separately
762
+ } else {
763
+ elapsed_time_ns = gc_start_time_ns - *time_at_previous_sample_ns; // Capture time between previous sample and start of GC only
764
+ }
765
+
766
+ // Remaining time (from gc_start_time to current_time_ns) will be accounted for inside `sample_after_gc`
767
+ *time_at_previous_sample_ns = gc_start_time_ns;
768
+ } else {
769
+ elapsed_time_ns = current_time_ns - *time_at_previous_sample_ns; // Capture all time since previous sample
770
+ *time_at_previous_sample_ns = current_time_ns;
771
+ }
772
+
773
+ if (elapsed_time_ns < 0) {
774
+ if (is_wall_time) {
775
+ // Wall-time can actually go backwards (e.g. when the system clock gets set) so we can't assume time going backwards
776
+ // was a bug.
777
+ // @ivoanjo: I've also observed time going backwards spuriously on macOS, see discussion on
778
+ // https://github.com/DataDog/dd-trace-rb/pull/2336.
779
+ elapsed_time_ns = 0;
780
+ } else {
781
+ // We don't expect non-wall time to go backwards, so let's flag this as a bug
782
+ rb_raise(rb_eRuntimeError, "BUG: Unexpected negative elapsed_time_ns between samples");
783
+ }
784
+ }
785
+
786
+ return elapsed_time_ns;
787
+ }
788
+
789
+ // Safety: This function is assumed never to raise exceptions by callers
790
+ static long cpu_time_now_ns(struct per_thread_context *thread_context) {
791
+ thread_cpu_time cpu_time = thread_cpu_time_for(thread_context->thread_cpu_time_id);
792
+
793
+ if (!cpu_time.valid) {
794
+ // Invalidate previous state of the counter (if any), it's no longer accurate. We need to get two good reads
795
+ // in a row to have an accurate delta.
796
+ thread_context->cpu_time_at_previous_sample_ns = INVALID_TIME;
797
+ return 0;
798
+ }
799
+
800
+ return cpu_time.result_ns;
801
+ }
802
+
803
+ static long thread_id_for(VALUE thread) {
804
+ VALUE object_id = rb_obj_id(thread);
805
+
806
+ // The API docs for Ruby state that `rb_obj_id` COULD be a BIGNUM and that if you want to be really sure you don't
807
+ // get a BIGNUM, then you should use `rb_memory_id`. But `rb_memory_id` is less interesting because it's less visible
808
+ // at the user level than the result of calling `#object_id`.
809
+ //
810
+ // It also seems uncommon to me that we'd ever get a BIGNUM; on old Ruby versions (pre-GC compaction), the object id
811
+ // was the pointer to the object, so that's not going to be a BIGNUM; on modern Ruby versions, Ruby keeps
812
+ // a counter, and only increments it for objects for which `#object_id`/`rb_obj_id` is called (e.g. most objects
813
+ // won't actually have an object id allocated).
814
+ //
815
+ // So, for now, let's simplify: we only support FIXNUMs, and we won't break if we get a BIGNUM; we just won't
816
+ // record the thread_id (but samples will still be collected).
817
+ return FIXNUM_P(object_id) ? FIX2LONG(object_id) : -1;
818
+ }
819
+
820
+ VALUE enforce_cpu_and_wall_time_collector_instance(VALUE object) {
821
+ Check_TypedStruct(object, &cpu_and_wall_time_collector_typed_data);
822
+ return object;
823
+ }
824
+
825
+ // This method exists only to enable testing Datadog::Profiling::Collectors::CpuAndWallTime behavior using RSpec.
826
+ // It SHOULD NOT be used for other purposes.
827
+ //
828
+ // Returns the whole contents of the per_thread_context structs being tracked.
829
+ static VALUE _native_stats(DDTRACE_UNUSED VALUE _self, VALUE collector_instance) {
830
+ struct cpu_and_wall_time_collector_state *state;
831
+ TypedData_Get_Struct(collector_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
832
+
833
+ return stats_as_ruby_hash(state);
834
+ }
835
+
836
+ // Assumption 1: This function is called in a thread that is holding the Global VM Lock. Caller is responsible for enforcing this.
837
+ static void trace_identifiers_for(struct cpu_and_wall_time_collector_state *state, VALUE thread, struct trace_identifiers *trace_identifiers_result) {
838
+ if (state->tracer_context_key == MISSING_TRACER_CONTEXT_KEY) return;
839
+
840
+ VALUE current_context = rb_thread_local_aref(thread, state->tracer_context_key);
841
+ if (current_context == Qnil) return;
842
+
843
+ VALUE active_trace = rb_ivar_get(current_context, at_active_trace_id /* @active_trace */);
844
+ if (active_trace == Qnil) return;
845
+
846
+ VALUE root_span = rb_ivar_get(active_trace, at_root_span_id /* @root_span */);
847
+ VALUE active_span = rb_ivar_get(active_trace, at_active_span_id /* @active_span */);
848
+ if (root_span == Qnil || active_span == Qnil) return;
849
+
850
+ VALUE numeric_local_root_span_id = rb_ivar_get(root_span, at_id_id /* @id */);
851
+ VALUE numeric_span_id = rb_ivar_get(active_span, at_id_id /* @id */);
852
+ if (numeric_local_root_span_id == Qnil || numeric_span_id == Qnil) return;
853
+
854
+ unsigned long long local_root_span_id = NUM2ULL(numeric_local_root_span_id);
855
+ snprintf(trace_identifiers_result->local_root_span_id_buffer, MAXIMUM_LENGTH_64_BIT_IDENTIFIER, "%llu", local_root_span_id);
856
+
857
+ trace_identifiers_result->local_root_span_id = (ddog_CharSlice) {
858
+ .ptr = trace_identifiers_result->local_root_span_id_buffer,
859
+ .len = strlen(trace_identifiers_result->local_root_span_id_buffer)
860
+ };
861
+ trace_identifiers_result->span_id = NUM2ULL(numeric_span_id);
862
+
863
+ trace_identifiers_result->valid = true;
864
+
865
+ VALUE root_span_type = rb_ivar_get(root_span, at_type_id /* @type */);
866
+ if (root_span_type == Qnil || !is_type_web(root_span_type)) return;
867
+
868
+ VALUE trace_resource = rb_ivar_get(active_trace, at_resource_id /* @resource */);
869
+ if (RB_TYPE_P(trace_resource, T_STRING)) {
870
+ trace_identifiers_result->trace_endpoint = trace_resource;
871
+ } else if (trace_resource == Qnil) {
872
+ // Fall back to resource from span, if any
873
+ trace_identifiers_result->trace_endpoint = rb_ivar_get(root_span, at_resource_id /* @resource */);
874
+ }
875
+ }
876
+
877
+ static bool is_type_web(VALUE root_span_type) {
878
+ ENFORCE_TYPE(root_span_type, T_STRING);
879
+
880
+ return RSTRING_LEN(root_span_type) == strlen("web") &&
881
+ (memcmp("web", StringValuePtr(root_span_type), strlen("web")) == 0);
882
+ }
883
+
884
+ // After the Ruby VM forks, this method gets called in the child process to clean up any leftover state from the parent.
885
+ //
886
+ // Assumption: This method gets called BEFORE restarting profiling -- e.g. there are no components attempting to
887
+ // trigger samples at the same time.
888
+ static VALUE _native_reset_after_fork(DDTRACE_UNUSED VALUE self, VALUE collector_instance) {
889
+ struct cpu_and_wall_time_collector_state *state;
890
+ TypedData_Get_Struct(collector_instance, struct cpu_and_wall_time_collector_state, &cpu_and_wall_time_collector_typed_data, state);
891
+
892
+ st_clear(state->hash_map_per_thread_context);
893
+
894
+ state->stats = (struct stats) {}; // Resets all stats back to zero
895
+
896
+ rb_funcall(state->recorder_instance, rb_intern("reset_after_fork"), 0);
897
+
898
+ return Qtrue;
899
+ }