ddtrace 1.0.0 → 1.10.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (767) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +529 -2
  3. data/LICENSE-3rdparty.csv +7 -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 +72 -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_worker.c +821 -0
  12. data/ext/ddtrace_profiling_native_extension/collectors_dynamic_sampling_rate.c +142 -0
  13. data/ext/ddtrace_profiling_native_extension/collectors_dynamic_sampling_rate.h +14 -0
  14. data/ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.c +241 -0
  15. data/ext/ddtrace_profiling_native_extension/collectors_idle_sampling_helper.h +3 -0
  16. data/ext/ddtrace_profiling_native_extension/collectors_stack.c +379 -0
  17. data/ext/ddtrace_profiling_native_extension/collectors_stack.h +20 -0
  18. data/ext/ddtrace_profiling_native_extension/collectors_thread_context.c +978 -0
  19. data/ext/ddtrace_profiling_native_extension/collectors_thread_context.h +14 -0
  20. data/ext/ddtrace_profiling_native_extension/extconf.rb +147 -116
  21. data/ext/ddtrace_profiling_native_extension/helpers.h +17 -0
  22. data/ext/ddtrace_profiling_native_extension/http_transport.c +347 -0
  23. data/ext/ddtrace_profiling_native_extension/libdatadog_helpers.h +25 -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 +706 -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 +591 -0
  33. data/ext/ddtrace_profiling_native_extension/stack_recorder.h +14 -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 +1722 -636
  40. data/lib/datadog/appsec/assets/waf_rules/strict.json +366 -74
  41. data/lib/datadog/appsec/assets.rb +2 -4
  42. data/lib/datadog/appsec/autoload.rb +5 -10
  43. data/lib/datadog/appsec/component.rb +41 -0
  44. data/lib/datadog/appsec/configuration/settings.rb +61 -20
  45. data/lib/datadog/appsec/configuration.rb +20 -4
  46. data/lib/datadog/appsec/contrib/auto_instrument.rb +0 -4
  47. data/lib/datadog/appsec/contrib/configuration/settings.rb +1 -3
  48. data/lib/datadog/appsec/contrib/integration.rb +0 -2
  49. data/lib/datadog/appsec/contrib/patcher.rb +0 -2
  50. data/lib/datadog/appsec/contrib/rack/configuration/settings.rb +2 -4
  51. data/lib/datadog/appsec/contrib/rack/ext.rb +0 -2
  52. data/lib/datadog/appsec/contrib/rack/gateway/request.rb +97 -0
  53. data/lib/datadog/appsec/contrib/rack/gateway/response.rb +30 -0
  54. data/lib/datadog/appsec/contrib/rack/gateway/watcher.rb +137 -87
  55. data/lib/datadog/appsec/contrib/rack/integration.rb +5 -6
  56. data/lib/datadog/appsec/contrib/rack/patcher.rb +4 -5
  57. data/lib/datadog/appsec/contrib/rack/reactive/request.rb +31 -38
  58. data/lib/datadog/appsec/contrib/rack/reactive/request_body.rb +63 -0
  59. data/lib/datadog/appsec/contrib/rack/reactive/response.rb +21 -22
  60. data/lib/datadog/appsec/contrib/rack/request_body_middleware.rb +43 -0
  61. data/lib/datadog/appsec/contrib/rack/request_middleware.rb +117 -21
  62. data/lib/datadog/appsec/contrib/rails/configuration/settings.rb +2 -4
  63. data/lib/datadog/appsec/contrib/rails/ext.rb +0 -2
  64. data/lib/datadog/appsec/contrib/rails/framework.rb +0 -2
  65. data/lib/datadog/appsec/contrib/rails/gateway/request.rb +67 -0
  66. data/lib/datadog/appsec/contrib/rails/gateway/watcher.rb +86 -0
  67. data/lib/datadog/appsec/contrib/rails/integration.rb +5 -7
  68. data/lib/datadog/appsec/contrib/rails/patcher.rb +44 -10
  69. data/lib/datadog/appsec/contrib/rails/reactive/action.rb +69 -0
  70. data/lib/datadog/appsec/contrib/rails/request.rb +34 -0
  71. data/lib/datadog/appsec/contrib/rails/request_middleware.rb +0 -2
  72. data/lib/datadog/appsec/contrib/sinatra/configuration/settings.rb +2 -4
  73. data/lib/datadog/appsec/contrib/sinatra/ext.rb +1 -2
  74. data/lib/datadog/appsec/contrib/sinatra/framework.rb +0 -2
  75. data/lib/datadog/appsec/contrib/sinatra/gateway/request.rb +17 -0
  76. data/lib/datadog/appsec/contrib/sinatra/gateway/route_params.rb +23 -0
  77. data/lib/datadog/appsec/contrib/sinatra/gateway/watcher.rb +131 -0
  78. data/lib/datadog/appsec/contrib/sinatra/integration.rb +4 -6
  79. data/lib/datadog/appsec/contrib/sinatra/patcher.rb +94 -12
  80. data/lib/datadog/appsec/contrib/sinatra/reactive/routed.rb +64 -0
  81. data/lib/datadog/appsec/contrib/sinatra/request_middleware.rb +0 -2
  82. data/lib/datadog/appsec/event.rb +33 -26
  83. data/lib/datadog/appsec/ext.rb +9 -0
  84. data/lib/datadog/appsec/extensions.rb +51 -26
  85. data/lib/datadog/appsec/instrumentation/gateway/argument.rb +24 -0
  86. data/lib/datadog/appsec/instrumentation/gateway.rb +26 -6
  87. data/lib/datadog/appsec/instrumentation.rb +9 -0
  88. data/lib/datadog/appsec/monitor/gateway/watcher.rb +86 -0
  89. data/lib/datadog/appsec/monitor/reactive/set_user.rb +61 -0
  90. data/lib/datadog/appsec/monitor.rb +11 -0
  91. data/lib/datadog/appsec/processor.rb +143 -21
  92. data/lib/datadog/appsec/rate_limiter.rb +5 -2
  93. data/lib/datadog/appsec/reactive/address_hash.rb +6 -2
  94. data/lib/datadog/appsec/reactive/engine.rb +12 -9
  95. data/lib/datadog/appsec/reactive/operation.rb +22 -6
  96. data/lib/datadog/appsec/reactive/subscriber.rb +2 -1
  97. data/lib/datadog/appsec/response.rb +61 -0
  98. data/lib/datadog/appsec/utils/http/media_range.rb +199 -0
  99. data/lib/datadog/appsec/utils/http/media_type.rb +85 -0
  100. data/lib/datadog/appsec/utils/http.rb +9 -0
  101. data/lib/datadog/appsec/utils.rb +7 -0
  102. data/lib/datadog/appsec.rb +25 -7
  103. data/lib/datadog/ci/configuration/components.rb +1 -3
  104. data/lib/datadog/ci/configuration/settings.rb +1 -3
  105. data/lib/datadog/ci/contrib/cucumber/configuration/settings.rb +2 -4
  106. data/lib/datadog/ci/contrib/cucumber/ext.rb +0 -2
  107. data/lib/datadog/ci/contrib/cucumber/formatter.rb +5 -7
  108. data/lib/datadog/ci/contrib/cucumber/instrumentation.rb +1 -3
  109. data/lib/datadog/ci/contrib/cucumber/integration.rb +4 -6
  110. data/lib/datadog/ci/contrib/cucumber/patcher.rb +2 -4
  111. data/lib/datadog/ci/contrib/rspec/configuration/settings.rb +2 -4
  112. data/lib/datadog/ci/contrib/rspec/example.rb +5 -7
  113. data/lib/datadog/ci/contrib/rspec/ext.rb +0 -2
  114. data/lib/datadog/ci/contrib/rspec/integration.rb +4 -6
  115. data/lib/datadog/ci/contrib/rspec/patcher.rb +2 -4
  116. data/lib/datadog/ci/ext/app_types.rb +0 -2
  117. data/lib/datadog/ci/ext/environment.rb +98 -48
  118. data/lib/datadog/ci/ext/settings.rb +0 -2
  119. data/lib/datadog/ci/ext/test.rb +0 -2
  120. data/lib/datadog/ci/extensions.rb +4 -6
  121. data/lib/datadog/ci/flush.rb +2 -4
  122. data/lib/datadog/ci/test.rb +3 -5
  123. data/lib/datadog/ci.rb +6 -8
  124. data/lib/datadog/core/buffer/cruby.rb +1 -3
  125. data/lib/datadog/core/buffer/random.rb +0 -2
  126. data/lib/datadog/core/buffer/thread_safe.rb +1 -3
  127. data/lib/datadog/core/chunker.rb +0 -2
  128. data/lib/datadog/core/configuration/agent_settings_resolver.rb +9 -29
  129. data/lib/datadog/core/configuration/base.rb +14 -4
  130. data/lib/datadog/core/configuration/components.rb +31 -266
  131. data/lib/datadog/core/configuration/dependency_resolver.rb +0 -2
  132. data/lib/datadog/core/configuration/ext.rb +24 -0
  133. data/lib/datadog/core/configuration/option.rb +0 -2
  134. data/lib/datadog/core/configuration/option_definition.rb +12 -5
  135. data/lib/datadog/core/configuration/option_definition_set.rb +1 -3
  136. data/lib/datadog/core/configuration/option_set.rb +0 -2
  137. data/lib/datadog/core/configuration/options.rb +3 -5
  138. data/lib/datadog/core/configuration/settings.rb +92 -255
  139. data/lib/datadog/core/configuration.rb +16 -15
  140. data/lib/datadog/core/diagnostics/environment_logger.rb +10 -7
  141. data/lib/datadog/core/diagnostics/health.rb +4 -24
  142. data/lib/datadog/core/encoding.rb +0 -4
  143. data/lib/datadog/core/environment/cgroup.rb +4 -6
  144. data/lib/datadog/core/environment/class_count.rb +0 -2
  145. data/lib/datadog/core/environment/container.rb +3 -6
  146. data/lib/datadog/core/environment/ext.rb +1 -3
  147. data/lib/datadog/core/environment/gc.rb +0 -2
  148. data/lib/datadog/core/environment/identity.rb +2 -4
  149. data/lib/datadog/core/environment/platform.rb +38 -0
  150. data/lib/datadog/core/environment/socket.rb +1 -3
  151. data/lib/datadog/core/environment/thread_count.rb +0 -2
  152. data/lib/datadog/core/environment/variable_helpers.rb +83 -13
  153. data/lib/datadog/core/environment/vm_cache.rb +17 -2
  154. data/lib/datadog/core/error.rb +1 -3
  155. data/lib/datadog/core/extensions.rb +1 -3
  156. data/lib/datadog/core/git/ext.rb +0 -2
  157. data/lib/datadog/core/header_collection.rb +41 -0
  158. data/lib/datadog/core/logger.rb +0 -2
  159. data/lib/datadog/core/logging/ext.rb +11 -0
  160. data/lib/datadog/core/metrics/client.rb +25 -16
  161. data/lib/datadog/core/metrics/ext.rb +0 -4
  162. data/lib/datadog/core/metrics/helpers.rb +0 -2
  163. data/lib/datadog/core/metrics/logging.rb +0 -2
  164. data/lib/datadog/core/metrics/metric.rb +0 -2
  165. data/lib/datadog/core/metrics/options.rb +3 -5
  166. data/lib/datadog/core/pin.rb +0 -2
  167. data/lib/datadog/core/runtime/ext.rb +3 -3
  168. data/lib/datadog/core/runtime/metrics.rb +28 -14
  169. data/lib/datadog/core/telemetry/client.rb +77 -0
  170. data/lib/datadog/core/telemetry/collector.rb +231 -0
  171. data/lib/datadog/core/telemetry/emitter.rb +46 -0
  172. data/lib/datadog/core/telemetry/event.rb +67 -0
  173. data/lib/datadog/core/telemetry/ext.rb +9 -0
  174. data/lib/datadog/core/telemetry/heartbeat.rb +35 -0
  175. data/lib/datadog/core/telemetry/http/adapters/net.rb +111 -0
  176. data/lib/datadog/core/telemetry/http/env.rb +18 -0
  177. data/lib/datadog/core/telemetry/http/ext.rb +20 -0
  178. data/lib/datadog/core/telemetry/http/response.rb +64 -0
  179. data/lib/datadog/core/telemetry/http/transport.rb +51 -0
  180. data/lib/datadog/core/telemetry/v1/app_event.rb +50 -0
  181. data/lib/datadog/core/telemetry/v1/application.rb +86 -0
  182. data/lib/datadog/core/telemetry/v1/configuration.rb +25 -0
  183. data/lib/datadog/core/telemetry/v1/dependency.rb +36 -0
  184. data/lib/datadog/core/telemetry/v1/host.rb +51 -0
  185. data/lib/datadog/core/telemetry/v1/integration.rb +58 -0
  186. data/lib/datadog/core/telemetry/v1/product.rb +28 -0
  187. data/lib/datadog/core/telemetry/v1/telemetry_request.rb +100 -0
  188. data/lib/datadog/core/utils/compression.rb +5 -3
  189. data/lib/datadog/core/utils/forking.rb +0 -2
  190. data/lib/datadog/core/utils/network.rb +140 -0
  191. data/lib/datadog/core/utils/object_set.rb +1 -3
  192. data/lib/datadog/core/utils/only_once.rb +0 -2
  193. data/lib/datadog/core/utils/safe_dup.rb +0 -2
  194. data/lib/datadog/core/utils/sequence.rb +5 -2
  195. data/lib/datadog/core/utils/string_table.rb +1 -3
  196. data/lib/datadog/core/utils/time.rb +3 -7
  197. data/lib/datadog/core/utils.rb +1 -24
  198. data/lib/datadog/core/vendor/ipaddr.rb +78 -0
  199. data/lib/datadog/core/vendor/multipart-post/multipart/post/composite_read_io.rb +0 -2
  200. data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb +2 -4
  201. data/lib/datadog/core/vendor/multipart-post/multipart/post/parts.rb +0 -2
  202. data/lib/datadog/core/vendor/multipart-post/multipart/post/version.rb +0 -2
  203. data/lib/datadog/core/vendor/multipart-post/multipart/post.rb +0 -2
  204. data/lib/datadog/core/vendor/multipart-post/multipart.rb +0 -2
  205. data/lib/datadog/core/vendor/multipart-post/net/http/post/multipart.rb +3 -5
  206. data/lib/datadog/core/worker.rb +0 -2
  207. data/lib/datadog/core/workers/async.rb +4 -6
  208. data/lib/datadog/core/workers/interval_loop.rb +0 -2
  209. data/lib/datadog/core/workers/polling.rb +2 -4
  210. data/lib/datadog/core/workers/queue.rb +0 -2
  211. data/lib/datadog/core/workers/runtime_metrics.rb +4 -9
  212. data/lib/datadog/core.rb +27 -56
  213. data/lib/datadog/kit/appsec/events.rb +74 -0
  214. data/lib/datadog/kit/enable_core_dumps.rb +50 -0
  215. data/lib/datadog/kit/identity.rb +70 -0
  216. data/lib/datadog/kit.rb +9 -0
  217. data/lib/datadog/opentelemetry/api/context.rb +186 -0
  218. data/lib/datadog/opentelemetry/api/trace/span.rb +14 -0
  219. data/lib/datadog/opentelemetry/sdk/configurator.rb +37 -0
  220. data/lib/datadog/opentelemetry/sdk/id_generator.rb +26 -0
  221. data/lib/datadog/opentelemetry/sdk/propagator.rb +90 -0
  222. data/lib/datadog/opentelemetry/sdk/span_processor.rb +91 -0
  223. data/lib/datadog/opentelemetry.rb +47 -0
  224. data/lib/datadog/opentracer/binary_propagator.rb +0 -2
  225. data/lib/datadog/opentracer/carrier.rb +0 -2
  226. data/lib/datadog/opentracer/distributed_headers.rb +7 -11
  227. data/lib/datadog/opentracer/global_tracer.rb +0 -2
  228. data/lib/datadog/opentracer/propagator.rb +0 -2
  229. data/lib/datadog/opentracer/rack_propagator.rb +10 -11
  230. data/lib/datadog/opentracer/scope.rb +0 -2
  231. data/lib/datadog/opentracer/scope_manager.rb +0 -2
  232. data/lib/datadog/opentracer/span.rb +1 -3
  233. data/lib/datadog/opentracer/span_context.rb +0 -2
  234. data/lib/datadog/opentracer/span_context_factory.rb +0 -2
  235. data/lib/datadog/opentracer/text_map_propagator.rb +13 -14
  236. data/lib/datadog/opentracer/thread_local_scope.rb +0 -2
  237. data/lib/datadog/opentracer/thread_local_scope_manager.rb +24 -3
  238. data/lib/datadog/opentracer/tracer.rb +23 -25
  239. data/lib/datadog/opentracer.rb +16 -18
  240. data/lib/datadog/profiling/backtrace_location.rb +0 -2
  241. data/lib/datadog/profiling/buffer.rb +3 -5
  242. data/lib/datadog/profiling/collectors/code_provenance.rb +1 -2
  243. data/lib/datadog/profiling/collectors/cpu_and_wall_time_worker.rb +96 -0
  244. data/lib/datadog/profiling/collectors/dynamic_sampling_rate.rb +12 -0
  245. data/lib/datadog/profiling/collectors/idle_sampling_helper.rb +66 -0
  246. data/lib/datadog/profiling/collectors/old_stack.rb +301 -0
  247. data/lib/datadog/profiling/collectors/stack.rb +3 -289
  248. data/lib/datadog/profiling/collectors/thread_context.rb +46 -0
  249. data/lib/datadog/profiling/component.rb +161 -0
  250. data/lib/datadog/profiling/encoding/profile.rb +8 -15
  251. data/lib/datadog/profiling/event.rb +0 -2
  252. data/lib/datadog/profiling/events/stack.rb +1 -3
  253. data/lib/datadog/profiling/exporter.rb +69 -11
  254. data/lib/datadog/profiling/ext/forking.rb +41 -44
  255. data/lib/datadog/profiling/ext.rb +4 -18
  256. data/lib/datadog/profiling/flush.rb +25 -58
  257. data/lib/datadog/profiling/http_transport.rb +130 -0
  258. data/lib/datadog/profiling/load_native_extension.rb +20 -0
  259. data/lib/datadog/profiling/native_extension.rb +0 -2
  260. data/lib/datadog/profiling/old_recorder.rb +107 -0
  261. data/lib/datadog/profiling/pprof/builder.rb +4 -6
  262. data/lib/datadog/profiling/pprof/converter.rb +1 -3
  263. data/lib/datadog/profiling/pprof/message_set.rb +1 -3
  264. data/lib/datadog/profiling/pprof/payload.rb +0 -2
  265. data/lib/datadog/profiling/pprof/pprof_pb.rb +0 -2
  266. data/lib/datadog/profiling/pprof/stack_sample.rb +4 -6
  267. data/lib/datadog/profiling/pprof/string_table.rb +1 -3
  268. data/lib/datadog/profiling/pprof/template.rb +5 -7
  269. data/lib/datadog/profiling/preload.rb +1 -3
  270. data/lib/datadog/profiling/profiler.rb +7 -2
  271. data/lib/datadog/profiling/scheduler.rb +29 -52
  272. data/lib/datadog/profiling/stack_recorder.rb +74 -0
  273. data/lib/datadog/profiling/tag_builder.rb +51 -0
  274. data/lib/datadog/profiling/tasks/exec.rb +2 -4
  275. data/lib/datadog/profiling/tasks/help.rb +0 -2
  276. data/lib/datadog/profiling/tasks/setup.rb +8 -15
  277. data/lib/datadog/profiling/trace_identifiers/ddtrace.rb +2 -4
  278. data/lib/datadog/profiling/trace_identifiers/helper.rb +1 -3
  279. data/lib/datadog/profiling.rb +92 -50
  280. data/lib/datadog/tracing/analytics.rb +1 -3
  281. data/lib/datadog/tracing/buffer.rb +14 -12
  282. data/lib/datadog/tracing/client_ip.rb +61 -0
  283. data/lib/datadog/tracing/component.rb +176 -0
  284. data/lib/datadog/tracing/configuration/ext.rb +49 -6
  285. data/lib/datadog/tracing/configuration/settings.rb +451 -0
  286. data/lib/datadog/tracing/context.rb +1 -3
  287. data/lib/datadog/tracing/context_provider.rb +18 -4
  288. data/lib/datadog/tracing/contrib/action_cable/configuration/settings.rb +2 -4
  289. data/lib/datadog/tracing/contrib/action_cable/event.rb +4 -7
  290. data/lib/datadog/tracing/contrib/action_cable/events/broadcast.rb +4 -6
  291. data/lib/datadog/tracing/contrib/action_cable/events/perform_action.rb +3 -5
  292. data/lib/datadog/tracing/contrib/action_cable/events/transmit.rb +4 -6
  293. data/lib/datadog/tracing/contrib/action_cable/events.rb +4 -6
  294. data/lib/datadog/tracing/contrib/action_cable/ext.rb +0 -2
  295. data/lib/datadog/tracing/contrib/action_cable/instrumentation.rb +3 -6
  296. data/lib/datadog/tracing/contrib/action_cable/integration.rb +4 -6
  297. data/lib/datadog/tracing/contrib/action_cable/patcher.rb +4 -6
  298. data/lib/datadog/tracing/contrib/action_mailer/configuration/settings.rb +2 -4
  299. data/lib/datadog/tracing/contrib/action_mailer/event.rb +3 -5
  300. data/lib/datadog/tracing/contrib/action_mailer/events/deliver.rb +3 -5
  301. data/lib/datadog/tracing/contrib/action_mailer/events/process.rb +3 -5
  302. data/lib/datadog/tracing/contrib/action_mailer/events.rb +2 -4
  303. data/lib/datadog/tracing/contrib/action_mailer/ext.rb +0 -2
  304. data/lib/datadog/tracing/contrib/action_mailer/integration.rb +4 -6
  305. data/lib/datadog/tracing/contrib/action_mailer/patcher.rb +3 -5
  306. data/lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb +10 -8
  307. data/lib/datadog/tracing/contrib/action_pack/action_controller/patcher.rb +2 -4
  308. data/lib/datadog/tracing/contrib/action_pack/configuration/settings.rb +2 -4
  309. data/lib/datadog/tracing/contrib/action_pack/ext.rb +0 -2
  310. data/lib/datadog/tracing/contrib/action_pack/integration.rb +4 -6
  311. data/lib/datadog/tracing/contrib/action_pack/patcher.rb +2 -4
  312. data/lib/datadog/tracing/contrib/action_pack/utils.rb +1 -3
  313. data/lib/datadog/tracing/contrib/action_view/configuration/settings.rb +2 -4
  314. data/lib/datadog/tracing/contrib/action_view/event.rb +1 -3
  315. data/lib/datadog/tracing/contrib/action_view/events/render_partial.rb +5 -7
  316. data/lib/datadog/tracing/contrib/action_view/events/render_template.rb +5 -7
  317. data/lib/datadog/tracing/contrib/action_view/events.rb +2 -4
  318. data/lib/datadog/tracing/contrib/action_view/ext.rb +0 -2
  319. data/lib/datadog/tracing/contrib/action_view/instrumentation/partial_renderer.rb +2 -4
  320. data/lib/datadog/tracing/contrib/action_view/instrumentation/template_renderer.rb +2 -4
  321. data/lib/datadog/tracing/contrib/action_view/integration.rb +4 -6
  322. data/lib/datadog/tracing/contrib/action_view/patcher.rb +7 -10
  323. data/lib/datadog/tracing/contrib/action_view/utils.rb +1 -3
  324. data/lib/datadog/tracing/contrib/active_job/configuration/settings.rb +3 -5
  325. data/lib/datadog/tracing/contrib/active_job/event.rb +3 -5
  326. data/lib/datadog/tracing/contrib/active_job/events/discard.rb +4 -6
  327. data/lib/datadog/tracing/contrib/active_job/events/enqueue.rb +4 -6
  328. data/lib/datadog/tracing/contrib/active_job/events/enqueue_at.rb +4 -6
  329. data/lib/datadog/tracing/contrib/active_job/events/enqueue_retry.rb +4 -6
  330. data/lib/datadog/tracing/contrib/active_job/events/perform.rb +4 -6
  331. data/lib/datadog/tracing/contrib/active_job/events/retry_stopped.rb +4 -6
  332. data/lib/datadog/tracing/contrib/active_job/events.rb +6 -8
  333. data/lib/datadog/tracing/contrib/active_job/ext.rb +0 -2
  334. data/lib/datadog/tracing/contrib/active_job/integration.rb +4 -6
  335. data/lib/datadog/tracing/contrib/active_job/log_injection.rb +0 -4
  336. data/lib/datadog/tracing/contrib/active_job/patcher.rb +4 -6
  337. data/lib/datadog/tracing/contrib/active_model_serializers/configuration/settings.rb +2 -4
  338. data/lib/datadog/tracing/contrib/active_model_serializers/event.rb +4 -7
  339. data/lib/datadog/tracing/contrib/active_model_serializers/events/render.rb +3 -5
  340. data/lib/datadog/tracing/contrib/active_model_serializers/events/serialize.rb +2 -4
  341. data/lib/datadog/tracing/contrib/active_model_serializers/events.rb +2 -4
  342. data/lib/datadog/tracing/contrib/active_model_serializers/ext.rb +0 -2
  343. data/lib/datadog/tracing/contrib/active_model_serializers/integration.rb +3 -5
  344. data/lib/datadog/tracing/contrib/active_model_serializers/patcher.rb +3 -6
  345. data/lib/datadog/tracing/contrib/active_record/configuration/makara_resolver.rb +0 -2
  346. data/lib/datadog/tracing/contrib/active_record/configuration/resolver.rb +4 -6
  347. data/lib/datadog/tracing/contrib/active_record/configuration/settings.rb +3 -5
  348. data/lib/datadog/tracing/contrib/active_record/event.rb +1 -3
  349. data/lib/datadog/tracing/contrib/active_record/events/instantiation.rb +4 -6
  350. data/lib/datadog/tracing/contrib/active_record/events/sql.rb +6 -8
  351. data/lib/datadog/tracing/contrib/active_record/events.rb +2 -4
  352. data/lib/datadog/tracing/contrib/active_record/ext.rb +0 -2
  353. data/lib/datadog/tracing/contrib/active_record/integration.rb +6 -8
  354. data/lib/datadog/tracing/contrib/active_record/patcher.rb +2 -4
  355. data/lib/datadog/tracing/contrib/active_record/utils.rb +3 -5
  356. data/lib/datadog/tracing/contrib/active_record/vendor/connection_specification.rb +1 -3
  357. data/lib/datadog/tracing/contrib/active_support/cache/instrumentation.rb +19 -11
  358. data/lib/datadog/tracing/contrib/active_support/cache/patcher.rb +2 -4
  359. data/lib/datadog/tracing/contrib/active_support/cache/redis.rb +1 -3
  360. data/lib/datadog/tracing/contrib/active_support/configuration/settings.rb +2 -4
  361. data/lib/datadog/tracing/contrib/active_support/ext.rb +0 -2
  362. data/lib/datadog/tracing/contrib/active_support/integration.rb +5 -7
  363. data/lib/datadog/tracing/contrib/active_support/notifications/event.rb +1 -3
  364. data/lib/datadog/tracing/contrib/active_support/notifications/subscriber.rb +1 -3
  365. data/lib/datadog/tracing/contrib/active_support/notifications/subscription.rb +4 -4
  366. data/lib/datadog/tracing/contrib/active_support/patcher.rb +2 -4
  367. data/lib/datadog/tracing/contrib/analytics.rb +1 -3
  368. data/lib/datadog/tracing/contrib/auto_instrument.rb +4 -6
  369. data/lib/datadog/tracing/contrib/aws/configuration/settings.rb +6 -5
  370. data/lib/datadog/tracing/contrib/aws/ext.rb +1 -2
  371. data/lib/datadog/tracing/contrib/aws/instrumentation.rb +5 -6
  372. data/lib/datadog/tracing/contrib/aws/integration.rb +3 -5
  373. data/lib/datadog/tracing/contrib/aws/parsed_context.rb +0 -2
  374. data/lib/datadog/tracing/contrib/aws/patcher.rb +5 -7
  375. data/lib/datadog/tracing/contrib/aws/services.rb +0 -4
  376. data/lib/datadog/tracing/contrib/concurrent_ruby/configuration/settings.rb +2 -4
  377. data/lib/datadog/tracing/contrib/concurrent_ruby/context_composite_executor_service.rb +10 -5
  378. data/lib/datadog/tracing/contrib/concurrent_ruby/ext.rb +0 -2
  379. data/lib/datadog/tracing/contrib/concurrent_ruby/future_patch.rb +1 -3
  380. data/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb +3 -5
  381. data/lib/datadog/tracing/contrib/concurrent_ruby/patcher.rb +2 -5
  382. data/lib/datadog/tracing/contrib/configurable.rb +2 -4
  383. data/lib/datadog/tracing/contrib/configuration/resolver.rb +0 -2
  384. data/lib/datadog/tracing/contrib/configuration/resolvers/pattern_resolver.rb +1 -3
  385. data/lib/datadog/tracing/contrib/configuration/settings.rb +2 -6
  386. data/lib/datadog/tracing/contrib/dalli/configuration/settings.rb +6 -5
  387. data/lib/datadog/tracing/contrib/dalli/ext.rb +2 -2
  388. data/lib/datadog/tracing/contrib/dalli/instrumentation.rb +10 -7
  389. data/lib/datadog/tracing/contrib/dalli/integration.rb +3 -5
  390. data/lib/datadog/tracing/contrib/dalli/patcher.rb +3 -6
  391. data/lib/datadog/tracing/contrib/dalli/quantize.rb +1 -3
  392. data/lib/datadog/tracing/contrib/delayed_job/configuration/settings.rb +3 -5
  393. data/lib/datadog/tracing/contrib/delayed_job/ext.rb +2 -2
  394. data/lib/datadog/tracing/contrib/delayed_job/integration.rb +3 -5
  395. data/lib/datadog/tracing/contrib/delayed_job/patcher.rb +8 -5
  396. data/lib/datadog/tracing/contrib/delayed_job/plugin.rb +11 -6
  397. data/lib/datadog/tracing/contrib/delayed_job/server_internal_tracer/worker.rb +32 -0
  398. data/lib/datadog/tracing/contrib/elasticsearch/configuration/settings.rb +7 -5
  399. data/lib/datadog/tracing/contrib/elasticsearch/ext.rb +3 -2
  400. data/lib/datadog/tracing/contrib/elasticsearch/integration.rb +12 -8
  401. data/lib/datadog/tracing/contrib/elasticsearch/patcher.rb +48 -11
  402. data/lib/datadog/tracing/contrib/elasticsearch/quantize.rb +1 -5
  403. data/lib/datadog/tracing/contrib/ethon/configuration/settings.rb +8 -5
  404. data/lib/datadog/tracing/contrib/ethon/easy_patch.rb +6 -9
  405. data/lib/datadog/tracing/contrib/ethon/ext.rb +1 -2
  406. data/lib/datadog/tracing/contrib/ethon/integration.rb +4 -6
  407. data/lib/datadog/tracing/contrib/ethon/multi_patch.rb +5 -6
  408. data/lib/datadog/tracing/contrib/ethon/patcher.rb +3 -7
  409. data/lib/datadog/tracing/contrib/excon/configuration/settings.rb +7 -5
  410. data/lib/datadog/tracing/contrib/excon/ext.rb +1 -2
  411. data/lib/datadog/tracing/contrib/excon/integration.rb +4 -6
  412. data/lib/datadog/tracing/contrib/excon/middleware.rb +8 -9
  413. data/lib/datadog/tracing/contrib/excon/patcher.rb +2 -4
  414. data/lib/datadog/tracing/contrib/ext.rb +30 -0
  415. data/lib/datadog/tracing/contrib/extensions.rb +5 -7
  416. data/lib/datadog/tracing/contrib/faraday/configuration/settings.rb +7 -5
  417. data/lib/datadog/tracing/contrib/faraday/connection.rb +0 -2
  418. data/lib/datadog/tracing/contrib/faraday/ext.rb +1 -2
  419. data/lib/datadog/tracing/contrib/faraday/integration.rb +4 -6
  420. data/lib/datadog/tracing/contrib/faraday/middleware.rb +8 -10
  421. data/lib/datadog/tracing/contrib/faraday/patcher.rb +5 -8
  422. data/lib/datadog/tracing/contrib/faraday/rack_builder.rb +0 -2
  423. data/lib/datadog/tracing/contrib/grape/configuration/settings.rb +3 -5
  424. data/lib/datadog/tracing/contrib/grape/endpoint.rb +4 -9
  425. data/lib/datadog/tracing/contrib/grape/ext.rb +0 -2
  426. data/lib/datadog/tracing/contrib/grape/instrumentation.rb +0 -2
  427. data/lib/datadog/tracing/contrib/grape/integration.rb +3 -5
  428. data/lib/datadog/tracing/contrib/grape/patcher.rb +4 -7
  429. data/lib/datadog/tracing/contrib/graphql/configuration/settings.rb +3 -5
  430. data/lib/datadog/tracing/contrib/graphql/ext.rb +0 -2
  431. data/lib/datadog/tracing/contrib/graphql/integration.rb +3 -5
  432. data/lib/datadog/tracing/contrib/graphql/patcher.rb +2 -6
  433. data/lib/datadog/tracing/contrib/grpc/configuration/settings.rb +10 -6
  434. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/client.rb +20 -7
  435. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/server.rb +17 -19
  436. data/lib/datadog/tracing/contrib/grpc/datadog_interceptor.rb +7 -6
  437. data/lib/datadog/tracing/contrib/grpc/distributed/fetcher.rb +26 -0
  438. data/lib/datadog/tracing/contrib/grpc/distributed/propagation.rb +42 -0
  439. data/lib/datadog/tracing/contrib/grpc/ext.rb +4 -2
  440. data/lib/datadog/tracing/contrib/grpc/integration.rb +11 -6
  441. data/lib/datadog/tracing/contrib/grpc/intercept_with_datadog.rb +0 -2
  442. data/lib/datadog/tracing/contrib/grpc/patcher.rb +3 -9
  443. data/lib/datadog/tracing/contrib/hanami/action_tracer.rb +45 -0
  444. data/lib/datadog/tracing/contrib/hanami/configuration/settings.rb +20 -0
  445. data/lib/datadog/tracing/contrib/hanami/ext.rb +22 -0
  446. data/lib/datadog/tracing/contrib/hanami/integration.rb +42 -0
  447. data/lib/datadog/tracing/contrib/hanami/patcher.rb +31 -0
  448. data/lib/datadog/tracing/contrib/hanami/plugin.rb +21 -0
  449. data/lib/datadog/tracing/contrib/hanami/renderer_policy_tracing.rb +39 -0
  450. data/lib/datadog/tracing/contrib/hanami/router_tracing.rb +42 -0
  451. data/lib/datadog/tracing/contrib/http/circuit_breaker.rb +1 -4
  452. data/lib/datadog/tracing/contrib/http/configuration/settings.rb +13 -5
  453. data/lib/datadog/tracing/contrib/http/distributed/fetcher.rb +38 -0
  454. data/lib/datadog/tracing/contrib/http/distributed/propagation.rb +37 -0
  455. data/lib/datadog/tracing/contrib/http/ext.rb +2 -2
  456. data/lib/datadog/tracing/contrib/http/instrumentation.rb +8 -12
  457. data/lib/datadog/tracing/contrib/http/integration.rb +6 -8
  458. data/lib/datadog/tracing/contrib/http/patcher.rb +3 -5
  459. data/lib/datadog/tracing/contrib/http_annotation_helper.rb +0 -2
  460. data/lib/datadog/tracing/contrib/httpclient/configuration/settings.rb +13 -5
  461. data/lib/datadog/tracing/contrib/httpclient/ext.rb +2 -2
  462. data/lib/datadog/tracing/contrib/httpclient/instrumentation.rb +9 -11
  463. data/lib/datadog/tracing/contrib/httpclient/integration.rb +4 -6
  464. data/lib/datadog/tracing/contrib/httpclient/patcher.rb +3 -5
  465. data/lib/datadog/tracing/contrib/httprb/configuration/settings.rb +13 -5
  466. data/lib/datadog/tracing/contrib/httprb/ext.rb +2 -2
  467. data/lib/datadog/tracing/contrib/httprb/instrumentation.rb +9 -11
  468. data/lib/datadog/tracing/contrib/httprb/integration.rb +4 -6
  469. data/lib/datadog/tracing/contrib/httprb/patcher.rb +3 -5
  470. data/lib/datadog/tracing/contrib/integration.rb +3 -5
  471. data/lib/datadog/tracing/contrib/kafka/configuration/settings.rb +2 -4
  472. data/lib/datadog/tracing/contrib/kafka/consumer_event.rb +1 -2
  473. data/lib/datadog/tracing/contrib/kafka/consumer_group_event.rb +0 -2
  474. data/lib/datadog/tracing/contrib/kafka/event.rb +4 -5
  475. data/lib/datadog/tracing/contrib/kafka/events/connection/request.rb +2 -4
  476. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_batch.rb +3 -5
  477. data/lib/datadog/tracing/contrib/kafka/events/consumer/process_message.rb +3 -5
  478. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/heartbeat.rb +4 -6
  479. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/join_group.rb +4 -6
  480. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/leave_group.rb +4 -6
  481. data/lib/datadog/tracing/contrib/kafka/events/consumer_group/sync_group.rb +4 -6
  482. data/lib/datadog/tracing/contrib/kafka/events/produce_operation/send_messages.rb +3 -4
  483. data/lib/datadog/tracing/contrib/kafka/events/producer/deliver_messages.rb +3 -4
  484. data/lib/datadog/tracing/contrib/kafka/events.rb +9 -11
  485. data/lib/datadog/tracing/contrib/kafka/ext.rb +1 -2
  486. data/lib/datadog/tracing/contrib/kafka/integration.rb +3 -5
  487. data/lib/datadog/tracing/contrib/kafka/patcher.rb +3 -6
  488. data/lib/datadog/tracing/contrib/lograge/configuration/settings.rb +2 -4
  489. data/lib/datadog/tracing/contrib/lograge/ext.rb +0 -2
  490. data/lib/datadog/tracing/contrib/lograge/instrumentation.rb +2 -4
  491. data/lib/datadog/tracing/contrib/lograge/integration.rb +3 -5
  492. data/lib/datadog/tracing/contrib/lograge/patcher.rb +2 -4
  493. data/lib/datadog/tracing/contrib/mongodb/configuration/settings.rb +7 -5
  494. data/lib/datadog/tracing/contrib/mongodb/ext.rb +8 -2
  495. data/lib/datadog/tracing/contrib/mongodb/instrumentation.rb +3 -5
  496. data/lib/datadog/tracing/contrib/mongodb/integration.rb +4 -6
  497. data/lib/datadog/tracing/contrib/mongodb/parsers.rb +1 -3
  498. data/lib/datadog/tracing/contrib/mongodb/patcher.rb +3 -5
  499. data/lib/datadog/tracing/contrib/mongodb/subscribers.rb +10 -6
  500. data/lib/datadog/tracing/contrib/mysql2/configuration/settings.rb +17 -4
  501. data/lib/datadog/tracing/contrib/mysql2/ext.rb +2 -2
  502. data/lib/datadog/tracing/contrib/mysql2/instrumentation.rb +20 -7
  503. data/lib/datadog/tracing/contrib/mysql2/integration.rb +3 -5
  504. data/lib/datadog/tracing/contrib/mysql2/patcher.rb +2 -4
  505. data/lib/datadog/tracing/contrib/patchable.rb +0 -2
  506. data/lib/datadog/tracing/contrib/patcher.rb +16 -6
  507. data/lib/datadog/tracing/contrib/pg/configuration/settings.rb +48 -0
  508. data/lib/datadog/tracing/contrib/pg/ext.rb +31 -0
  509. data/lib/datadog/tracing/contrib/pg/instrumentation.rb +166 -0
  510. data/lib/datadog/tracing/contrib/pg/integration.rb +41 -0
  511. data/lib/datadog/tracing/contrib/pg/patcher.rb +29 -0
  512. data/lib/datadog/tracing/contrib/presto/configuration/settings.rb +6 -5
  513. data/lib/datadog/tracing/contrib/presto/ext.rb +2 -2
  514. data/lib/datadog/tracing/contrib/presto/instrumentation.rb +5 -5
  515. data/lib/datadog/tracing/contrib/presto/integration.rb +3 -5
  516. data/lib/datadog/tracing/contrib/presto/patcher.rb +4 -6
  517. data/lib/datadog/tracing/contrib/propagation/sql_comment/comment.rb +41 -0
  518. data/lib/datadog/tracing/contrib/propagation/sql_comment/ext.rb +31 -0
  519. data/lib/datadog/tracing/contrib/propagation/sql_comment/mode.rb +26 -0
  520. data/lib/datadog/tracing/contrib/propagation/sql_comment.rb +45 -0
  521. data/lib/datadog/tracing/contrib/qless/configuration/settings.rb +2 -4
  522. data/lib/datadog/tracing/contrib/qless/ext.rb +0 -2
  523. data/lib/datadog/tracing/contrib/qless/integration.rb +3 -5
  524. data/lib/datadog/tracing/contrib/qless/patcher.rb +1 -6
  525. data/lib/datadog/tracing/contrib/qless/qless_job.rb +5 -5
  526. data/lib/datadog/tracing/contrib/qless/tracer_cleaner.rb +0 -4
  527. data/lib/datadog/tracing/contrib/que/configuration/settings.rb +3 -5
  528. data/lib/datadog/tracing/contrib/que/ext.rb +0 -2
  529. data/lib/datadog/tracing/contrib/que/integration.rb +4 -6
  530. data/lib/datadog/tracing/contrib/que/patcher.rb +1 -4
  531. data/lib/datadog/tracing/contrib/que/tracer.rb +5 -3
  532. data/lib/datadog/tracing/contrib/racecar/configuration/settings.rb +2 -4
  533. data/lib/datadog/tracing/contrib/racecar/event.rb +5 -7
  534. data/lib/datadog/tracing/contrib/racecar/events/batch.rb +6 -5
  535. data/lib/datadog/tracing/contrib/racecar/events/consume.rb +2 -4
  536. data/lib/datadog/tracing/contrib/racecar/events/message.rb +6 -5
  537. data/lib/datadog/tracing/contrib/racecar/events.rb +3 -5
  538. data/lib/datadog/tracing/contrib/racecar/ext.rb +1 -2
  539. data/lib/datadog/tracing/contrib/racecar/integration.rb +3 -5
  540. data/lib/datadog/tracing/contrib/racecar/patcher.rb +3 -6
  541. data/lib/datadog/tracing/contrib/rack/configuration/settings.rb +2 -4
  542. data/lib/datadog/tracing/contrib/rack/ext.rb +5 -2
  543. data/lib/datadog/tracing/contrib/rack/header_collection.rb +35 -0
  544. data/lib/datadog/tracing/contrib/rack/integration.rb +4 -6
  545. data/lib/datadog/tracing/contrib/rack/middlewares.rb +170 -78
  546. data/lib/datadog/tracing/contrib/rack/patcher.rb +12 -4
  547. data/lib/datadog/tracing/contrib/rack/request_queue.rb +0 -2
  548. data/lib/datadog/tracing/contrib/rails/auto_instrument_railtie.rb +1 -3
  549. data/lib/datadog/tracing/contrib/rails/configuration/settings.rb +4 -3
  550. data/lib/datadog/tracing/contrib/rails/ext.rb +0 -2
  551. data/lib/datadog/tracing/contrib/rails/framework.rb +18 -24
  552. data/lib/datadog/tracing/contrib/rails/integration.rb +4 -6
  553. data/lib/datadog/tracing/contrib/rails/log_injection.rb +3 -20
  554. data/lib/datadog/tracing/contrib/rails/middlewares.rb +1 -4
  555. data/lib/datadog/tracing/contrib/rails/patcher.rb +7 -10
  556. data/lib/datadog/tracing/contrib/rails/railtie.rb +3 -5
  557. data/lib/datadog/tracing/contrib/rails/utils.rb +1 -3
  558. data/lib/datadog/tracing/contrib/rake/configuration/settings.rb +16 -3
  559. data/lib/datadog/tracing/contrib/rake/ext.rb +0 -2
  560. data/lib/datadog/tracing/contrib/rake/instrumentation.rb +14 -11
  561. data/lib/datadog/tracing/contrib/rake/integration.rb +3 -5
  562. data/lib/datadog/tracing/contrib/rake/patcher.rb +3 -7
  563. data/lib/datadog/tracing/contrib/redis/configuration/resolver.rb +1 -3
  564. data/lib/datadog/tracing/contrib/redis/configuration/settings.rb +6 -5
  565. data/lib/datadog/tracing/contrib/redis/ext.rb +3 -2
  566. data/lib/datadog/tracing/contrib/redis/instrumentation.rb +36 -28
  567. data/lib/datadog/tracing/contrib/redis/integration.rb +37 -6
  568. data/lib/datadog/tracing/contrib/redis/patcher.rb +56 -15
  569. data/lib/datadog/tracing/contrib/redis/quantize.rb +11 -10
  570. data/lib/datadog/tracing/contrib/redis/tags.rb +12 -12
  571. data/lib/datadog/tracing/contrib/redis/trace_middleware.rb +70 -0
  572. data/lib/datadog/tracing/contrib/redis/vendor/resolver.rb +0 -2
  573. data/lib/datadog/tracing/contrib/registerable.rb +0 -2
  574. data/lib/datadog/tracing/contrib/registry.rb +0 -2
  575. data/lib/datadog/tracing/contrib/resque/configuration/settings.rb +3 -5
  576. data/lib/datadog/tracing/contrib/resque/ext.rb +0 -2
  577. data/lib/datadog/tracing/contrib/resque/integration.rb +3 -5
  578. data/lib/datadog/tracing/contrib/resque/patcher.rb +2 -5
  579. data/lib/datadog/tracing/contrib/resque/resque_job.rb +7 -6
  580. data/lib/datadog/tracing/contrib/rest_client/configuration/settings.rb +9 -5
  581. data/lib/datadog/tracing/contrib/rest_client/ext.rb +1 -2
  582. data/lib/datadog/tracing/contrib/rest_client/integration.rb +3 -5
  583. data/lib/datadog/tracing/contrib/rest_client/patcher.rb +2 -6
  584. data/lib/datadog/tracing/contrib/rest_client/request_patch.rb +7 -8
  585. data/lib/datadog/tracing/contrib/semantic_logger/configuration/settings.rb +2 -4
  586. data/lib/datadog/tracing/contrib/semantic_logger/ext.rb +0 -2
  587. data/lib/datadog/tracing/contrib/semantic_logger/instrumentation.rb +2 -4
  588. data/lib/datadog/tracing/contrib/semantic_logger/integration.rb +3 -5
  589. data/lib/datadog/tracing/contrib/semantic_logger/patcher.rb +2 -4
  590. data/lib/datadog/tracing/contrib/sequel/configuration/settings.rb +2 -4
  591. data/lib/datadog/tracing/contrib/sequel/database.rb +4 -7
  592. data/lib/datadog/tracing/contrib/sequel/dataset.rb +4 -7
  593. data/lib/datadog/tracing/contrib/sequel/ext.rb +0 -2
  594. data/lib/datadog/tracing/contrib/sequel/integration.rb +3 -5
  595. data/lib/datadog/tracing/contrib/sequel/patcher.rb +3 -5
  596. data/lib/datadog/tracing/contrib/sequel/utils.rb +2 -4
  597. data/lib/datadog/tracing/contrib/shoryuken/configuration/settings.rb +3 -5
  598. data/lib/datadog/tracing/contrib/shoryuken/ext.rb +1 -2
  599. data/lib/datadog/tracing/contrib/shoryuken/integration.rb +4 -6
  600. data/lib/datadog/tracing/contrib/shoryuken/patcher.rb +1 -3
  601. data/lib/datadog/tracing/contrib/shoryuken/tracer.rb +5 -3
  602. data/lib/datadog/tracing/contrib/sidekiq/client_tracer.rb +11 -7
  603. data/lib/datadog/tracing/contrib/sidekiq/configuration/settings.rb +4 -5
  604. data/lib/datadog/tracing/contrib/sidekiq/ext.rb +6 -2
  605. data/lib/datadog/tracing/contrib/sidekiq/integration.rb +3 -5
  606. data/lib/datadog/tracing/contrib/sidekiq/patcher.rb +14 -9
  607. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/heartbeat.rb +23 -3
  608. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/job_fetch.rb +2 -2
  609. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/{scheduled_push.rb → redis_info.rb} +7 -8
  610. data/lib/datadog/tracing/contrib/sidekiq/server_internal_tracer/scheduled_poller.rb +55 -0
  611. data/lib/datadog/tracing/contrib/sidekiq/server_tracer.rb +31 -8
  612. data/lib/datadog/tracing/contrib/sidekiq/tracing.rb +2 -4
  613. data/lib/datadog/tracing/contrib/sinatra/configuration/settings.rb +2 -4
  614. data/lib/datadog/tracing/contrib/sinatra/env.rb +14 -27
  615. data/lib/datadog/tracing/contrib/sinatra/ext.rb +7 -5
  616. data/lib/datadog/tracing/contrib/sinatra/framework.rb +11 -4
  617. data/lib/datadog/tracing/contrib/sinatra/headers.rb +1 -3
  618. data/lib/datadog/tracing/contrib/sinatra/integration.rb +3 -5
  619. data/lib/datadog/tracing/contrib/sinatra/patcher.rb +6 -10
  620. data/lib/datadog/tracing/contrib/sinatra/tracer.rb +15 -90
  621. data/lib/datadog/tracing/contrib/sinatra/tracer_middleware.rb +20 -18
  622. data/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb +2 -4
  623. data/lib/datadog/tracing/contrib/sneakers/ext.rb +1 -2
  624. data/lib/datadog/tracing/contrib/sneakers/integration.rb +4 -6
  625. data/lib/datadog/tracing/contrib/sneakers/patcher.rb +2 -5
  626. data/lib/datadog/tracing/contrib/sneakers/tracer.rb +7 -5
  627. data/lib/datadog/tracing/contrib/status_code_matcher.rb +2 -4
  628. data/lib/datadog/tracing/contrib/stripe/configuration/settings.rb +33 -0
  629. data/lib/datadog/tracing/contrib/stripe/ext.rb +26 -0
  630. data/lib/datadog/tracing/contrib/stripe/integration.rb +43 -0
  631. data/lib/datadog/tracing/contrib/stripe/patcher.rb +28 -0
  632. data/lib/datadog/tracing/contrib/stripe/request.rb +67 -0
  633. data/lib/datadog/tracing/contrib/sucker_punch/configuration/settings.rb +2 -4
  634. data/lib/datadog/tracing/contrib/sucker_punch/exception_handler.rb +0 -2
  635. data/lib/datadog/tracing/contrib/sucker_punch/ext.rb +0 -2
  636. data/lib/datadog/tracing/contrib/sucker_punch/instrumentation.rb +3 -6
  637. data/lib/datadog/tracing/contrib/sucker_punch/integration.rb +3 -5
  638. data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb +4 -9
  639. data/lib/datadog/tracing/contrib/utils/database.rb +0 -2
  640. data/lib/datadog/tracing/contrib/utils/quantization/hash.rb +0 -2
  641. data/lib/datadog/tracing/contrib/utils/quantization/http.rb +92 -14
  642. data/lib/datadog/tracing/contrib.rb +50 -49
  643. data/lib/datadog/tracing/correlation.rb +16 -4
  644. data/lib/datadog/{core → tracing}/diagnostics/ext.rb +1 -8
  645. data/lib/datadog/tracing/diagnostics/health.rb +38 -0
  646. data/lib/datadog/tracing/distributed/b3_multi.rb +72 -0
  647. data/lib/datadog/tracing/distributed/b3_single.rb +68 -0
  648. data/lib/datadog/tracing/distributed/datadog.rb +200 -0
  649. data/lib/datadog/tracing/distributed/datadog_tags_codec.rb +84 -0
  650. data/lib/datadog/tracing/distributed/fetcher.rb +21 -0
  651. data/lib/datadog/tracing/distributed/headers/ext.rb +19 -16
  652. data/lib/datadog/tracing/distributed/helpers.rb +34 -13
  653. data/lib/datadog/tracing/distributed/none.rb +18 -0
  654. data/lib/datadog/tracing/distributed/propagation.rb +126 -0
  655. data/lib/datadog/tracing/distributed/trace_context.rb +373 -0
  656. data/lib/datadog/tracing/event.rb +3 -4
  657. data/lib/datadog/tracing/flush.rb +57 -37
  658. data/lib/datadog/tracing/metadata/analytics.rb +2 -4
  659. data/lib/datadog/tracing/metadata/errors.rb +2 -4
  660. data/lib/datadog/tracing/metadata/ext.rb +34 -3
  661. data/lib/datadog/tracing/metadata/tagging.rb +23 -4
  662. data/lib/datadog/tracing/metadata.rb +3 -5
  663. data/lib/datadog/tracing/pipeline/span_filter.rb +10 -8
  664. data/lib/datadog/tracing/pipeline/span_processor.rb +0 -2
  665. data/lib/datadog/tracing/pipeline.rb +3 -5
  666. data/lib/datadog/tracing/propagation/http.rb +3 -100
  667. data/lib/datadog/tracing/runtime/metrics.rb +1 -3
  668. data/lib/datadog/tracing/sampling/all_sampler.rb +1 -3
  669. data/lib/datadog/tracing/sampling/ext.rb +30 -1
  670. data/lib/datadog/tracing/sampling/matcher.rb +0 -2
  671. data/lib/datadog/tracing/sampling/priority_sampler.rb +64 -14
  672. data/lib/datadog/tracing/sampling/rate_by_key_sampler.rb +10 -13
  673. data/lib/datadog/tracing/sampling/rate_by_service_sampler.rb +32 -10
  674. data/lib/datadog/tracing/sampling/rate_limiter.rb +4 -3
  675. data/lib/datadog/tracing/sampling/rate_sampler.rb +27 -12
  676. data/lib/datadog/tracing/sampling/rule.rb +15 -11
  677. data/lib/datadog/tracing/sampling/rule_sampler.rb +11 -14
  678. data/lib/datadog/tracing/sampling/sampler.rb +0 -2
  679. data/lib/datadog/tracing/sampling/span/ext.rb +25 -0
  680. data/lib/datadog/tracing/sampling/span/matcher.rb +89 -0
  681. data/lib/datadog/tracing/sampling/span/rule.rb +82 -0
  682. data/lib/datadog/tracing/sampling/span/rule_parser.rb +104 -0
  683. data/lib/datadog/tracing/sampling/span/sampler.rb +75 -0
  684. data/lib/datadog/tracing/span.rb +24 -22
  685. data/lib/datadog/tracing/span_operation.rb +15 -18
  686. data/lib/datadog/tracing/sync_writer.rb +5 -7
  687. data/lib/datadog/tracing/trace_digest.rb +88 -4
  688. data/lib/datadog/tracing/trace_operation.rb +60 -18
  689. data/lib/datadog/tracing/trace_segment.rb +20 -10
  690. data/lib/datadog/tracing/tracer.rb +49 -23
  691. data/lib/datadog/tracing/utils.rb +81 -0
  692. data/lib/datadog/tracing/workers/trace_writer.rb +9 -11
  693. data/lib/datadog/tracing/workers.rb +3 -5
  694. data/lib/datadog/tracing/writer.rb +12 -7
  695. data/lib/datadog/tracing.rb +8 -10
  696. data/lib/ddtrace/auto_instrument.rb +9 -4
  697. data/lib/ddtrace/auto_instrument_base.rb +0 -2
  698. data/lib/ddtrace/profiling/preload.rb +0 -2
  699. data/lib/ddtrace/transport/ext.rb +7 -3
  700. data/lib/ddtrace/transport/http/adapters/net.rb +3 -4
  701. data/lib/ddtrace/transport/http/adapters/registry.rb +0 -2
  702. data/lib/ddtrace/transport/http/adapters/test.rb +1 -3
  703. data/lib/ddtrace/transport/http/adapters/unix_socket.rb +2 -4
  704. data/lib/ddtrace/transport/http/api/endpoint.rb +0 -2
  705. data/lib/ddtrace/transport/http/api/fallbacks.rb +0 -2
  706. data/lib/ddtrace/transport/http/api/instance.rb +0 -2
  707. data/lib/ddtrace/transport/http/api/map.rb +1 -3
  708. data/lib/ddtrace/transport/http/api/spec.rb +0 -2
  709. data/lib/ddtrace/transport/http/api.rb +4 -6
  710. data/lib/ddtrace/transport/http/builder.rb +5 -7
  711. data/lib/ddtrace/transport/http/client.rb +4 -5
  712. data/lib/ddtrace/transport/http/env.rb +0 -2
  713. data/lib/ddtrace/transport/http/response.rb +35 -7
  714. data/lib/ddtrace/transport/http/statistics.rb +1 -3
  715. data/lib/ddtrace/transport/http/traces.rb +6 -8
  716. data/lib/ddtrace/transport/http.rb +11 -12
  717. data/lib/ddtrace/transport/io/client.rb +5 -5
  718. data/lib/ddtrace/transport/io/response.rb +1 -3
  719. data/lib/ddtrace/transport/io/traces.rb +3 -7
  720. data/lib/ddtrace/transport/io.rb +3 -5
  721. data/lib/ddtrace/transport/parcel.rb +0 -4
  722. data/lib/ddtrace/transport/request.rb +0 -2
  723. data/lib/ddtrace/transport/response.rb +0 -2
  724. data/lib/ddtrace/transport/serializable_trace.rb +9 -5
  725. data/lib/ddtrace/transport/statistics.rb +2 -4
  726. data/lib/ddtrace/transport/trace_formatter.rb +21 -12
  727. data/lib/ddtrace/transport/traces.rb +9 -9
  728. data/lib/ddtrace/version.rb +2 -4
  729. data/lib/ddtrace.rb +6 -9
  730. metadata +176 -47
  731. data/.editorconfig +0 -22
  732. data/.gitignore +0 -70
  733. data/CONTRIBUTING.md +0 -81
  734. data/ddtrace.gemspec +0 -59
  735. data/docs/0.x-trace.png +0 -0
  736. data/docs/1.0-trace.png +0 -0
  737. data/docs/AutoInstrumentation.md +0 -36
  738. data/docs/Deprecation.md +0 -8
  739. data/docs/DevelopmentGuide.md +0 -259
  740. data/docs/GettingStarted.md +0 -2671
  741. data/docs/ProfilingDevelopment.md +0 -110
  742. data/docs/PublicApi.md +0 -14
  743. data/docs/UpgradeGuide.md +0 -736
  744. data/lib/datadog/appsec/assets/waf_rules/risky.json +0 -1499
  745. data/lib/datadog/appsec/contrib/rack/request.rb +0 -52
  746. data/lib/datadog/appsec/contrib/rack/response.rb +0 -24
  747. data/lib/datadog/profiling/recorder.rb +0 -117
  748. data/lib/datadog/profiling/transport/client.rb +0 -16
  749. data/lib/datadog/profiling/transport/http/api/endpoint.rb +0 -107
  750. data/lib/datadog/profiling/transport/http/api/instance.rb +0 -38
  751. data/lib/datadog/profiling/transport/http/api/spec.rb +0 -42
  752. data/lib/datadog/profiling/transport/http/api.rb +0 -45
  753. data/lib/datadog/profiling/transport/http/builder.rb +0 -30
  754. data/lib/datadog/profiling/transport/http/client.rb +0 -35
  755. data/lib/datadog/profiling/transport/http/response.rb +0 -23
  756. data/lib/datadog/profiling/transport/http.rb +0 -112
  757. data/lib/datadog/profiling/transport/io/client.rb +0 -29
  758. data/lib/datadog/profiling/transport/io/response.rb +0 -18
  759. data/lib/datadog/profiling/transport/io.rb +0 -32
  760. data/lib/datadog/profiling/transport/parcel.rb +0 -19
  761. data/lib/datadog/profiling/transport/request.rb +0 -17
  762. data/lib/datadog/profiling/transport/response.rb +0 -10
  763. data/lib/datadog/tracing/distributed/headers/b3.rb +0 -55
  764. data/lib/datadog/tracing/distributed/headers/b3_single.rb +0 -67
  765. data/lib/datadog/tracing/distributed/headers/datadog.rb +0 -52
  766. data/lib/datadog/tracing/distributed/parser.rb +0 -70
  767. data/lib/datadog/tracing/propagation/grpc.rb +0 -88
@@ -1,2671 +0,0 @@
1
- ***Version 1.0.0 is in beta! Check out our [upgrade guide](https://github.com/DataDog/dd-trace-rb/blob/master/docs/UpgradeGuide.md#from-0x-to-10) for more details.***
2
-
3
- # Datadog Ruby Trace Client
4
-
5
- `ddtrace` is Datadog’s tracing client for Ruby. It is used to trace requests as they flow across web servers,
6
- databases and microservices so that developers have high visibility into bottlenecks and troublesome requests.
7
-
8
- ## Getting started
9
-
10
- For the general APM documentation, see our [setup documentation][setup docs].
11
-
12
- For more information about what APM looks like once your application is sending information to Datadog, take a look at [Visualizing your APM data][visualization docs].
13
-
14
- For the library API documentation, see our [YARD documentation][yard docs].
15
-
16
- To contribute, check out the [contribution guidelines][contribution docs] and [development guide][development docs].
17
-
18
- [setup docs]: https://docs.datadoghq.com/tracing/
19
- [development docs]: https://github.com/DataDog/dd-trace-rb/blob/master/README.md#development
20
- [visualization docs]: https://docs.datadoghq.com/tracing/visualization/
21
- [contribution docs]: https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md
22
- [development docs]: https://github.com/DataDog/dd-trace-rb/blob/master/docs/DevelopmentGuide.md
23
- [yard docs]: https://www.rubydoc.info/gems/ddtrace/
24
-
25
- ## Table of Contents
26
-
27
- - [Compatibility](#compatibility)
28
- - [Installation](#installation)
29
- - [Setup the Datadog Agent for tracing](#setup-the-datadog-agent-for-tracing)
30
- - [Instrument your application](#instrument-your-application)
31
- - [Rails applications](#rails-applications)
32
- - [Ruby applications](#ruby-applications)
33
- - [Configuring OpenTracing](#configuring-opentracing)
34
- - [Configuring OpenTelemetry](#configuring-opentelemetry)
35
- - [Connect your application to the Datadog Agent](#connect-your-application-to-the-datadog-agent)
36
- - [Manual instrumentation](#manual-instrumentation)
37
- - [Integration instrumentation](#integration-instrumentation)
38
- - [Action Cable](#action-cable)
39
- - [Action Mailer](#action-mailer)
40
- - [Action Pack](#action-pack)
41
- - [Action View](#action-view)
42
- - [Active Job](#active-job)
43
- - [Active Model Serializers](#active-model-serializers)
44
- - [Active Record](#active-record)
45
- - [Active Support](#active-support)
46
- - [AWS](#aws)
47
- - [Concurrent Ruby](#concurrent-ruby)
48
- - [Cucumber](#cucumber)
49
- - [Dalli](#dalli)
50
- - [DelayedJob](#delayedjob)
51
- - [Elasticsearch](#elasticsearch)
52
- - [Ethon & Typhoeus](#ethon)
53
- - [Excon](#excon)
54
- - [Faraday](#faraday)
55
- - [Grape](#grape)
56
- - [GraphQL](#graphql)
57
- - [gRPC](#grpc)
58
- - [http.rb](#httprb)
59
- - [httpclient](#httpclient)
60
- - [httpx](#httpx)
61
- - [Kafka](#kafka)
62
- - [MongoDB](#mongodb)
63
- - [MySQL2](#mysql2)
64
- - [Net/HTTP](#nethttp)
65
- - [Presto](#presto)
66
- - [Qless](#qless)
67
- - [Que](#que)
68
- - [Racecar](#racecar)
69
- - [Rack](#rack)
70
- - [Rails](#rails)
71
- - [Rake](#rake)
72
- - [Redis](#redis)
73
- - [Resque](#resque)
74
- - [Rest Client](#rest-client)
75
- - [RSpec](#rspec)
76
- - [Sequel](#sequel)
77
- - [Shoryuken](#shoryuken)
78
- - [Sidekiq](#sidekiq)
79
- - [Sinatra](#sinatra)
80
- - [Sneakers](#sneakers)
81
- - [Sucker Punch](#sucker-punch)
82
- - [Additional configuration](#additional-configuration)
83
- - [Custom logging](#custom-logging)
84
- - [Environment and tags](#environment-and-tags)
85
- - [Debugging and diagnostics](#debugging-and-diagnostics)
86
- - [Sampling](#sampling)
87
- - [Application-side sampling](#application-side-sampling)
88
- - [Priority sampling](#priority-sampling)
89
- - [Distributed tracing](#distributed-tracing)
90
- - [HTTP request queuing](#http-request-queuing)
91
- - [Processing pipeline](#processing-pipeline)
92
- - [Filtering](#filtering)
93
- - [Processing](#processing)
94
- - [Trace correlation](#trace-correlation)
95
- - [Configuring the transport layer](#configuring-the-transport-layer)
96
- - [Metrics](#metrics)
97
- - [For application runtime](#for-application-runtime)
98
- - [OpenTracing](#opentracing)
99
- - [Profiling](#profiling)
100
- - [Troubleshooting](#troubleshooting)
101
- - [Profiling Resque jobs](#profiling-resque-jobs)
102
- - [Known issues and suggested configurations](#known-issues-and-suggested-configurations)
103
- - [Payload too large](#payload-too-large)
104
- - [Stack level too deep](#stack-level-too-deep)
105
-
106
- ## Compatibility
107
-
108
- **Supported Ruby interpreters**:
109
-
110
- | Type | Documentation | Version | Support type | Gem version support |
111
- | ----- | -------------------------- | ----- | ------------------------------------ | ------------------- |
112
- | MRI | https://www.ruby-lang.org/ | 3.1 | Full | Latest |
113
- | | | 3.0 | Full | Latest |
114
- | | | 2.7 | Full | Latest |
115
- | | | 2.6 | Full | Latest |
116
- | | | 2.5 | Full | Latest |
117
- | | | 2.4 | Full | Latest |
118
- | | | 2.3 | Full | Latest |
119
- | | | 2.2 | Full | Latest |
120
- | | | 2.1 | Full | Latest |
121
- | | | 2.0 | EOL since June 7th, 2021 | < 0.50.0 |
122
- | | | 1.9.3 | EOL since August 6th, 2020 | < 0.27.0 |
123
- | | | 1.9.1 | EOL since August 6th, 2020 | < 0.27.0 |
124
- | JRuby | https://www.jruby.org | 9.2 | Full | Latest |
125
-
126
- **Supported web servers**:
127
-
128
- | Type | Documentation | Version | Support type |
129
- | --------- | --------------------------------- | ------------ | ------------ |
130
- | Puma | http://puma.io/ | 2.16+ / 3.6+ | Full |
131
- | Unicorn | https://bogomips.org/unicorn/ | 4.8+ / 5.1+ | Full |
132
- | Passenger | https://www.phusionpassenger.com/ | 5.0+ | Full |
133
-
134
- **Supported tracing frameworks**:
135
-
136
- | Type | Documentation | Version | Gem version support |
137
- | ----------- | ----------------------------------------------- | --------------------- | ------------------- |
138
- | OpenTracing | https://github.com/opentracing/opentracing-ruby | 0.4.1+ (w/ Ruby 2.1+) | >= 0.16.0 |
139
-
140
- *Full* support indicates all tracer features are available.
141
-
142
- *Deprecated* indicates support will transition to *Maintenance* in a future release.
143
-
144
- *Maintenance* indicates only critical bugfixes are backported until EOL.
145
-
146
- *EOL* indicates support is no longer provided.
147
-
148
- ### Apple macOS support
149
-
150
- Use of `ddtrace` on macOS is supported for development, but not for production deployments.
151
-
152
- ### Microsoft Windows support
153
-
154
- Using `ddtrace` on Microsoft Windows is currently unsupported. We'll still accept community contributions and issues,
155
- but will consider them as having low priority.
156
-
157
- ## Installation
158
-
159
- Adding tracing to your Ruby application only takes a few quick steps:
160
-
161
- 1. Setup the Datadog Agent for tracing
162
- 2. Instrument your application
163
- 3. Connect your application to the Datadog Agent
164
-
165
- ### Setup the Datadog Agent for tracing
166
-
167
- Before installing `ddtrace`, [install the Datadog Agent](https://docs.datadoghq.com/agent/), to which `ddtrace` will send trace data.
168
-
169
- Then configure the Datadog Agent to accept traces. To do this, either:
170
-
171
- - Set `DD_APM_ENABLED=true` in the agent's environment
172
-
173
- OR
174
-
175
- - Add `apm_enabled: true` to the [agent's configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6v7#agent-main-configuration-file)
176
-
177
- *Additionally, in containerized environments...*
178
-
179
- - Set `DD_APM_NON_LOCAL_TRAFFIC=true` in the agent's environment
180
-
181
- OR
182
-
183
- - Add `apm_non_local_traffic: true` to the [agent's configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6v7#agent-main-configuration-file).
184
-
185
- See the specific setup instructions for [Docker](https://docs.datadoghq.com/agent/docker/apm/?tab=ruby), [Kubernetes](https://docs.datadoghq.com/agent/kubernetes/apm/?tab=helm), [Amazon ECS](https://docs.datadoghq.com/agent/amazon_ecs/apm/?tab=ruby) or [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/#trace-collection) to ensure that the Agent is configured to receive traces in a containerized environment.
186
-
187
- #### Configuring trace data ingestion
188
-
189
- The Datadog agent will listen for traces via HTTP on port `8126` by default.
190
-
191
- You may change the protocol or port the agent listens for trace data using the following:
192
-
193
- **For HTTP over TCP**:
194
-
195
- - Set `DD_APM_RECEIVER_PORT=<port>` in the agent's environment
196
-
197
- OR
198
-
199
- - Add `apm_config: receiver_port: <port>` to the [agent's configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6v7#agent-main-configuration-file)
200
-
201
- **For Unix Domain Socket (UDS)**:
202
-
203
- - Set `DD_APM_RECEIVER_SOCKET=<path-to-socket-file>`
204
-
205
- OR
206
-
207
- - Add `apm_config: receiver_socket: <path-to-socket-file>` to the [agent's configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6v7#agent-main-configuration-file)
208
-
209
- ### Instrument your application
210
-
211
- #### Rails applications
212
-
213
- 1. Add the `ddtrace` gem to your Gemfile:
214
-
215
- ```ruby
216
- source 'https://rubygems.org'
217
- gem 'ddtrace', require: 'ddtrace/auto_instrument'
218
- ```
219
-
220
- 2. Install the gem with `bundle install`
221
-
222
- 3. Create a `config/initializers/datadog.rb` file containing:
223
-
224
- ```ruby
225
- Datadog.configure do |c|
226
- # Add additional configuration here.
227
- # Activate integrations, change tracer settings, etc...
228
- end
229
- ```
230
-
231
- Using this block you can:
232
-
233
- - [Add additional configuration settings](#additional-configuration)
234
- - [Activate or reconfigure instrumentation](#integration-instrumentation)
235
-
236
- #### Ruby applications
237
-
238
- 1. Add the `ddtrace` gem to your Gemfile:
239
-
240
- ```ruby
241
- source 'https://rubygems.org'
242
- gem 'ddtrace'
243
- ```
244
-
245
- 2. Install the gem with `bundle install`
246
- 3. `require` any [supported libraries or frameworks](#integration-instrumentation) that should be instrumented.
247
- 4. Add `require 'ddtrace/auto_instrument'` to your application. _Note:_ This must be done _after_ requiring any supported libraries or frameworks.
248
-
249
- ```ruby
250
- # Example frameworks and libraries
251
- require 'sinatra'
252
- require 'faraday'
253
- require 'redis'
254
-
255
- require 'ddtrace/auto_instrument'
256
- ```
257
-
258
- 5. Add a configuration block to your application:
259
-
260
- ```ruby
261
- Datadog.configure do |c|
262
- # Add additional configuration here.
263
- # Activate integrations, change tracer settings, etc...
264
- end
265
- ```
266
-
267
- Using this block you can:
268
-
269
- - [Add additional configuration settings](#additional-configuration)
270
- - [Activate or reconfigure instrumentation](#integration-instrumentation)
271
-
272
- #### Configuring OpenTracing
273
-
274
- 1. Add the `ddtrace` gem to your Gemfile:
275
-
276
- ```ruby
277
- source 'https://rubygems.org'
278
- gem 'ddtrace'
279
- ```
280
-
281
- 2. Install the gem with `bundle install`
282
- 3. To your OpenTracing configuration file, add the following:
283
-
284
- ```ruby
285
- require 'opentracing'
286
- require 'datadog/tracing'
287
- require 'datadog/opentracer'
288
-
289
- # Activate the Datadog tracer for OpenTracing
290
- OpenTracing.global_tracer = Datadog::OpenTracer::Tracer.new
291
- ```
292
-
293
- 4. Add a configuration block to your application:
294
-
295
- ```ruby
296
- Datadog.configure do |c|
297
- # Configure the Datadog tracer here.
298
- # Activate integrations, change tracer settings, etc...
299
- # By default without additional configuration,
300
- # no additional integrations will be traced, only
301
- # what you have instrumented with OpenTracing.
302
- end
303
- ```
304
-
305
- Using this block you can:
306
-
307
- - [Add additional Datadog configuration settings](#additional-configuration)
308
- - [Activate or reconfigure Datadog instrumentation](#integration-instrumentation)
309
-
310
- #### Configuring OpenTelemetry
311
-
312
- You can send OpenTelemetry traces directly to the Datadog agent (without `ddtrace`) by using OTLP. Check out our documentation on [OTLP ingest in the Datadog Agent](https://docs.datadoghq.com/tracing/setup_overview/open_standards/#otlp-ingest-in-datadog-agent) for details.
313
-
314
- ### Connect your application to the Datadog Agent
315
-
316
- By default, `ddtrace` will connect to the agent using the first available settings in the listed priority:
317
-
318
- 1. Via any explicitly provided configuration settings (hostname/port/transport)
319
- 2. Via Unix Domain Socket (UDS) located at `/var/run/datadog/apm.socket`
320
- 3. Via HTTP over TCP to `127.0.0.1:8126`
321
-
322
- If your Datadog Agent is listening at any of these locations, no further configuration should be required.
323
-
324
- If your agent runs on a different host or container than your application, or you would like to send traces via a different protocol, you will need to configure your application accordingly.
325
-
326
- - [How to send trace data via HTTP over TCP to agent](#changing-default-agent-hostname-and-port)
327
- - [How to send trace data via Unix Domain Socket (UDS) to agent](#using-the-unix-domain-socket-uds-adapter)
328
-
329
- ### Final steps for installation
330
-
331
- After setting up, your services will appear on the [APM services page](https://app.datadoghq.com/apm/services) within a few minutes. Learn more about [using the APM UI][visualization docs].
332
-
333
- ## Manual Instrumentation
334
-
335
- If you aren't using a supported framework instrumentation, you may want to manually instrument your code.
336
-
337
- To trace any Ruby code, you can use the `Datadog::Tracing.trace` method:
338
-
339
- ```ruby
340
- Datadog::Tracing.trace(name, options) do |span, trace|
341
- # Wrap this block around the code you want to instrument
342
- # Additionally, you can modify the span here.
343
- # e.g. Change the resource name, set tags, etc...
344
- end
345
- ```
346
-
347
- Where `name` should be a `String` that describes the generic kind of operation being done (e.g. `'web.request'`, or `'request.parse'`)
348
-
349
- And `options` is an optional `Hash` that accepts the following parameters:
350
-
351
- | Key | Type | Description | Default |
352
- | --------------- | ----------------------- | --- | --- |
353
- | `autostart` | `Bool` | Whether the time measurement should be started automatically. If `false`, user must call `span.start`. | `true` |
354
- | `continue_from` | `Datadog::TraceDigest` | Continues a trace that originated from another execution context. TraceDigest describes the continuation point. | `nil` |
355
- | `on_error` | `Proc` | Overrides error handling behavior, when a span raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
356
- | `resource` | `String` | Name of the resource or action being operated on. Traces with the same resource value will be grouped together for the purpose of metrics (but still independently viewable.) Usually domain specific, such as a URL, query, request, etc. (e.g. `'Article#submit'`, `http://example.com/articles/list`.) | `name` of Span. |
357
- | `service` | `String` | The service name which this span belongs (e.g. `'my-web-service'`) | Tracer `default-service`, `$PROGRAM_NAME` or `'ruby'` |
358
- | `start_time` | `Time` | When the span actually starts. Useful when tracing events that have already happened. | `Time.now` |
359
- | `tags` | `Hash` | Extra tags which should be added to the span. | `{}` |
360
- | `type` | `String` | The type of the span (such as `'http'`, `'db'`, etc.) | `nil` |
361
-
362
- It's highly recommended you set both `service` and `resource` at a minimum. Spans without a `service` or `resource` as `nil` will be discarded by the Datadog agent.
363
-
364
- Example of manual instrumentation in action:
365
-
366
- ```ruby
367
- get '/posts' do
368
- Datadog::Tracing.trace('web.request', service: 'my-blog', resource: 'GET /posts') do |span|
369
- # Trace the activerecord call
370
- Datadog::Tracing.trace('posts.fetch') do
371
- @posts = Posts.order(created_at: :desc).limit(10)
372
- end
373
-
374
- # Add some APM tags
375
- span.set_tag('http.method', request.request_method)
376
- span.set_tag('posts.count', @posts.length)
377
-
378
- # Trace the template rendering
379
- Datadog::Tracing.trace('template.render') do
380
- erb :index
381
- end
382
- end
383
- end
384
- ```
385
-
386
- ### Asynchronous tracing
387
-
388
- It might not always be possible to wrap `Datadog::Tracing.trace` around a block of code. Some event or notification based instrumentation might only notify you when an event begins or ends.
389
-
390
- To trace these operations, you can trace code asynchronously by calling `Datadog::Tracing.trace` without a block:
391
-
392
- ```ruby
393
- # Some instrumentation framework calls this after an event finishes...
394
- def db_query(start, finish, query)
395
- span = Datadog::Tracing.trace('database.query', start_time: start)
396
- span.resource = query
397
- span.finish(finish)
398
- end
399
- ```
400
-
401
- Calling `Datadog::Tracing.trace` without a block will cause the function to return a `Datadog::SpanOperation` that is started, but not finished. You can then modify this span however you wish, then close it `finish`.
402
-
403
- *You must not leave any unfinished spans.* If any spans are left open when the trace completes, the trace will be discarded. You can [activate debug mode](#tracer-settings) to check for warnings if you suspect this might be happening.
404
-
405
- To avoid this scenario when handling start/finish events, you can use `Datadog::Tracing.active_span` to get the current active span.
406
-
407
- ```ruby
408
- # e.g. ActiveSupport::Notifications calls this when an event starts
409
- def start(name, id, payload)
410
- # Start a span
411
- Datadog::Tracing.trace(name)
412
- end
413
-
414
- # e.g. ActiveSupport::Notifications calls this when an event finishes
415
- def finish(name, id, payload)
416
- # Retrieve current active span (thread-safe)
417
- current_span = Datadog::Tracing.active_span
418
- unless current_span.nil?
419
- current_span.resource = payload[:query]
420
- current_span.finish
421
- end
422
- end
423
- ```
424
- ### Enriching traces from nested methods
425
-
426
- You can tag additional information to the current active span from any method. Note however that if the method is called and there is no span currently active `active_span` will be nil.
427
-
428
- ```ruby
429
- # e.g. adding tag to active span
430
-
431
- current_span = Datadog::Tracing.active_span
432
- current_span.set_tag('my_tag', 'my_value') unless current_span.nil?
433
- ```
434
-
435
- You can also get the current active trace using the `active_trace` method. This method will return `nil` if there is no active trace.
436
-
437
- ```ruby
438
- # e.g. accessing active trace
439
-
440
- current_trace = Datadog::Tracing.active_trace
441
- ```
442
-
443
- ## Integration instrumentation
444
-
445
- Many popular libraries and frameworks are supported out-of-the-box, which can be auto-instrumented. Although they are not activated automatically, they can be easily activated and configured by using the `Datadog.configure` API:
446
-
447
- ```ruby
448
- Datadog.configure do |c|
449
- # Activates and configures an integration
450
- c.tracing.instrument :integration_name, options
451
- end
452
- ```
453
-
454
- `options` is a `Hash` of integration-specific configuration settings.
455
-
456
- For a list of available integrations, and their configuration options, please refer to the following:
457
-
458
- | Name | Key | Versions Supported: MRI | Versions Supported: JRuby | How to configure | Gem source |
459
- | -------------------------- | -------------------------- | ------------------------ | --------------------------| ----------------------------------- | ------------------------------------------------------------------------------ |
460
- | Action Cable | `action_cable` | `>= 5.0` | `>= 5.0` | *[Link](#action-cable)* | *[Link](https://github.com/rails/rails/tree/master/actioncable)* |
461
- | Action Mailer | `action_mailer` | `>= 5.0` | `>= 5.0` | *[Link](#action-mailer)* | *[Link](https://github.com/rails/rails/tree/master/actionmailer)* |
462
- | Action Pack | `action_pack` | `>= 3.2` | `>= 3.2` | *[Link](#action-pack)* | *[Link](https://github.com/rails/rails/tree/master/actionpack)* |
463
- | Action View | `action_view` | `>= 3.2` | `>= 3.2` | *[Link](#action-view)* | *[Link](https://github.com/rails/rails/tree/master/actionview)* |
464
- | Active Job | `active_job` | `>= 4.2` | `>= 4.2` | *[Link](#active-job)* | *[Link](https://github.com/rails/rails/tree/master/activejob)* |
465
- | Active Model Serializers | `active_model_serializers` | `>= 0.9` | `>= 0.9` | *[Link](#active-model-serializers)* | *[Link](https://github.com/rails-api/active_model_serializers)* |
466
- | Active Record | `active_record` | `>= 3.2` | `>= 3.2` | *[Link](#active-record)* | *[Link](https://github.com/rails/rails/tree/master/activerecord)* |
467
- | Active Support | `active_support` | `>= 3.2` | `>= 3.2` | *[Link](#active-support)* | *[Link](https://github.com/rails/rails/tree/master/activesupport)* |
468
- | AWS | `aws` | `>= 2.0` | `>= 2.0` | *[Link](#aws)* | *[Link](https://github.com/aws/aws-sdk-ruby)* |
469
- | Concurrent Ruby | `concurrent_ruby` | `>= 0.9` | `>= 0.9` | *[Link](#concurrent-ruby)* | *[Link](https://github.com/ruby-concurrency/concurrent-ruby)* |
470
- | Dalli | `dalli` | `>= 2.0` | `>= 2.0` | *[Link](#dalli)* | *[Link](https://github.com/petergoldstein/dalli)* |
471
- | DelayedJob | `delayed_job` | `>= 4.1` | `>= 4.1` | *[Link](#delayedjob)* | *[Link](https://github.com/collectiveidea/delayed_job)* |
472
- | Elasticsearch | `elasticsearch` | `>= 1.0` | `>= 1.0` | *[Link](#elasticsearch)* | *[Link](https://github.com/elastic/elasticsearch-ruby)* |
473
- | Ethon | `ethon` | `>= 0.11` | `>= 0.11` | *[Link](#ethon)* | *[Link](https://github.com/typhoeus/ethon)* |
474
- | Excon | `excon` | `>= 0.50` | `>= 0.50` | *[Link](#excon)* | *[Link](https://github.com/excon/excon)* |
475
- | Faraday | `faraday` | `>= 0.14` | `>= 0.14` | *[Link](#faraday)* | *[Link](https://github.com/lostisland/faraday)* |
476
- | Grape | `grape` | `>= 1.0` | `>= 1.0` | *[Link](#grape)* | *[Link](https://github.com/ruby-grape/grape)* |
477
- | GraphQL | `graphql` | `>= 1.7.9` | `>= 1.7.9` | *[Link](#graphql)* | *[Link](https://github.com/rmosolgo/graphql-ruby)* |
478
- | gRPC | `grpc` | `>= 1.7` | *gem not available* | *[Link](#grpc)* | *[Link](https://github.com/grpc/grpc/tree/master/src/rubyc)* |
479
- | http.rb | `httprb` | `>= 2.0` | `>= 2.0` | *[Link](#httprb)* | *[Link](https://github.com/httprb/http)* |
480
- | httpclient | `httpclient` | `>= 2.2` | `>= 2.2` | *[Link](#httpclient)* | *[Link](https://github.com/nahi/httpclient)* |
481
- | httpx | `httpx` | `>= 0.11` | `>= 0.11` | *[Link](#httpx)* | *[Link](https://gitlab.com/honeyryderchuck/httpx)* |
482
- | Kafka | `ruby-kafka` | `>= 0.7.10` | `>= 0.7.10` | *[Link](#kafka)* | *[Link](https://github.com/zendesk/ruby-kafka)* |
483
- | Makara (via Active Record) | `makara` | `>= 0.3.5` | `>= 0.3.5` | *[Link](#active-record)* | *[Link](https://github.com/instacart/makara)* |
484
- | MongoDB | `mongo` | `>= 2.1` | `>= 2.1` | *[Link](#mongodb)* | *[Link](https://github.com/mongodb/mongo-ruby-driver)* |
485
- | MySQL2 | `mysql2` | `>= 0.3.21` | *gem not available* | *[Link](#mysql2)* | *[Link](https://github.com/brianmario/mysql2)* |
486
- | Net/HTTP | `http` | *(Any supported Ruby)* | *(Any supported Ruby)* | *[Link](#nethttp)* | *[Link](https://ruby-doc.org/stdlib-2.4.0/libdoc/net/http/rdoc/Net/HTTP.html)* |
487
- | Presto | `presto` | `>= 0.5.14` | `>= 0.5.14` | *[Link](#presto)* | *[Link](https://github.com/treasure-data/presto-client-ruby)* |
488
- | Qless | `qless` | `>= 0.10.0` | `>= 0.10.0` | *[Link](#qless)* | *[Link](https://github.com/seomoz/qless)* |
489
- | Que | `que` | `>= 1.0.0.beta2` | `>= 1.0.0.beta2` | *[Link](#que)* | *[Link](https://github.com/que-rb/que)* |
490
- | Racecar | `racecar` | `>= 0.3.5` | `>= 0.3.5` | *[Link](#racecar)* | *[Link](https://github.com/zendesk/racecar)* |
491
- | Rack | `rack` | `>= 1.1` | `>= 1.1` | *[Link](#rack)* | *[Link](https://github.com/rack/rack)* |
492
- | Rails | `rails` | `>= 3.2` | `>= 3.2` | *[Link](#rails)* | *[Link](https://github.com/rails/rails)* |
493
- | Rake | `rake` | `>= 12.0` | `>= 12.0` | *[Link](#rake)* | *[Link](https://github.com/ruby/rake)* |
494
- | Redis | `redis` | `>= 3.2` | `>= 3.2` | *[Link](#redis)* | *[Link](https://github.com/redis/redis-rb)* |
495
- | Resque | `resque` | `>= 1.0` | `>= 1.0` | *[Link](#resque)* | *[Link](https://github.com/resque/resque)* |
496
- | Rest Client | `rest-client` | `>= 1.8` | `>= 1.8` | *[Link](#rest-client)* | *[Link](https://github.com/rest-client/rest-client)* |
497
- | Sequel | `sequel` | `>= 3.41` | `>= 3.41` | *[Link](#sequel)* | *[Link](https://github.com/jeremyevans/sequel)* |
498
- | Shoryuken | `shoryuken` | `>= 3.2` | `>= 3.2` | *[Link](#shoryuken)* | *[Link](https://github.com/phstc/shoryuken)* |
499
- | Sidekiq | `sidekiq` | `>= 3.5.4` | `>= 3.5.4` | *[Link](#sidekiq)* | *[Link](https://github.com/mperham/sidekiq)* |
500
- | Sinatra | `sinatra` | `>= 1.4` | `>= 1.4` | *[Link](#sinatra)* | *[Link](https://github.com/sinatra/sinatra)* |
501
- | Sneakers | `sneakers` | `>= 2.12.0` | `>= 2.12.0` | *[Link](#sneakers)* | *[Link](https://github.com/jondot/sneakers)* |
502
- | Sucker Punch | `sucker_punch` | `>= 2.0` | `>= 2.0` | *[Link](#sucker-punch)* | *[Link](https://github.com/brandonhilkert/sucker_punch)* |
503
-
504
- #### CI Visibility
505
-
506
- For Datadog CI Visibility, library instrumentation can be activated and configured by using the following `Datadog.configure` API:
507
-
508
- ```ruby
509
- Datadog.configure do |c|
510
- # Activates and configures an integration
511
- c.ci.instrument :integration_name, options
512
- end
513
- ```
514
-
515
- `options` is a `Hash` of integration-specific configuration settings.
516
-
517
- These are the available CI Visibility integrations:
518
-
519
- | Name | Key | Versions Supported: MRI | Versions Supported: JRuby | How to configure | Gem source |
520
- |-----------|------------|-------------------------|---------------------------|---------------------|-----------------------------------------------------|
521
- | Cucumber | `cucumber` | `>= 3.0` | `>= 1.7.16` | *[Link](#cucumber)* | *[Link](https://github.com/cucumber/cucumber-ruby)* |
522
- | RSpec | `rspec` | `>= 3.0.0` | `>= 3.0.0` | *[Link](#rspec)* | *[Link](https://github.com/rspec/rspec)* |
523
-
524
- ### Action Cable
525
-
526
- The Action Cable integration traces broadcast messages and channel actions.
527
-
528
- You can enable it through `Datadog.configure`:
529
-
530
- ```ruby
531
- require 'ddtrace'
532
-
533
- Datadog.configure do |c|
534
- c.tracing.instrument :action_cable
535
- end
536
- ```
537
-
538
- ### Action Mailer
539
-
540
- The Action Mailer integration provides tracing for Rails 5 ActionMailer actions.
541
-
542
- You can enable it through `Datadog.configure`:
543
-
544
- ```ruby
545
- require 'ddtrace'
546
- Datadog.configure do |c|
547
- c.tracing.instrument :action_mailer, options
548
- end
549
- ```
550
-
551
- Where `options` is an optional `Hash` that accepts the following parameters:
552
-
553
- | Key | Description | Default |
554
- | --- | ----------- | ------- |
555
- | `analytics_enabled` | Enable analytics for spans produced by this integration. `true` for on, `nil` to defer to global setting, `false` for off. | `false` |
556
- | `email_data` | Whether or not to append additional email payload metadata to `action_mailer.deliver` spans. Fields include `['subject', 'to', 'from', 'bcc', 'cc', 'date', 'perform_deliveries']`. | `false` |
557
-
558
- ### Action Pack
559
-
560
- Most of the time, Action Pack is set up as part of Rails, but it can be activated separately:
561
-
562
- ```ruby
563
- require 'actionpack'
564
- require 'ddtrace'
565
-
566
- Datadog.configure do |c|
567
- c.tracing.instrument :action_pack
568
- end
569
- ```
570
-
571
- ### Action View
572
-
573
- Most of the time, Action View is set up as part of Rails, but it can be activated separately:
574
-
575
- ```ruby
576
- require 'actionview'
577
- require 'ddtrace'
578
-
579
- Datadog.configure do |c|
580
- c.tracing.instrument :action_view, options
581
- end
582
- ```
583
-
584
- Where `options` is an optional `Hash` that accepts the following parameters:
585
-
586
- | Key | Description | Default |
587
- | ---| --- | --- |
588
- | `template_base_path` | Used when the template name is parsed. If you don't store your templates in the `views/` folder, you may need to change this value | `'views/'` |
589
-
590
- ### Active Job
591
-
592
- Most of the time, Active Job is set up as part of Rails, but it can be activated separately:
593
-
594
- ```ruby
595
- require 'active_job'
596
- require 'ddtrace'
597
-
598
- Datadog.configure do |c|
599
- c.tracing.instrument :active_job
600
- end
601
-
602
- ExampleJob.perform_later
603
- ```
604
-
605
- ### Active Model Serializers
606
-
607
- The Active Model Serializers integration traces the `serialize` event for version 0.9+ and the `render` event for version 0.10+.
608
-
609
- ```ruby
610
- require 'active_model_serializers'
611
- require 'ddtrace'
612
-
613
- Datadog.configure do |c|
614
- c.tracing.instrument :active_model_serializers
615
- end
616
-
617
- my_object = MyModel.new(name: 'my object')
618
- ActiveModelSerializers::SerializableResource.new(test_obj).serializable_hash
619
- ```
620
-
621
- ### Active Record
622
-
623
- Most of the time, Active Record is set up as part of a web framework (Rails, Sinatra...) however, it can be set up alone:
624
-
625
- ```ruby
626
- require 'tmpdir'
627
- require 'sqlite3'
628
- require 'active_record'
629
- require 'ddtrace'
630
-
631
- Datadog.configure do |c|
632
- c.tracing.instrument :active_record, options
633
- end
634
-
635
- Dir::Tmpname.create(['test', '.sqlite']) do |db|
636
- conn = ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
637
- database: db)
638
- conn.connection.execute('SELECT 42') # traced!
639
- end
640
- ```
641
-
642
- Where `options` is an optional `Hash` that accepts the following parameters:
643
-
644
- | Key | Description | Default |
645
- | ---| --- | --- |
646
- | `service_name` | Service name used for database portion of `active_record` instrumentation. | Name of database adapter (e.g. `'mysql2'`) |
647
-
648
- **Configuring trace settings per database**
649
-
650
- You can configure trace settings per database connection by using the `describes` option:
651
-
652
- ```ruby
653
- # Provide a `:describes` option with a connection key.
654
- # Any of the following keys are acceptable and equivalent to one another.
655
- # If a block is provided, it yields a Settings object that
656
- # accepts any of the configuration options listed above.
657
-
658
- Datadog.configure do |c|
659
- # Symbol matching your database connection in config/database.yml
660
- # Only available if you are using Rails with ActiveRecord.
661
- c.tracing.instrument :active_record, describes: :secondary_database, service_name: 'secondary-db'
662
-
663
- # Block configuration pattern.
664
- c.tracing.instrument :active_record, describes: :secondary_database do |second_db|
665
- second_db.service_name = 'secondary-db'
666
- end
667
-
668
- # Connection string with the following connection settings:
669
- # adapter, username, host, port, database
670
- # Other fields are ignored.
671
- c.tracing.instrument :active_record, describes: 'mysql2://root@127.0.0.1:3306/mysql', service_name: 'secondary-db'
672
-
673
- # Hash with following connection settings:
674
- # adapter, username, host, port, database
675
- # Other fields are ignored.
676
- c.tracing.instrument :active_record, describes: {
677
- adapter: 'mysql2',
678
- host: '127.0.0.1',
679
- port: '3306',
680
- database: 'mysql',
681
- username: 'root'
682
- },
683
- service_name: 'secondary-db'
684
-
685
- # If using the `makara` gem, it's possible to match on connection `role`:
686
- c.tracing.instrument :active_record, describes: { makara_role: 'primary' }, service_name: 'primary-db'
687
- c.tracing.instrument :active_record, describes: { makara_role: 'replica' }, service_name: 'secondary-db'
688
- end
689
- ```
690
-
691
- You can also create configurations based on partial matching of database connection fields:
692
-
693
- ```ruby
694
- Datadog.configure do |c|
695
- # Matches any connection on host `127.0.0.1`.
696
- c.tracing.instrument :active_record, describes: { host: '127.0.0.1' }, service_name: 'local-db'
697
-
698
- # Matches any `mysql2` connection.
699
- c.tracing.instrument :active_record, describes: { adapter: 'mysql2'}, service_name: 'mysql-db'
700
-
701
- # Matches any `mysql2` connection to the `reports` database.
702
- #
703
- # In case of multiple matching `describe` configurations, the latest one applies.
704
- # In this case a connection with both adapter `mysql` and database `reports`
705
- # will be configured `service_name: 'reports-db'`, not `service_name: 'mysql-db'`.
706
- c.tracing.instrument :active_record, describes: { adapter: 'mysql2', database: 'reports'}, service_name: 'reports-db'
707
- end
708
- ```
709
-
710
- When multiple `describes` configurations match a connection, the latest configured rule that matches will be applied.
711
-
712
- If ActiveRecord traces an event that uses a connection that matches a key defined by `describes`, it will use the trace settings assigned to that connection. If the connection does not match any of the described connections, it will use default settings defined by `c.tracing.instrument :active_record` instead.
713
-
714
- ### Active Support
715
-
716
- Most of the time, Active Support is set up as part of Rails, but it can be activated separately:
717
-
718
- ```ruby
719
- require 'activesupport'
720
- require 'ddtrace'
721
-
722
- Datadog.configure do |c|
723
- c.tracing.instrument :active_support, options
724
- end
725
-
726
- cache = ActiveSupport::Cache::MemoryStore.new
727
- cache.read('city')
728
- ```
729
-
730
- Where `options` is an optional `Hash` that accepts the following parameters:
731
-
732
- | Key | Description | Default |
733
- | ---| --- | --- |
734
- | `cache_service` | Service name used for caching with `active_support` instrumentation. | `active_support-cache` |
735
-
736
- ### AWS
737
-
738
- The AWS integration will trace every interaction (e.g. API calls) with AWS services (S3, ElastiCache etc.).
739
-
740
- ```ruby
741
- require 'aws-sdk'
742
- require 'ddtrace'
743
-
744
- Datadog.configure do |c|
745
- c.tracing.instrument :aws, options
746
- end
747
-
748
- # Perform traced call
749
- Aws::S3::Client.new.list_buckets
750
- ```
751
-
752
- Where `options` is an optional `Hash` that accepts the following parameters:
753
-
754
- | Key | Description | Default |
755
- | --- | ----------- | ------- |
756
- | `service_name` | Service name used for `aws` instrumentation | `'aws'` |
757
-
758
- ### Concurrent Ruby
759
-
760
- The Concurrent Ruby integration adds support for context propagation when using `::Concurrent::Future`.
761
- Making sure that code traced within the `Future#execute` will have correct parent set.
762
-
763
- To activate your integration, use the `Datadog.configure` method:
764
-
765
- ```ruby
766
- # Inside Rails initializer or equivalent
767
- Datadog.configure do |c|
768
- # Patches ::Concurrent::Future to use ExecutorService that propagates context
769
- c.tracing.instrument :concurrent_ruby
770
- end
771
-
772
- # Pass context into code executed within Concurrent::Future
773
- Datadog::Tracing.trace('outer') do
774
- Concurrent::Future.execute { Datadog::Tracing.trace('inner') { } }.wait
775
- end
776
- ```
777
-
778
- ### Cucumber
779
-
780
- Cucumber integration will trace all executions of scenarios and steps when using `cucumber` framework.
781
-
782
- To activate your integration, use the `Datadog.configure` method:
783
-
784
- ```ruby
785
- require 'cucumber'
786
- require 'ddtrace'
787
-
788
- # Configure default Cucumber integration
789
- Datadog.configure do |c|
790
- c.ci.instrument :cucumber, options
791
- end
792
-
793
- # Example of how to attach tags from scenario to active span
794
- Around do |scenario, block|
795
- active_span = Datadog.configuration[:cucumber][:tracer].active_span
796
- unless active_span.nil?
797
- scenario.tags.filter { |tag| tag.include? ':' }.each do |tag|
798
- active_span.set_tag(*tag.name.split(':', 2))
799
- end
800
- end
801
- block.call
802
- end
803
- ```
804
-
805
- Where `options` is an optional `Hash` that accepts the following parameters:
806
-
807
- | Key | Description | Default |
808
- | --- | ----------- | ------- |
809
- | `enabled` | Defines whether Cucumber tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
810
- | `service_name` | Service name used for `cucumber` instrumentation. | `'cucumber'` |
811
- | `operation_name` | Operation name used for `cucumber` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'cucumber.test'` |
812
-
813
- ### Dalli
814
-
815
- Dalli integration will trace all calls to your `memcached` server:
816
-
817
- ```ruby
818
- require 'dalli'
819
- require 'ddtrace'
820
-
821
- # Configure default Dalli tracing behavior
822
- Datadog.configure do |c|
823
- c.tracing.instrument :dalli, options
824
- end
825
-
826
- # Configure Dalli tracing behavior for single client
827
- client = Dalli::Client.new('localhost:11211', options)
828
- client.set('abc', 123)
829
- ```
830
-
831
- Where `options` is an optional `Hash` that accepts the following parameters:
832
-
833
- | Key | Description | Default |
834
- | --- | ----------- | ------- |
835
- | `service_name` | Service name used for `dalli` instrumentation | `'memcached'` |
836
-
837
- ### DelayedJob
838
-
839
- The DelayedJob integration uses lifecycle hooks to trace the job executions and enqueues.
840
-
841
- You can enable it through `Datadog.configure`:
842
-
843
- ```ruby
844
- require 'ddtrace'
845
-
846
- Datadog.configure do |c|
847
- c.tracing.instrument :delayed_job, options
848
- end
849
- ```
850
-
851
- Where `options` is an optional `Hash` that accepts the following parameters:
852
-
853
- | Key | Description | Default |
854
- | --- | ----------- | ------- |
855
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
856
-
857
- ### Elasticsearch
858
-
859
- The Elasticsearch integration will trace any call to `perform_request` in the `Client` object:
860
-
861
- ```ruby
862
- require 'elasticsearch/transport'
863
- require 'ddtrace'
864
-
865
- Datadog.configure do |c|
866
- c.tracing.instrument :elasticsearch, options
867
- end
868
-
869
- # Perform a query to Elasticsearch
870
- client = Elasticsearch::Client.new url: 'http://127.0.0.1:9200'
871
- response = client.perform_request 'GET', '_cluster/health'
872
- ```
873
-
874
- Where `options` is an optional `Hash` that accepts the following parameters:
875
-
876
- | Key | Description | Default |
877
- | --- | ----------- | ------- |
878
- | `quantize` | Hash containing options for quantization. May include `:show` with an Array of keys to not quantize (or `:all` to skip quantization), or `:exclude` with Array of keys to exclude entirely. | `{}` |
879
- | `service_name` | Service name used for `elasticsearch` instrumentation | `'elasticsearch'` |
880
-
881
- ### Ethon
882
-
883
- The `ethon` integration will trace any HTTP request through `Easy` or `Multi` objects. Note that this integration also supports `Typhoeus` library which is based on `Ethon`.
884
-
885
- ```ruby
886
- require 'ddtrace'
887
-
888
- Datadog.configure do |c|
889
- c.tracing.instrument :ethon, options
890
-
891
- # optionally, specify a different service name for hostnames matching a regex
892
- c.tracing.instrument :ethon, describes: /user-[^.]+\.example\.com/ do |ethon|
893
- ethon.service_name = 'user.example.com'
894
- ethon.split_by_domain = false # Only necessary if split_by_domain is true by default
895
- end
896
- end
897
- ```
898
-
899
- Where `options` is an optional `Hash` that accepts the following parameters:
900
-
901
- | Key | Description | Default |
902
- | --- | ----------- | ------- |
903
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
904
- | `service_name` | Service name for `ethon` instrumentation. | `'ethon'` |
905
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
906
-
907
- ### Excon
908
-
909
- The `excon` integration is available through the `ddtrace` middleware:
910
-
911
- ```ruby
912
- require 'excon'
913
- require 'ddtrace'
914
-
915
- # Configure default Excon tracing behavior
916
- Datadog.configure do |c|
917
- c.tracing.instrument :excon, options
918
-
919
- # optionally, specify a different service name for hostnames matching a regex
920
- c.tracing.instrument :excon, describes: /user-[^.]+\.example\.com/ do |excon|
921
- excon.service_name = 'user.example.com'
922
- excon.split_by_domain = false # Only necessary if split_by_domain is true by default
923
- end
924
- end
925
-
926
- connection = Excon.new('https://example.com')
927
- connection.get
928
- ```
929
-
930
- Where `options` is an optional `Hash` that accepts the following parameters:
931
-
932
- | Key | Description | Default |
933
- | --- | ----------- | ------- |
934
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
935
- | `error_handler` | A `Proc` that accepts a `response` parameter. If it evaluates to a *truthy* value, the trace span is marked as an error. By default only sets 5XX responses as errors. | `nil` |
936
- | `service_name` | Service name for Excon instrumentation. When provided to middleware for a specific connection, it applies only to that connection object. | `'excon'` |
937
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
938
-
939
- **Configuring connections to use different settings**
940
-
941
- If you use multiple connections with Excon, you can give each of them different settings by configuring their constructors with middleware:
942
-
943
- ```ruby
944
- # Wrap the Datadog tracing middleware around the default middleware stack
945
- Excon.new(
946
- 'http://example.com',
947
- middlewares: Datadog::Tracing::Contrib::Excon::Middleware.with(options).around_default_stack
948
- )
949
-
950
- # Insert the middleware into a custom middleware stack.
951
- # NOTE: Trace middleware must be inserted after ResponseParser!
952
- Excon.new(
953
- 'http://example.com',
954
- middlewares: [
955
- Excon::Middleware::ResponseParser,
956
- Datadog::Tracing::Contrib::Excon::Middleware.with(options),
957
- Excon::Middleware::Idempotent
958
- ]
959
- )
960
- ```
961
-
962
- Where `options` is a Hash that contains any of the parameters listed in the table above.
963
-
964
- ### Faraday
965
-
966
- The `faraday` integration is available through the `ddtrace` middleware:
967
-
968
- ```ruby
969
- require 'faraday'
970
- require 'ddtrace'
971
-
972
- # Configure default Faraday tracing behavior
973
- Datadog.configure do |c|
974
- c.tracing.instrument :faraday, options
975
-
976
- # optionally, specify a different service name for hostnames matching a regex
977
- c.tracing.instrument :faraday, describes: /user-[^.]+\.example\.com/ do |faraday|
978
- faraday.service_name = 'user.example.com'
979
- faraday.split_by_domain = false # Only necessary if split_by_domain is true by default
980
- end
981
- end
982
-
983
- # In case you want to override the global configuration for a certain client instance
984
- connection = Faraday.new('https://example.com') do |builder|
985
- builder.use(:ddtrace, options)
986
- builder.adapter Faraday.default_adapter
987
- end
988
-
989
- connection.get('/foo')
990
- ```
991
-
992
- Where `options` is an optional `Hash` that accepts the following parameters:
993
-
994
- | Key | Description | Default |
995
- | --- | ----------- | ------- |
996
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
997
- | `error_handler` | A `Proc` that accepts a `response` parameter. If it evaluates to a *truthy* value, the trace span is marked as an error. By default only sets 5XX responses as errors. | `nil` |
998
- | `service_name` | Service name for Faraday instrumentation. When provided to middleware for a specific connection, it applies only to that connection object. | `'faraday'` |
999
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
1000
-
1001
- ### Grape
1002
-
1003
- The Grape integration adds the instrumentation to Grape endpoints and filters. This integration can work side by side with other integrations like Rack and Rails.
1004
-
1005
- To activate your integration, use the `Datadog.configure` method before defining your Grape application:
1006
-
1007
- ```ruby
1008
- # api.rb
1009
- require 'grape'
1010
- require 'ddtrace'
1011
-
1012
- Datadog.configure do |c|
1013
- c.tracing.instrument :grape, options
1014
- end
1015
-
1016
- # Then define your application
1017
- class RackTestingAPI < Grape::API
1018
- desc 'main endpoint'
1019
- get :success do
1020
- 'Hello world!'
1021
- end
1022
- end
1023
- ```
1024
-
1025
- Where `options` is an optional `Hash` that accepts the following parameters:
1026
-
1027
- | Key | Description | Default |
1028
- | --- | ----------- | ------- |
1029
- | `enabled` | Defines whether Grape should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
1030
- | `error_statuses`| Defines a status code or range of status codes which should be marked as errors. `'404,405,500-599'` or `[404,405,'500-599']` | `nil` |
1031
-
1032
- ### GraphQL
1033
-
1034
- The GraphQL integration activates instrumentation for GraphQL queries.
1035
-
1036
- To activate your integration, use the `Datadog.configure` method:
1037
-
1038
- ```ruby
1039
- # Inside Rails initializer or equivalent
1040
- Datadog.configure do |c|
1041
- c.tracing.instrument :graphql, schemas: [YourSchema], options
1042
- end
1043
-
1044
- # Then run a GraphQL query
1045
- YourSchema.execute(query, variables: {}, context: {}, operation_name: nil)
1046
- ```
1047
-
1048
- The `use :graphql` method accepts the following parameters. Additional options can be substituted in for `options`:
1049
-
1050
- | Key | Description | Default |
1051
- | --- | ----------- | ------- |
1052
- | `schemas` | Required. Array of `GraphQL::Schema` objects which to trace. Tracing will be added to all the schemas listed, using the options provided to this configuration. If you do not provide any, then tracing will not be activated. | `[]` |
1053
-
1054
- **Manually configuring GraphQL schemas**
1055
-
1056
- If you prefer to individually configure the tracer settings for a schema (e.g. you have multiple schemas with different service names), in the schema definition, you can add the following [using the GraphQL API](http://graphql-ruby.org/queries/tracing.html):
1057
-
1058
- ```ruby
1059
- # Class-based schema
1060
- class YourSchema < GraphQL::Schema
1061
- use(
1062
- GraphQL::Tracing::DataDogTracing,
1063
- service: 'graphql'
1064
- )
1065
- end
1066
- ```
1067
-
1068
- ```ruby
1069
- # .define-style schema
1070
- YourSchema = GraphQL::Schema.define do
1071
- use(
1072
- GraphQL::Tracing::DataDogTracing,
1073
- service: 'graphql'
1074
- )
1075
- end
1076
- ```
1077
-
1078
- Or you can modify an already defined schema:
1079
-
1080
- ```ruby
1081
- # Class-based schema
1082
- YourSchema.use(
1083
- GraphQL::Tracing::DataDogTracing,
1084
- service: 'graphql'
1085
- )
1086
- ```
1087
-
1088
- ```ruby
1089
- # .define-style schema
1090
- YourSchema.define do
1091
- use(
1092
- GraphQL::Tracing::DataDogTracing,
1093
- service: 'graphql'
1094
- )
1095
- end
1096
- ```
1097
-
1098
- Do *NOT* `use :graphql` in `Datadog.configure` if you choose to configure manually, as to avoid double tracing. These two means of configuring GraphQL tracing are considered mutually exclusive.
1099
-
1100
- ### gRPC
1101
-
1102
- The `grpc` integration adds both client and server interceptors, which run as middleware before executing the service's remote procedure call. As gRPC applications are often distributed, the integration shares trace information between client and server.
1103
-
1104
- To setup your integration, use the `Datadog.configure` method like so:
1105
-
1106
- ```ruby
1107
- require 'grpc'
1108
- require 'ddtrace'
1109
-
1110
- Datadog.configure do |c|
1111
- c.tracing.instrument :grpc, options
1112
- end
1113
-
1114
- # Server side
1115
- server = GRPC::RpcServer.new
1116
- server.add_http2_port('localhost:50051', :this_port_is_insecure)
1117
- server.handle(Demo)
1118
- server.run_till_terminated
1119
-
1120
- # Client side
1121
- client = Demo.rpc_stub_class.new('localhost:50051', :this_channel_is_insecure)
1122
- client.my_endpoint(DemoMessage.new(contents: 'hello!'))
1123
- ```
1124
-
1125
- Where `options` is an optional `Hash` that accepts the following parameters:
1126
-
1127
- | Key | Description | Default |
1128
- | --- | ----------- | ------- |
1129
- | `service_name` | Service name used for `grpc` instrumentation | `'grpc'` |
1130
- | `error_handler` | Custom error handler invoked when a request is an error. A `Proc` that accepts `span` and `error` parameters. Sets error on the span by default. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1131
-
1132
- **Configuring clients to use different settings**
1133
-
1134
- In situations where you have multiple clients calling multiple distinct services, you may pass the Datadog interceptor directly, like so
1135
-
1136
- ```ruby
1137
- configured_interceptor = Datadog::Tracing::Contrib::GRPC::DatadogInterceptor::Client.new do |c|
1138
- c.service_name = "Alternate"
1139
- end
1140
-
1141
- alternate_client = Demo::Echo::Service.rpc_stub_class.new(
1142
- 'localhost:50052',
1143
- :this_channel_is_insecure,
1144
- :interceptors => [configured_interceptor]
1145
- )
1146
- ```
1147
-
1148
- The integration will ensure that the `configured_interceptor` establishes a unique tracing setup for that client instance.
1149
-
1150
- ### http.rb
1151
-
1152
- The http.rb integration will trace any HTTP call using the Http.rb gem.
1153
-
1154
- ```ruby
1155
- require 'http'
1156
- require 'ddtrace'
1157
- Datadog.configure do |c|
1158
- c.tracing.instrument :httprb, options
1159
- # optionally, specify a different service name for hostnames matching a regex
1160
- c.tracing.instrument :httprb, describes: /user-[^.]+\.example\.com/ do |httprb|
1161
- httprb.service_name = 'user.example.com'
1162
- httprb.split_by_domain = false # Only necessary if split_by_domain is true by default
1163
- end
1164
- end
1165
- ```
1166
-
1167
- Where `options` is an optional `Hash` that accepts the following parameters:
1168
-
1169
- | Key | Description | Default |
1170
- | --- | ----------- | ------- |
1171
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
1172
- | `service_name` | Service name for `httprb` instrumentation. | `'httprb'` |
1173
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
1174
-
1175
- ### httpclient
1176
-
1177
- The httpclient integration will trace any HTTP call using the httpclient gem.
1178
-
1179
- ```ruby
1180
- require 'httpclient'
1181
- require 'ddtrace'
1182
- Datadog.configure do |c|
1183
- c.tracing.instrument :httpclient, options
1184
- # optionally, specify a different service name for hostnames matching a regex
1185
- c.tracing.instrument :httpclient, describes: /user-[^.]+\.example\.com/ do |httpclient|
1186
- httpclient.service_name = 'user.example.com'
1187
- httpclient.split_by_domain = false # Only necessary if split_by_domain is true by default
1188
- end
1189
- end
1190
- ```
1191
-
1192
- Where `options` is an optional `Hash` that accepts the following parameters:
1193
-
1194
- | Key | Description | Default |
1195
- | --- | ----------- | ------- |
1196
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
1197
- | `service_name` | Service name for `httpclient` instrumentation. | `'httpclient'` |
1198
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
1199
-
1200
- ### httpx
1201
-
1202
- `httpx` maintains its [own integration with `ddtrace`](https://honeyryderchuck.gitlab.io/httpx/wiki/Datadog-Adapter):
1203
-
1204
- ```ruby
1205
- require "ddtrace"
1206
- require "httpx/adapters/datadog"
1207
-
1208
- Datadog.configure do |c|
1209
- c.tracing.instrument :httpx
1210
-
1211
- # optionally, specify a different service name for hostnames matching a regex
1212
- c.tracing.instrument :httpx, describes: /user-[^.]+\.example\.com/ do |http|
1213
- http.service_name = 'user.example.com'
1214
- http.split_by_domain = false # Only necessary if split_by_domain is true by default
1215
- end
1216
- end
1217
- ```
1218
-
1219
- ### Kafka
1220
-
1221
- The Kafka integration provides tracing of the `ruby-kafka` gem:
1222
-
1223
- You can enable it through `Datadog.configure`:
1224
-
1225
- ```ruby
1226
- require 'active_support/notifications' # required to enable 'ruby-kafka' instrumentation
1227
- require 'kafka'
1228
- require 'ddtrace'
1229
-
1230
- Datadog.configure do |c|
1231
- c.tracing.instrument :kafka
1232
- end
1233
- ```
1234
-
1235
- ### MongoDB
1236
-
1237
- The integration traces any `Command` that is sent from the [MongoDB Ruby Driver](https://github.com/mongodb/mongo-ruby-driver) to a MongoDB cluster. By extension, Object Document Mappers (ODM) such as Mongoid are automatically instrumented if they use the official Ruby driver. To activate the integration, simply:
1238
-
1239
- ```ruby
1240
- require 'mongo'
1241
- require 'ddtrace'
1242
-
1243
- Datadog.configure do |c|
1244
- c.tracing.instrument :mongo, options
1245
- end
1246
-
1247
- # Create a MongoDB client and use it as usual
1248
- client = Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'artists')
1249
- collection = client[:people]
1250
- collection.insert_one({ name: 'Steve' })
1251
-
1252
- # In case you want to override the global configuration for a certain client instance
1253
- Datadog.configure_onto(client, **options)
1254
- ```
1255
-
1256
- Where `options` is an optional `Hash` that accepts the following parameters:
1257
-
1258
- | Key | Description | Default |
1259
- | --- | ----------- | ------- |
1260
- | `quantize` | Hash containing options for quantization. May include `:show` with an Array of keys to not quantize (or `:all` to skip quantization), or `:exclude` with Array of keys to exclude entirely. | `{ show: [:collection, :database, :operation] }` |
1261
- | `service_name` | Service name used for `mongo` instrumentation | `'mongodb'` |
1262
-
1263
- **Configuring trace settings per connection**
1264
-
1265
- You can configure trace settings per connection by using the `describes` option:
1266
-
1267
- ```ruby
1268
- # Provide a `:describes` option with a connection key.
1269
- # Any of the following keys are acceptable and equivalent to one another.
1270
- # If a block is provided, it yields a Settings object that
1271
- # accepts any of the configuration options listed above.
1272
-
1273
- Datadog.configure do |c|
1274
- # Network connection string
1275
- c.tracing.instrument :mongo, describes: '127.0.0.1:27017', service_name: 'mongo-primary'
1276
-
1277
- # Network connection regular expression
1278
- c.tracing.instrument :mongo, describes: /localhost.*/, service_name: 'mongo-secondary'
1279
- end
1280
-
1281
- client = Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'artists')
1282
- collection = client[:people]
1283
- collection.insert_one({ name: 'Steve' })
1284
- # Traced call will belong to `mongo-primary` service
1285
-
1286
- client = Mongo::Client.new([ 'localhost:27017' ], :database => 'artists')
1287
- collection = client[:people]
1288
- collection.insert_one({ name: 'Steve' })
1289
- # Traced call will belong to `mongo-secondary` service
1290
- ```
1291
-
1292
- When multiple `describes` configurations match a connection, the latest configured rule that matches will be applied.
1293
-
1294
- ### MySQL2
1295
-
1296
- The MySQL2 integration traces any SQL command sent through `mysql2` gem.
1297
-
1298
- ```ruby
1299
- require 'mysql2'
1300
- require 'ddtrace'
1301
-
1302
- Datadog.configure do |c|
1303
- c.tracing.instrument :mysql2, options
1304
- end
1305
-
1306
- client = Mysql2::Client.new(:host => "localhost", :username => "root")
1307
- client.query("SELECT * FROM users WHERE group='x'")
1308
- ```
1309
-
1310
- Where `options` is an optional `Hash` that accepts the following parameters:
1311
-
1312
- | Key | Description | Default |
1313
- | --- | ----------- | ------- |
1314
- | `service_name` | Service name used for `mysql2` instrumentation | `'mysql2'` |
1315
-
1316
- ### Net/HTTP
1317
-
1318
- The Net/HTTP integration will trace any HTTP call using the standard lib Net::HTTP module.
1319
-
1320
- ```ruby
1321
- require 'net/http'
1322
- require 'ddtrace'
1323
-
1324
- Datadog.configure do |c|
1325
- c.tracing.instrument :http, options
1326
-
1327
- # optionally, specify a different service name for hostnames matching a regex
1328
- c.tracing.instrument :http, describes: /user-[^.]+\.example\.com/ do |http|
1329
- http.service_name = 'user.example.com'
1330
- http.split_by_domain = false # Only necessary if split_by_domain is true by default
1331
- end
1332
- end
1333
-
1334
- Net::HTTP.start('127.0.0.1', 8080) do |http|
1335
- request = Net::HTTP::Get.new '/index'
1336
- response = http.request(request)
1337
- end
1338
-
1339
- content = Net::HTTP.get(URI('http://127.0.0.1/index.html'))
1340
- ```
1341
-
1342
- Where `options` is an optional `Hash` that accepts the following parameters:
1343
-
1344
- | Key | Description | Default |
1345
- | --- | ----------- | ------- |
1346
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
1347
- | `service_name` | Service name used for `http` instrumentation | `'net/http'` |
1348
- | `split_by_domain` | Uses the request domain as the service name when set to `true`. | `false` |
1349
-
1350
- If you wish to configure each connection object individually, you may use the `Datadog.configure_onto` as it follows:
1351
-
1352
- ```ruby
1353
- client = Net::HTTP.new(host, port)
1354
- Datadog.configure_onto(client, **options)
1355
- ```
1356
-
1357
- ### Presto
1358
-
1359
- The Presto integration traces any SQL command sent through `presto-client` gem.
1360
-
1361
- ```ruby
1362
- require 'presto-client'
1363
- require 'ddtrace'
1364
-
1365
- Datadog.configure do |c|
1366
- c.tracing.instrument :presto, options
1367
- end
1368
-
1369
- client = Presto::Client.new(
1370
- server: "localhost:8880",
1371
- ssl: {verify: false},
1372
- catalog: "native",
1373
- schema: "default",
1374
- time_zone: "US/Pacific",
1375
- language: "English",
1376
- http_debug: true,
1377
- )
1378
-
1379
- client.run("select * from system.nodes")
1380
- ```
1381
-
1382
- Where `options` is an optional `Hash` that accepts the following parameters:
1383
-
1384
- | Key | Description | Default |
1385
- | --- | ----------- | ------- |
1386
- | `service_name` | Service name used for `presto` instrumentation | `'presto'` |
1387
-
1388
- ### Qless
1389
-
1390
- The Qless integration uses lifecycle hooks to trace job executions.
1391
-
1392
- To add tracing to a Qless job:
1393
-
1394
- ```ruby
1395
- require 'ddtrace'
1396
-
1397
- Datadog.configure do |c|
1398
- c.tracing.instrument :qless, options
1399
- end
1400
- ```
1401
-
1402
- Where `options` is an optional `Hash` that accepts the following parameters:
1403
-
1404
- | Key | Description | Default |
1405
- | --- | ----------- | ------- |
1406
- | `tag_job_data` | Enable tagging with job arguments. true for on, false for off. | `false` |
1407
- | `tag_job_tags` | Enable tagging with job tags. true for on, false for off. | `false` |
1408
-
1409
- ### Que
1410
-
1411
- The Que integration is a middleware which will trace job executions.
1412
-
1413
- You can enable it through `Datadog.configure`:
1414
-
1415
- ```ruby
1416
- require 'ddtrace'
1417
-
1418
- Datadog.configure do |c|
1419
- c.tracing.instrument :que, options
1420
- end
1421
- ```
1422
-
1423
- Where `options` is an optional `Hash` that accepts the following parameters:
1424
-
1425
- | Key | Description | Default |
1426
- | --- | ----------- | ------- |
1427
- | `enabled` | Defines whether Que should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
1428
- | `tag_args` | Enable tagging of a job's args field. `true` for on, `false` for off. | `false` |
1429
- | `tag_data` | Enable tagging of a job's data field. `true` for on, `false` for off. | `false` |
1430
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1431
-
1432
- ### Racecar
1433
-
1434
- The Racecar integration provides tracing for Racecar jobs.
1435
-
1436
- You can enable it through `Datadog.configure`:
1437
-
1438
- ```ruby
1439
- require 'ddtrace'
1440
-
1441
- Datadog.configure do |c|
1442
- c.tracing.instrument :racecar, options
1443
- end
1444
- ```
1445
-
1446
- Where `options` is an optional `Hash` that accepts the following parameters:
1447
-
1448
- | Key | Description | Default |
1449
- | --- | ----------- | ------- |
1450
- | `service_name` | Service name used for `racecar` instrumentation | `'racecar'` |
1451
-
1452
- ### Rack
1453
-
1454
- The Rack integration provides a middleware that traces all requests before they reach the underlying framework or application. It responds to the Rack minimal interface, providing reasonable values that can be retrieved at the Rack level.
1455
-
1456
- This integration is automatically activated with web frameworks like Rails. If you're using a plain Rack application, enable the integration it to your `config.ru`:
1457
-
1458
- ```ruby
1459
- # config.ru example
1460
- require 'ddtrace'
1461
-
1462
- Datadog.configure do |c|
1463
- c.tracing.instrument :rack, options
1464
- end
1465
-
1466
- use Datadog::Tracing::Contrib::Rack::TraceMiddleware
1467
-
1468
- app = proc do |env|
1469
- [ 200, {'Content-Type' => 'text/plain'}, ['OK'] ]
1470
- end
1471
-
1472
- run app
1473
- ```
1474
-
1475
- Where `options` is an optional `Hash` that accepts the following parameters:
1476
-
1477
- | Key | Description | Default |
1478
- | --- | ----------- | ------- |
1479
- | `application` | Your Rack application. Required for `middleware_names`. | `nil` |
1480
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) so that this service trace is connected with a trace of another service if tracing headers are received | `true` |
1481
- | `headers` | Hash of HTTP request or response headers to add as tags to the `rack.request`. Accepts `request` and `response` keys with Array values e.g. `['Last-Modified']`. Adds `http.request.headers.*` and `http.response.headers.*` tags respectively. | `{ response: ['Content-Type', 'X-Request-ID'] }` |
1482
- | `middleware_names` | Enable this if you want to use the last executed middleware class as the resource name for the `rack` span. If enabled alongside the `rails` instrumention, `rails` takes precedence by setting the `rack` resource name to the active `rails` controller when applicable. Requires `application` option to use. | `false` |
1483
- | `quantize` | Hash containing options for quantization. May include `:query` or `:fragment`. | `{}` |
1484
- | `quantize.query` | Hash containing options for query portion of URL quantization. May include `:show` or `:exclude`. See options below. Option must be nested inside the `quantize` option. | `{}` |
1485
- | `quantize.query.show` | Defines which values should always be shown. Shows no values by default. May be an Array of strings, or `:all` to show all values. Option must be nested inside the `query` option. | `nil` |
1486
- | `quantize.query.exclude` | Defines which values should be removed entirely. Excludes nothing by default. May be an Array of strings, or `:all` to remove the query string entirely. Option must be nested inside the `query` option. | `nil` |
1487
- | `quantize.fragment` | Defines behavior for URL fragments. Removes fragments by default. May be `:show` to show URL fragments. Option must be nested inside the `quantize` option. | `nil` |
1488
- | `request_queuing` | Track HTTP request time spent in the queue of the frontend server. See [HTTP request queuing](#http-request-queuing) for setup details. Set to `true` to enable. | `false` |
1489
- | `web_service_name` | Service name for frontend server request queuing spans. (e.g. `'nginx'`) | `'web-server'` |
1490
-
1491
- **Configuring URL quantization behavior**
1492
-
1493
- ```ruby
1494
- Datadog.configure do |c|
1495
- # Default behavior: all values are quantized, fragment is removed.
1496
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path?category_id&sort_by
1497
- # http://example.com/path?categories[]=1&categories[]=2 --> http://example.com/path?categories[]
1498
-
1499
- # Show values for any query string parameter matching 'category_id' exactly
1500
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path?category_id=1&sort_by
1501
- c.tracing.instrument :rack, quantize: { query: { show: ['category_id'] } }
1502
-
1503
- # Show all values for all query string parameters
1504
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path?category_id=1&sort_by=asc
1505
- c.tracing.instrument :rack, quantize: { query: { show: :all } }
1506
-
1507
- # Totally exclude any query string parameter matching 'sort_by' exactly
1508
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path?category_id
1509
- c.tracing.instrument :rack, quantize: { query: { exclude: ['sort_by'] } }
1510
-
1511
- # Remove the query string entirely
1512
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path
1513
- c.tracing.instrument :rack, quantize: { query: { exclude: :all } }
1514
-
1515
- # Show URL fragments
1516
- # http://example.com/path?category_id=1&sort_by=asc#featured --> http://example.com/path?category_id&sort_by#featured
1517
- c.tracing.instrument :rack, quantize: { fragment: :show }
1518
- end
1519
- ```
1520
-
1521
- ### Rails
1522
-
1523
- The Rails integration will trace requests, database calls, templates rendering, and cache read/write/delete operations. The integration makes use of the Active Support Instrumentation, listening to the Notification API so that any operation instrumented by the API is traced.
1524
-
1525
- To enable the Rails instrumentation, create an initializer file in your `config/initializers` folder:
1526
-
1527
- ```ruby
1528
- # config/initializers/datadog.rb
1529
- require 'ddtrace'
1530
-
1531
- Datadog.configure do |c|
1532
- c.tracing.instrument :rails, options
1533
- end
1534
- ```
1535
-
1536
- Where `options` is an optional `Hash` that accepts the following parameters:
1537
-
1538
- | Key | Description | Default |
1539
- | --- | ----------- | ------- |
1540
- | `cache_service` | Cache service name used when tracing cache activity | `'<app_name>-cache'` |
1541
- | `database_service` | Database service name used when tracing database activity | `'<app_name>-<adapter_name>'` |
1542
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) so that this service trace is connected with a trace of another service if tracing headers are received | `true` |
1543
- | `exception_controller` | Class or Module which identifies a custom exception controller class. Tracer provides improved error behavior when it can identify custom exception controllers. By default, without this option, it 'guesses' what a custom exception controller looks like. Providing this option aids this identification. | `nil` |
1544
- | `middleware` | Add the trace middleware to the Rails application. Set to `false` if you don't want the middleware to load. | `true` |
1545
- | `middleware_names` | Enables any short-circuited middleware requests to display the middleware name as a resource for the trace. | `false` |
1546
- | `service_name` | Service name used when tracing application requests (on the `rack` level) | `'<app_name>'` (inferred from your Rails application namespace) |
1547
- | `template_base_path` | Used when the template name is parsed. If you don't store your templates in the `views/` folder, you may need to change this value | `'views/'` |
1548
-
1549
- **Supported versions**
1550
-
1551
- | MRI Versions | JRuby Versions | Rails Versions |
1552
- | ------------- | -------------- | -------------- |
1553
- | 2.1 | | 3.2 - 4.2 |
1554
- | 2.2 - 2.3 | | 3.2 - 5.2 |
1555
- | 2.4 | | 4.2.8 - 5.2 |
1556
- | 2.5 | | 4.2.8 - 6.1 |
1557
- | 2.6 - 2.7 | 9.2 | 5.0 - 6.1 |
1558
- | 3.0 | | 6.1 |
1559
-
1560
- ### Rake
1561
-
1562
- You can add instrumentation around your Rake tasks by activating the `rake` integration. Each task and its subsequent subtasks will be traced.
1563
-
1564
- To activate Rake task tracing, add the following to your `Rakefile`:
1565
-
1566
- ```ruby
1567
- # At the top of your Rakefile:
1568
- require 'rake'
1569
- require 'ddtrace'
1570
-
1571
- Datadog.configure do |c|
1572
- c.tracing.instrument :rake, options
1573
- end
1574
-
1575
- task :my_task do
1576
- # Do something task work here...
1577
- end
1578
-
1579
- Rake::Task['my_task'].invoke
1580
- ```
1581
-
1582
- Where `options` is an optional `Hash` that accepts the following parameters:
1583
-
1584
- | Key | Description | Default |
1585
- | --- | ----------- | ------- |
1586
- | `enabled` | Defines whether Rake tasks should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
1587
- | `quantize` | Hash containing options for quantization of task arguments. See below for more details and examples. | `{}` |
1588
- | `service_name` | Service name used for `rake` instrumentation | `'rake'` |
1589
-
1590
- **Configuring task quantization behavior**
1591
-
1592
- ```ruby
1593
- Datadog.configure do |c|
1594
- # Given a task that accepts :one, :two, :three...
1595
- # Invoked with 'foo', 'bar', 'baz'.
1596
-
1597
- # Default behavior: all arguments are quantized.
1598
- # `rake.invoke.args` tag --> ['?']
1599
- # `rake.execute.args` tag --> { one: '?', two: '?', three: '?' }
1600
- c.tracing.instrument :rake
1601
-
1602
- # Show values for any argument matching :two exactly
1603
- # `rake.invoke.args` tag --> ['?']
1604
- # `rake.execute.args` tag --> { one: '?', two: 'bar', three: '?' }
1605
- c.tracing.instrument :rake, quantize: { args: { show: [:two] } }
1606
-
1607
- # Show all values for all arguments.
1608
- # `rake.invoke.args` tag --> ['foo', 'bar', 'baz']
1609
- # `rake.execute.args` tag --> { one: 'foo', two: 'bar', three: 'baz' }
1610
- c.tracing.instrument :rake, quantize: { args: { show: :all } }
1611
-
1612
- # Totally exclude any argument matching :three exactly
1613
- # `rake.invoke.args` tag --> ['?']
1614
- # `rake.execute.args` tag --> { one: '?', two: '?' }
1615
- c.tracing.instrument :rake, quantize: { args: { exclude: [:three] } }
1616
-
1617
- # Remove the arguments entirely
1618
- # `rake.invoke.args` tag --> ['?']
1619
- # `rake.execute.args` tag --> {}
1620
- c.tracing.instrument :rake, quantize: { args: { exclude: :all } }
1621
- end
1622
- ```
1623
-
1624
- ### Redis
1625
-
1626
- The Redis integration will trace simple calls as well as pipelines.
1627
-
1628
- ```ruby
1629
- require 'redis'
1630
- require 'ddtrace'
1631
-
1632
- Datadog.configure do |c|
1633
- c.tracing.instrument :redis, options
1634
- end
1635
-
1636
- # Perform Redis commands
1637
- redis = Redis.new
1638
- redis.set 'foo', 'bar'
1639
- ```
1640
-
1641
- Where `options` is an optional `Hash` that accepts the following parameters:
1642
-
1643
- | Key | Description | Default |
1644
- | --- | ----------- | ------- |
1645
- | `service_name` | Service name used for `redis` instrumentation | `'redis'` |
1646
- | `command_args` | Show the command arguments (e.g. `key` in `GET key`) as resource name and tag | true |
1647
-
1648
- You can also set *per-instance* configuration as it follows:
1649
-
1650
- ```ruby
1651
- require 'redis'
1652
- require 'ddtrace'
1653
-
1654
- Datadog.configure do |c|
1655
- c.tracing.instrument :redis # Enabling integration instrumentation is still required
1656
- end
1657
-
1658
- customer_cache = Redis.new
1659
- invoice_cache = Redis.new
1660
-
1661
- Datadog.configure_onto(customer_cache, service_name: 'customer-cache')
1662
- Datadog.configure_onto(invoice_cache, service_name: 'invoice-cache')
1663
-
1664
- # Traced call will belong to `customer-cache` service
1665
- customer_cache.get(...)
1666
- # Traced call will belong to `invoice-cache` service
1667
- invoice_cache.get(...)
1668
- ```
1669
-
1670
- **Configuring trace settings per connection**
1671
-
1672
- You can configure trace settings per connection by using the `describes` option:
1673
-
1674
- ```ruby
1675
- # Provide a `:describes` option with a connection key.
1676
- # Any of the following keys are acceptable and equivalent to one another.
1677
- # If a block is provided, it yields a Settings object that
1678
- # accepts any of the configuration options listed above.
1679
-
1680
- Datadog.configure do |c|
1681
- # The default configuration for any redis client
1682
- c.tracing.instrument :redis, service_name: 'redis-default'
1683
-
1684
- # The configuration matching a given unix socket.
1685
- c.tracing.instrument :redis, describes: { url: 'unix://path/to/file' }, service_name: 'redis-unix'
1686
-
1687
- # For network connections, only these fields are considered during matching:
1688
- # scheme, host, port, db
1689
- # Other fields are ignored.
1690
-
1691
- # Network connection string
1692
- c.tracing.instrument :redis, describes: 'redis://127.0.0.1:6379/0', service_name: 'redis-connection-string'
1693
- c.tracing.instrument :redis, describes: { url: 'redis://127.0.0.1:6379/1' }, service_name: 'redis-connection-url'
1694
- # Network client hash
1695
- c.tracing.instrument :redis, describes: { host: 'my-host.com', port: 6379, db: 1, scheme: 'redis' }, service_name: 'redis-connection-hash'
1696
- # Only a subset of the connection hash
1697
- c.tracing.instrument :redis, describes: { host: ENV['APP_CACHE_HOST'], port: ENV['APP_CACHE_PORT'] }, service_name: 'redis-cache'
1698
- c.tracing.instrument :redis, describes: { host: ENV['SIDEKIQ_CACHE_HOST'] }, service_name: 'redis-sidekiq'
1699
- end
1700
- ```
1701
-
1702
- When multiple `describes` configurations match a connection, the latest configured rule that matches will be applied.
1703
-
1704
- ### Resque
1705
-
1706
- The Resque integration uses Resque hooks that wraps the `perform` method.
1707
-
1708
- To add tracing to a Resque job:
1709
-
1710
- ```ruby
1711
- require 'resque'
1712
- require 'ddtrace'
1713
-
1714
- Datadog.configure do |c|
1715
- c.tracing.instrument :resque, **options
1716
- end
1717
- ```
1718
-
1719
- Where `options` is an optional `Hash` that accepts the following parameters:
1720
-
1721
- | Key | Description | Default |
1722
- | --- | ----------- | ------- |
1723
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1724
-
1725
- ### Rest Client
1726
-
1727
- The `rest-client` integration is available through the `ddtrace` middleware:
1728
-
1729
- ```ruby
1730
- require 'rest_client'
1731
- require 'ddtrace'
1732
-
1733
- Datadog.configure do |c|
1734
- c.tracing.instrument :rest_client, options
1735
- end
1736
- ```
1737
-
1738
- Where `options` is an optional `Hash` that accepts the following parameters:
1739
-
1740
- | Key | Description | Default |
1741
- | --- | ----------- | ------- |
1742
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) | `true` |
1743
- | `service_name` | Service name for `rest_client` instrumentation. | `'rest_client'` |
1744
-
1745
- ### RSpec
1746
-
1747
- RSpec integration will trace all executions of example groups and examples when using `rspec` test framework.
1748
-
1749
- To activate your integration, use the `Datadog.configure` method:
1750
-
1751
- ```ruby
1752
- require 'rspec'
1753
- require 'ddtrace'
1754
-
1755
- # Configure default RSpec integration
1756
- Datadog.configure do |c|
1757
- c.ci.instrument :rspec, options
1758
- end
1759
- ```
1760
-
1761
- Where `options` is an optional `Hash` that accepts the following parameters:
1762
-
1763
- | Key | Description | Default |
1764
- | --- | ----------- | ------- |
1765
- | `enabled` | Defines whether RSpec tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
1766
- | `service_name` | Service name used for `rspec` instrumentation. | `'rspec'` |
1767
- | `operation_name` | Operation name used for `rspec` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'rspec.example'` |
1768
-
1769
- ### Sequel
1770
-
1771
- The Sequel integration traces queries made to your database.
1772
-
1773
- ```ruby
1774
- require 'sequel'
1775
- require 'ddtrace'
1776
-
1777
- # Connect to database
1778
- database = Sequel.sqlite
1779
-
1780
- # Create a table
1781
- database.create_table :articles do
1782
- primary_key :id
1783
- String :name
1784
- end
1785
-
1786
- Datadog.configure do |c|
1787
- c.tracing.instrument :sequel, options
1788
- end
1789
-
1790
- # Perform a query
1791
- articles = database[:articles]
1792
- articles.all
1793
- ```
1794
-
1795
- Where `options` is an optional `Hash` that accepts the following parameters:
1796
-
1797
- | Key | Description | Default |
1798
- | --- | ----------- | ------- |
1799
- | `service_name` | Service name for `sequel` instrumentation | Name of database adapter (e.g. `'mysql2'`) |
1800
-
1801
- **Configuring databases to use different settings**
1802
-
1803
- If you use multiple databases with Sequel, you can give each of them different settings by configuring their respective `Sequel::Database` objects:
1804
-
1805
- ```ruby
1806
- sqlite_database = Sequel.sqlite
1807
- postgres_database = Sequel.connect('postgres://user:password@host:port/database_name')
1808
-
1809
- # Configure each database with different service names
1810
- Datadog.configure_onto(sqlite_database, service_name: 'my-sqlite-db')
1811
- Datadog.configure_onto(postgres_database, service_name: 'my-postgres-db')
1812
- ```
1813
-
1814
- ### Shoryuken
1815
-
1816
- The Shoryuken integration is a server-side middleware which will trace job executions.
1817
-
1818
- You can enable it through `Datadog.configure`:
1819
-
1820
- ```ruby
1821
- require 'ddtrace'
1822
-
1823
- Datadog.configure do |c|
1824
- c.tracing.instrument :shoryuken, options
1825
- end
1826
- ```
1827
-
1828
- Where `options` is an optional `Hash` that accepts the following parameters:
1829
-
1830
- | Key | Description | Default |
1831
- | --- | ----------- | ------- |
1832
- | `tag_body` | Tag spans with the SQS message body `true` or `false` | `false` |
1833
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1834
-
1835
- ### Sidekiq
1836
-
1837
- The Sidekiq integration is a client-side & server-side middleware which will trace job queuing and executions respectively.
1838
-
1839
- You can enable it through `Datadog.configure`:
1840
-
1841
- ```ruby
1842
- require 'ddtrace'
1843
-
1844
- Datadog.configure do |c|
1845
- c.tracing.instrument :sidekiq, options
1846
- end
1847
- ```
1848
-
1849
- Where `options` is an optional `Hash` that accepts the following parameters:
1850
-
1851
- | Key | Description | Default |
1852
- | --- | ----------- | ------- |
1853
- | `tag_args` | Enable tagging of job arguments. `true` for on, `false` for off. | `false` |
1854
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1855
-
1856
- ### Sinatra
1857
-
1858
- The Sinatra integration traces requests and template rendering.
1859
-
1860
- To start using the tracing client, make sure you import `ddtrace` and `use :sinatra` after either `sinatra` or `sinatra/base`, and before you define your application/routes:
1861
-
1862
- #### Classic application
1863
-
1864
- ```ruby
1865
- require 'sinatra'
1866
- require 'ddtrace'
1867
-
1868
- Datadog.configure do |c|
1869
- c.tracing.instrument :sinatra, options
1870
- end
1871
-
1872
- get '/' do
1873
- 'Hello world!'
1874
- end
1875
- ```
1876
-
1877
- #### Modular application
1878
-
1879
- ```ruby
1880
- require 'sinatra/base'
1881
- require 'ddtrace'
1882
-
1883
- Datadog.configure do |c|
1884
- c.tracing.instrument :sinatra, options
1885
- end
1886
-
1887
- class NestedApp < Sinatra::Base
1888
- register Datadog::Tracing::Contrib::Sinatra::Tracer
1889
-
1890
- get '/nested' do
1891
- 'Hello from nested app!'
1892
- end
1893
- end
1894
-
1895
- class App < Sinatra::Base
1896
- register Datadog::Tracing::Contrib::Sinatra::Tracer
1897
-
1898
- use NestedApp
1899
-
1900
- get '/' do
1901
- 'Hello world!'
1902
- end
1903
- end
1904
- ```
1905
-
1906
- Ensure you register `Datadog::Tracing::Contrib::Sinatra::Tracer` as a middleware before you mount your nested applications.
1907
-
1908
- #### Instrumentation options
1909
-
1910
- `options` is an optional `Hash` that accepts the following parameters:
1911
-
1912
- | Key | Description | Default |
1913
- | --- | ----------- | ------- |
1914
- | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) so that this service trace is connected with a trace of another service if tracing headers are received | `true` |
1915
- | `headers` | Hash of HTTP request or response headers to add as tags to the `sinatra.request`. Accepts `request` and `response` keys with Array values e.g. `['Last-Modified']`. Adds `http.request.headers.*` and `http.response.headers.*` tags respectively. | `{ response: ['Content-Type', 'X-Request-ID'] }` |
1916
- | `resource_script_names` | Prepend resource names with script name | `false` |
1917
-
1918
- ### Sneakers
1919
-
1920
- The Sneakers integration is a server-side middleware which will trace job executions.
1921
-
1922
- You can enable it through `Datadog.configure`:
1923
-
1924
- ```ruby
1925
- require 'ddtrace'
1926
-
1927
- Datadog.configure do |c|
1928
- c.tracing.instrument :sneakers, options
1929
- end
1930
- ```
1931
-
1932
- Where `options` is an optional `Hash` that accepts the following parameters:
1933
-
1934
- | Key | Description | Default |
1935
- | --- | ----------- | ------- |
1936
- | `enabled` | Defines whether Sneakers should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
1937
- | `tag_body` | Enable tagging of job message. `true` for on, `false` for off. | `false` |
1938
- | `error_handler` | Custom error handler invoked when a job raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
1939
-
1940
- ### Sucker Punch
1941
-
1942
- The `sucker_punch` integration traces all scheduled jobs:
1943
-
1944
- ```ruby
1945
- require 'ddtrace'
1946
-
1947
- Datadog.configure do |c|
1948
- c.tracing.instrument :sucker_punch
1949
- end
1950
-
1951
- # Execution of this job is traced
1952
- LogJob.perform_async('login')
1953
- ```
1954
-
1955
- ## Additional configuration
1956
-
1957
- To change the default behavior of Datadog tracing, you can set environment variables, or provide custom options inside a `Datadog.configure` block, e.g.:
1958
-
1959
- ```ruby
1960
- Datadog.configure do |c|
1961
- c.service = 'billing-api'
1962
- c.env = ENV['RACK_ENV']
1963
-
1964
- c.tracing.report_hostname = true
1965
- c.tracing.test_mode.enabled = (ENV['RACK_ENV'] == 'test')
1966
- end
1967
- ```
1968
-
1969
- **Available configuration options:**
1970
-
1971
- | Setting | Env Var | Default | Description |
1972
- |---------------------------------------------------------|--------------------------------|-------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1973
- | **Global** | | | |
1974
- | `agent.host` | `DD_AGENT_HOST` | `127.0.0.1` | Hostname of agent to where trace data will be sent. |
1975
- | `agent.port` | `DD_TRACE_AGENT_PORT` | `8126` | Port of agent host to where trace data will be sent. |
1976
- | | `DD_TRACE_AGENT_URL` | `nil` | Sets the URL endpoint where traces are sent. Has priority over `agent.host` and `agent.port`. |
1977
- | `diagnostics.debug` | `DD_TRACE_DEBUG` | `false` | Enables or disables debug mode. Prints verbose logs. **NOT recommended for production or other sensitive environments.** See [Debugging and diagnostics](#debugging-and-diagnostics) for more details. |
1978
- | `diagnostics.startup_logs.enabled` | `DD_TRACE_STARTUP_LOGS` | `nil` | Prints startup configuration and diagnostics to log. For assessing state of tracing at application startup. See [Debugging and diagnostics](#debugging-and-diagnostics) for more details. |
1979
- | `env` | `DD_ENV` | `nil` | Your application environment. (e.g. `production`, `staging`, etc.) This value is set as a tag on all traces. |
1980
- | `service` | `DD_SERVICE` | *Ruby filename* | Your application's default service name. (e.g. `billing-api`) This value is set as a tag on all traces. |
1981
- | `tags` | `DD_TAGS` | `nil` | Custom tags in value pairs separated by `,` (e.g. `layer:api,team:intake`) These tags are set on all traces. See [Environment and tags](#environment-and-tags) for more details. |
1982
- | `time_now_provider` | | `->{ Time.now }` | Changes how time is retrieved. See [Setting the time provider](#Setting the time provider) for more details. |
1983
- | `version` | `DD_VERSION` | `nil` | Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.) This value is set as a tag on all traces. |
1984
- | **Tracing** | | | |
1985
- | `tracing.analytics.enabled` | `DD_TRACE_ANALYTICS_ENABLED` | `nil` | Enables or disables trace analytics. See [Sampling](#sampling) for more details. |
1986
- | `tracing.distributed_tracing.propagation_extract_style` | `DD_PROPAGATION_STYLE_EXTRACT` | `['Datadog','B3','B3 single header']` | Distributed tracing header formats to extract. See [Distributed Tracing](#distributed-tracing) for more details. |
1987
- | `tracing.distributed_tracing.propagation_inject_style` | `DD_PROPAGATION_STYLE_INJECT` | `['Datadog']` | Distributed tracing header formats to inject. See [Distributed Tracing](#distributed-tracing) for more details. |
1988
- | `tracing.enabled` | `DD_TRACE_ENABLED` | `true` | Enables or disables tracing. If set to `false` instrumentation will still run, but no traces are sent to the trace agent. |
1989
- | `tracing.instrument(<integration-name>, <options...>)` | | | Activates instrumentation for a specific library. See [Integration instrumentation](#integration-instrumentation) for more details. |
1990
- | `tracing.log_injection` | `DD_LOGS_INJECTION` | `true` | Injects [Trace Correlation](#trace-correlation) information into Rails logs if present. Supports the default logger (`ActiveSupport::TaggedLogging`), `lograge`, and `semantic_logger`. |
1991
- | `tracing.partial_flush.enabled` | | `false` | Enables or disables partial flushing. Partial flushing submits completed portions of a trace to the agent. Used when tracing instruments long running tasks (e.g. jobs) with many spans. |
1992
- | `tracing.partial_flush.min_spans_threshold` | | `500` | The number of spans that must be completed in a trace before partial flushing submits those completed spans. |
1993
- | `tracing.sampler` | | `nil` | Advanced usage only. Sets a custom `Datadog::Tracing::Sampling::Sampler` instance. If provided, the tracer will use this sampler to determine sampling behavior. See [Application-side sampling](#application-side-sampling) for details. |
1994
- | `tracing.sampling.default_rate` | `DD_TRACE_SAMPLE_RATE` | `nil` | Sets the trace sampling rate between `0.0` (0%) and `1.0` (100%). See [Application-side sampling](#application-side-sampling) for details. |
1995
- | `tracing.sampling.rate_limit` | `DD_TRACE_RATE_LIMIT` | `100` (per second) | Sets a maximum number of traces per second to sample. Set a rate limit to avoid the ingestion volume overages in the case of traffic spikes. |
1996
- | `tracing.report_hostname` | `DD_TRACE_REPORT_HOSTNAME` | `false` | Adds hostname tag to traces. |
1997
- | `tracing.test_mode.enabled` | `DD_TRACE_TEST_MODE_ENABLED` | `false` | Enables or disables test mode, for use of tracing in test suites. |
1998
- | `tracing.test_mode.trace_flush` | | `nil` | Object that determines trace flushing behavior. |
1999
-
2000
- #### Custom logging
2001
-
2002
- By default, all logs are processed by the default Ruby logger. When using Rails, you should see the messages in your application log file.
2003
-
2004
- Datadog client log messages are marked with `[ddtrace]` so you should be able to isolate them from other messages.
2005
-
2006
- Additionally, it is possible to override the default logger and replace it by a custom one. This is done using the `log` setting.
2007
-
2008
- ```ruby
2009
- f = File.new("my-custom.log", "w+") # Log messages should go there
2010
- Datadog.configure do |c|
2011
- c.logger.instance = Logger.new(f) # Overriding the default logger
2012
- c.logger.level = ::Logger::INFO
2013
- end
2014
-
2015
- Datadog.logger.info { "this is typically called by tracing code" }
2016
- ```
2017
-
2018
- #### Environment and tags
2019
-
2020
- By default, the trace agent (not this library, but the program running in the background collecting data from various clients) uses the tags set in the agent config file. You can configure the application to automatically tag your traces and metrics, using the following environment variables:
2021
-
2022
- - `DD_ENV`: Your application environment (e.g. `production`, `staging`, etc.)
2023
- - `DD_SERVICE`: Your application's default service name (e.g. `billing-api`)
2024
- - `DD_VERSION`: Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.)
2025
- - `DD_TAGS`: Custom tags in value pairs separated by `,` (e.g. `layer:api,team:intake`)
2026
- - If `DD_ENV`, `DD_SERVICE` or `DD_VERSION` are set, it will override any respective `env`/`service`/`version` tag defined in `DD_TAGS`.
2027
- - If `DD_ENV`, `DD_SERVICE` or `DD_VERSION` are NOT set, tags defined in `DD_TAGS` will be used to populate `env`/`service`/`version` respectively.
2028
-
2029
- These values can also be overridden at the tracer level:
2030
-
2031
- ```ruby
2032
- Datadog.configure do |c|
2033
- c.service = 'billing-api'
2034
- c.env = 'test'
2035
- c.tags = { 'team' => 'qa' }
2036
- c.version = '1.3-alpha'
2037
- end
2038
- ```
2039
-
2040
- This enables you to set this value on a per application basis, so you can have for example several applications reporting for different environments on the same host.
2041
-
2042
- Tags can also be set directly on individual spans, which will supersede any conflicting tags defined at the application level.
2043
-
2044
- #### Debugging and diagnostics
2045
-
2046
- There are two different suggested means of producing diagnostics for tracing:
2047
-
2048
- ##### Enabling debug mode
2049
-
2050
- Switching the library into debug mode will produce verbose, detailed logs about tracing activity, including any suppressed errors. This output can be helpful in identifying errors, or confirming trace output to the agent.
2051
-
2052
- You can enable this via `diagnostics.debug = true` or `DD_TRACE_DEBUG`.
2053
-
2054
- ```ruby
2055
- Datadog.configure { |c| c.diagnostics.debug = true }
2056
- ```
2057
-
2058
- **We do NOT recommend use of this feature in production or other sensitive environments**, as it can be very verbose under load. It's best to use this in a controlled environment where you can control application load.
2059
-
2060
- ##### Enabling startup logs
2061
-
2062
- Startup logs produce a report of tracing state when the application is initially configured. This can be helpful for confirming that configuration and instrumentation is activated correctly.
2063
-
2064
- You can enable this via `diagnostics.startup_logs.enabled = true` or `DD_TRACE_STARTUP_LOGS`.
2065
-
2066
- ```ruby
2067
- Datadog.configure { |c| c.diagnostics.startup_logs.enabled = true }
2068
- ```
2069
-
2070
- By default, this will be activated whenever `ddtrace` detects the application is running in a non-development environment.
2071
-
2072
- ### Sampling
2073
-
2074
- #### Application-side sampling
2075
-
2076
- While the trace agent can sample traces to reduce bandwidth usage, application-side sampling reduces the performance overhead.
2077
-
2078
- The default sampling rate can be set between `0.0` (0%) and `1.0` (100%). Configure the rate in order to control the volume of traces sent to Datadog. When this configuration is not set, the Datadog agent will distribute a default sampling rate of 10 traces per second.
2079
-
2080
- Set this value via `DD_TRACE_SAMPLE_RATE` or `Datadog.configure { |c| c.tracing.sampling.default_rate = <value> }`.
2081
-
2082
- Alternatively, you may provide your own sampler. The `Datadog::Tracing::Sampling::RateSampler` samples a ratio of the traces. For example:
2083
-
2084
- ```ruby
2085
- # Sample rate is between 0 (nothing sampled) to 1 (everything sampled).
2086
- sampler = Datadog::Tracing::Sampling::RateSampler.new(0.5) # sample 50% of the traces
2087
-
2088
- Datadog.configure do |c|
2089
- c.tracing.sampler = sampler
2090
- end
2091
- ```
2092
-
2093
- See [Additional Configuration](#additional-configuration) for more details about these settings.
2094
-
2095
- #### Priority sampling
2096
-
2097
- Priority sampling decides whether to keep a trace by using a priority attribute propagated for distributed traces. Its value indicates to the Agent and the backend about how important the trace is.
2098
-
2099
- The sampler can set the priority to the following values:
2100
-
2101
- - `Datadog::Tracing::Sampling::Ext::Priority::AUTO_REJECT`: the sampler automatically decided to reject the trace.
2102
- - `Datadog::Tracing::Sampling::Ext::Priority::AUTO_KEEP`: the sampler automatically decided to keep the trace.
2103
-
2104
- Priority sampling is enabled by default. Enabling it ensures that your sampled distributed traces will be complete. Once enabled, the sampler will automatically assign a priority of 0 or 1 to traces, depending on their service and volume.
2105
-
2106
- You can also set this priority manually to either drop a non-interesting trace or to keep an important one. For that, set the `TraceOperation#sampling_priority` to:
2107
-
2108
- - `Datadog::Tracing::Sampling::Ext::Priority::USER_REJECT`: the user asked to reject the trace.
2109
- - `Datadog::Tracing::Sampling::Ext::Priority::USER_KEEP`: the user asked to keep the trace.
2110
-
2111
- When not using [distributed tracing](#distributed-tracing), you may change the priority at any time, as long as the trace incomplete. But it has to be done before any context propagation (fork, RPC calls) to be useful in a distributed context. Changing the priority after the context has been propagated causes different parts of a distributed trace to use different priorities. Some parts might be kept, some parts might be rejected, and this can cause the trace to be partially stored and remain incomplete.
2112
-
2113
- For this reason, if you change the priority, we recommend you do it as early as possible.
2114
-
2115
- To change the sampling priority, you can use the following methods:
2116
-
2117
- ```ruby
2118
- # Rejects the active trace
2119
- Datadog::Tracing.reject!
2120
-
2121
- # Keeps the active trace
2122
- Datadog::Tracing.keep!
2123
- ```
2124
-
2125
- It's safe to use `Datadog::Tracing.reject!` and `Datadog::Tracing.keep!` when no trace is active.
2126
-
2127
- You can also reject a specific trace instance:
2128
-
2129
- ```ruby
2130
- # First, grab the active span
2131
- trace = Datadog::Tracing.active_trace
2132
-
2133
- # Rejects the trace
2134
- trace.reject!
2135
-
2136
- # Keeps the trace
2137
- trace.keep!
2138
- ```
2139
-
2140
- ### Distributed Tracing
2141
-
2142
- Distributed tracing allows traces to be propagated across multiple instrumented applications so that a request can be presented as a single trace, rather than a separate trace per service.
2143
-
2144
- To trace requests across application boundaries, the following must be propagated between each application:
2145
-
2146
- | Property | Type | Description |
2147
- | --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
2148
- | **Trace ID** | Integer | ID of the trace. This value should be the same across all requests that belong to the same trace. |
2149
- | **Parent Span ID** | Integer | ID of the span in the service originating the request. This value will always be different for each request within a trace. |
2150
- | **Sampling Priority** | Integer | Sampling priority level for the trace. This value should be the same across all requests that belong to the same trace. |
2151
-
2152
- Such propagation can be visualized as:
2153
-
2154
- ```
2155
- Service A:
2156
- Trace ID: 100000000000000001
2157
- Parent ID: 0
2158
- Span ID: 100000000000000123
2159
- Priority: 1
2160
-
2161
- |
2162
- | Service B Request:
2163
- | Metadata:
2164
- | Trace ID: 100000000000000001
2165
- | Parent ID: 100000000000000123
2166
- | Priority: 1
2167
- |
2168
- V
2169
-
2170
- Service B:
2171
- Trace ID: 100000000000000001
2172
- Parent ID: 100000000000000123
2173
- Span ID: 100000000000000456
2174
- Priority: 1
2175
-
2176
- |
2177
- | Service C Request:
2178
- | Metadata:
2179
- | Trace ID: 100000000000000001
2180
- | Parent ID: 100000000000000456
2181
- | Priority: 1
2182
- |
2183
- V
2184
-
2185
- Service C:
2186
- Trace ID: 100000000000000001
2187
- Parent ID: 100000000000000456
2188
- Span ID: 100000000000000789
2189
- Priority: 1
2190
- ```
2191
-
2192
- **Via HTTP**
2193
-
2194
- For HTTP requests between instrumented applications, this trace metadata is propagated by use of HTTP Request headers:
2195
-
2196
- | Property | Type | HTTP Header name |
2197
- | --------------------- | ------- | ----------------------------- |
2198
- | **Trace ID** | Integer | `x-datadog-trace-id` |
2199
- | **Parent Span ID** | Integer | `x-datadog-parent-id` |
2200
- | **Sampling Priority** | Integer | `x-datadog-sampling-priority` |
2201
-
2202
- Such that:
2203
-
2204
- ```
2205
- Service A:
2206
- Trace ID: 100000000000000001
2207
- Parent ID: 0
2208
- Span ID: 100000000000000123
2209
- Priority: 1
2210
-
2211
- |
2212
- | Service B HTTP Request:
2213
- | Headers:
2214
- | x-datadog-trace-id: 100000000000000001
2215
- | x-datadog-parent-id: 100000000000000123
2216
- | x-datadog-sampling-priority: 1
2217
- |
2218
- V
2219
-
2220
- Service B:
2221
- Trace ID: 100000000000000001
2222
- Parent ID: 100000000000000123
2223
- Span ID: 100000000000000456
2224
- Priority: 1
2225
-
2226
- |
2227
- | Service C HTTP Request:
2228
- | Headers:
2229
- | x-datadog-trace-id: 100000000000000001
2230
- | x-datadog-parent-id: 100000000000000456
2231
- | x-datadog-sampling-priority: 1
2232
- |
2233
- V
2234
-
2235
- Service C:
2236
- Trace ID: 100000000000000001
2237
- Parent ID: 100000000000000456
2238
- Span ID: 100000000000000789
2239
- Priority: 1
2240
- ```
2241
-
2242
- **Distributed header formats**
2243
-
2244
- Tracing supports the following distributed trace formats:
2245
-
2246
- - `Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG` (Default)
2247
- - `Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3`
2248
- - `Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER`
2249
-
2250
- You can enable/disable the use of these formats via `Datadog.configure`:
2251
-
2252
- ```ruby
2253
- Datadog.configure do |c|
2254
- # List of header formats that should be extracted
2255
- c.tracing.distributed_tracing.propagation_extract_style = [
2256
- Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG,
2257
- Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3,
2258
- Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
2259
-
2260
- ]
2261
-
2262
- # List of header formats that should be injected
2263
- c.tracing.distributed_tracing.propagation_inject_style = [
2264
- Datadog::Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG
2265
- ]
2266
- end
2267
- ```
2268
-
2269
- **Activating distributed tracing for integrations**
2270
-
2271
- Many integrations included in `ddtrace` support distributed tracing. Distributed tracing is enabled by default in Agent v7 and most versions of Agent v6. If needed, you can activate distributed tracing with configuration settings.
2272
-
2273
- - If your application receives requests from services with distributed tracing activated, you must activate distributed tracing on the integrations that handle these requests (e.g. Rails)
2274
- - If your application send requests to services with distributed tracing activated, you must activate distributed tracing on the integrations that send these requests (e.g. Faraday)
2275
- - If your application both sends and receives requests implementing distributed tracing, it must activate all integrations that handle these requests.
2276
-
2277
- For more details on how to activate distributed tracing for integrations, see their documentation:
2278
-
2279
- - [Excon](#excon)
2280
- - [Faraday](#faraday)
2281
- - [Rest Client](#rest-client)
2282
- - [Net/HTTP](#nethttp)
2283
- - [Rack](#rack)
2284
- - [Rails](#rails)
2285
- - [Sinatra](#sinatra)
2286
- - [http.rb](#httprb)
2287
- - [httpclient](#httpclient)
2288
- - [httpx](#httpx)
2289
-
2290
- **Using the HTTP propagator**
2291
-
2292
- To make the process of propagating this metadata easier, you can use the `Datadog::Tracing::Propagation::HTTP` module.
2293
-
2294
- On the client:
2295
-
2296
- ```ruby
2297
- Datadog::Tracing.trace('web.call') do |span, trace|
2298
- # Inject trace headers into request headers (`env` must be a Hash)
2299
- Datadog::Tracing::Propagation::HTTP.inject!(trace.to_digest, env)
2300
- end
2301
- ```
2302
-
2303
- On the server:
2304
-
2305
- ```ruby
2306
- trace_digest = Datadog::Tracing::Propagation::HTTP.extract(request.env)
2307
-
2308
- Datadog::Tracing.trace('web.work', continue_from: trace_digest) do |span|
2309
- # Do web work...
2310
- end
2311
- ```
2312
-
2313
- ### HTTP request queuing
2314
-
2315
- Traces that originate from HTTP requests can be configured to include the time spent in a frontend web server or load balancer queue before the request reaches the Ruby application.
2316
-
2317
- This feature is disabled by default. To activate it, you must add an `X-Request-Start` or `X-Queue-Start` header from your web server (i.e., Nginx). The following is an Nginx configuration example:
2318
-
2319
- ```
2320
- # /etc/nginx/conf.d/ruby_service.conf
2321
- server {
2322
- listen 8080;
2323
-
2324
- location / {
2325
- proxy_set_header X-Request-Start "t=${msec}";
2326
- proxy_pass http://web:3000;
2327
- }
2328
- }
2329
- ```
2330
-
2331
- Then you must enable the request queuing feature, by setting `request_queuing: true`, in the integration handling the request. For Rack-based applications, see the [documentation](#rack) for details.
2332
-
2333
- ### Processing Pipeline
2334
-
2335
- Some applications might require that traces be altered or filtered out before they are sent to Datadog. The processing pipeline allows you to create *processors* to define such behavior.
2336
-
2337
- #### Filtering
2338
-
2339
- You can use the `Datadog::Tracing::Pipeline::SpanFilter` processor to remove spans, when the block evaluates as truthy:
2340
-
2341
- ```ruby
2342
- Datadog::Tracing.before_flush(
2343
- # Remove spans that match a particular resource
2344
- Datadog::Tracing::Pipeline::SpanFilter.new { |span| span.resource =~ /PingController/ },
2345
- # Remove spans that are trafficked to localhost
2346
- Datadog::Tracing::Pipeline::SpanFilter.new { |span| span.get_tag('host') == 'localhost' }
2347
- )
2348
- ```
2349
-
2350
- #### Processing
2351
-
2352
- You can use the `Datadog::Tracing::Pipeline::SpanProcessor` processor to modify spans:
2353
-
2354
- ```ruby
2355
- Datadog::Tracing.before_flush(
2356
- # Strip matching text from the resource field
2357
- Datadog::Tracing::Pipeline::SpanProcessor.new { |span| span.resource.gsub!(/password=.*/, '') }
2358
- )
2359
- ```
2360
-
2361
- #### Custom processor
2362
-
2363
- Processors can be any object that responds to `#call` accepting `trace` as an argument (which is an `Array` of `Datadog::Span`s.)
2364
-
2365
- For example, using the short-hand block syntax:
2366
-
2367
- ```ruby
2368
- Datadog::Tracing.before_flush do |trace|
2369
- # Processing logic...
2370
- trace
2371
- end
2372
- ```
2373
-
2374
- For a custom processor class:
2375
-
2376
- ```ruby
2377
- class MyCustomProcessor
2378
- def call(trace)
2379
- # Processing logic...
2380
- trace
2381
- end
2382
- end
2383
-
2384
- Datadog::Tracing.before_flush(MyCustomProcessor.new)
2385
- ```
2386
-
2387
- In both cases, the processor method *must* return the `trace` object; this return value will be passed to the next processor in the pipeline.
2388
-
2389
- ### Trace correlation
2390
-
2391
- In many cases, such as logging, it may be useful to correlate trace IDs to other events or data streams, for easier cross-referencing.
2392
-
2393
- #### For logging in Rails applications
2394
-
2395
- ##### Automatic
2396
-
2397
- For Rails applications using the default logger (`ActiveSupport::TaggedLogging`), `lograge` or `semantic_logger`, trace correlation injection is enabled by default.
2398
-
2399
- It can be disabled by setting the environment variable `DD_LOGS_INJECTION=false`.
2400
-
2401
- #### For logging in Ruby applications
2402
-
2403
- To add correlation IDs to your logger, add a log formatter which retrieves the correlation IDs with `Datadog::Tracing.correlation`, then add them to the message.
2404
-
2405
- To properly correlate with Datadog logging, be sure the following is present in the log message, in order as they appear:
2406
-
2407
- - `dd.env=<ENV>`: Where `<ENV>` is equal to `Datadog::Tracing.correlation.env`. Omit if no environment is configured.
2408
- - `dd.service=<SERVICE>`: Where `<SERVICE>` is equal to `Datadog::Tracing.correlation.service`. Omit if no default service name is configured.
2409
- - `dd.version=<VERSION>`: Where `<VERSION>` is equal to `Datadog::Tracing.correlation.version`. Omit if no application version is configured.
2410
- - `dd.trace_id=<TRACE_ID>`: Where `<TRACE_ID>` is equal to `Datadog::Tracing.correlation.trace_id` or `0` if no trace is active during logging.
2411
- - `dd.span_id=<SPAN_ID>`: Where `<SPAN_ID>` is equal to `Datadog::Tracing.correlation.span_id` or `0` if no trace is active during logging.
2412
-
2413
- `Datadog::Tracing.log_correlation` will return `dd.env=<ENV> dd.service=<SERVICE> dd.version=<VERSION> dd.trace_id=<TRACE_ID> dd.span_id=<SPAN_ID>`.
2414
-
2415
- If a trace is not active and the application environment & version is not configured, it will return `dd.env= dd.service= dd.version= dd.trace_id=0 dd.span_id=0`.
2416
-
2417
- An example of this in practice:
2418
-
2419
- ```ruby
2420
- require 'ddtrace'
2421
- require 'logger'
2422
-
2423
- ENV['DD_ENV'] = 'production'
2424
- ENV['DD_SERVICE'] = 'billing-api'
2425
- ENV['DD_VERSION'] = '2.5.17'
2426
-
2427
- logger = Logger.new(STDOUT)
2428
- logger.progname = 'my_app'
2429
- logger.formatter = proc do |severity, datetime, progname, msg|
2430
- "[#{datetime}][#{progname}][#{severity}][#{Datadog::Tracing.log_correlation}] #{msg}\n"
2431
- end
2432
-
2433
- # When no trace is active
2434
- logger.warn('This is an untraced operation.')
2435
- # [2019-01-16 18:38:41 +0000][my_app][WARN][dd.env=production dd.service=billing-api dd.version=2.5.17 dd.trace_id=0 dd.span_id=0] This is an untraced operation.
2436
-
2437
- # When a trace is active
2438
- Datadog::Tracing.trace('my.operation') { logger.warn('This is a traced operation.') }
2439
- # [2019-01-16 18:38:41 +0000][my_app][WARN][dd.env=production dd.service=billing-api dd.version=2.5.17 dd.trace_id=8545847825299552251 dd.span_id=3711755234730770098] This is a traced operation.
2440
- ```
2441
-
2442
- ### Configuring the transport layer
2443
-
2444
- By default, `ddtrace` will connect to the agent using the first available settings in the listed priority:
2445
-
2446
- 1. Via any explicitly provided configuration settings (hostname/port/transport)
2447
- 2. Via Unix Domain Socket (UDS) located at `/var/run/datadog/apm.socket`
2448
- 3. Via HTTP over TCP to `127.0.0.1:8126`
2449
-
2450
- However, the tracer can be configured to send its trace data to alternative destinations, or by alternative protocols.
2451
-
2452
- #### Changing default agent hostname and port
2453
-
2454
- To change the agent host or port, provide `DD_AGENT_HOST` and `DD_TRACE_AGENT_PORT`.
2455
-
2456
- OR within a `Datadog.configure` block, provide the following settings:
2457
-
2458
- ```ruby
2459
- Datadog.configure do |c|
2460
- c.agent.host = '127.0.0.1'
2461
- c.agent.port = 8126
2462
- end
2463
- ```
2464
-
2465
- See [Additional Configuration](#additional-configuration) for more details.
2466
-
2467
- #### Using the Net::HTTP adapter
2468
-
2469
- The `Net` adapter submits traces using `Net::HTTP` over TCP. It is the default transport adapter.
2470
-
2471
- ```ruby
2472
- Datadog.configure do |c|
2473
- c.tracing.transport_options = proc { |t|
2474
- # Hostname, port, and additional options. :timeout is in seconds.
2475
- t.adapter :net_http, '127.0.0.1', 8126, { timeout: 1 }
2476
- }
2477
- end
2478
- ```
2479
-
2480
- #### Using the Unix Domain Socket (UDS) adapter
2481
-
2482
- The `UnixSocket` adapter submits traces using `Net::HTTP` over Unix socket.
2483
-
2484
- To use, first configure your trace agent to listen by Unix socket, then configure the tracer with:
2485
-
2486
- ```ruby
2487
- Datadog.configure do |c|
2488
- c.tracing.transport_options = proc { |t|
2489
- # Provide local path to trace agent Unix socket
2490
- t.adapter :unix, '/tmp/ddagent/trace.sock'
2491
- }
2492
- end
2493
- ```
2494
-
2495
- #### Using the transport test adapter
2496
-
2497
- The `Test` adapter is a no-op transport that can optionally buffer requests. For use in test suites or other non-production environments.
2498
-
2499
- ```ruby
2500
- Datadog.configure do |c|
2501
- c.tracing.transport_options = proc { |t|
2502
- # Set transport to no-op mode. Does not retain traces.
2503
- t.adapter :test
2504
-
2505
- # Alternatively, you can provide a buffer to examine trace output.
2506
- # The buffer must respond to '<<'.
2507
- t.adapter :test, []
2508
- }
2509
- end
2510
- ```
2511
-
2512
- #### Using a custom transport adapter
2513
-
2514
- Custom adapters can be configured with:
2515
-
2516
- ```ruby
2517
- Datadog.configure do |c|
2518
- c.tracing.transport_options = proc { |t|
2519
- # Initialize and pass an instance of the adapter
2520
- custom_adapter = CustomAdapter.new
2521
- t.adapter custom_adapter
2522
- }
2523
- end
2524
- ```
2525
-
2526
- ### Setting the time provider
2527
-
2528
- By default, tracing uses a monotonic clock to measure the duration of spans, and timestamps (`->{ Time.now }`) for the start and end time.
2529
-
2530
- When testing, it might be helpful to use a different time provider.
2531
-
2532
- To change the function that provides timestamps, configure the following:
2533
-
2534
- ```ruby
2535
- Datadog.configure do |c|
2536
- # For Timecop, for example, `->{ Time.now_without_mock_time }` allows the tracer to use the real wall time.
2537
- c.time_now_provider = -> { Time.now_without_mock_time }
2538
- end
2539
- ```
2540
-
2541
- Span duration calculation will still use the system monotonic clock when available, thus not being affected by this setting.
2542
-
2543
- ### Metrics
2544
-
2545
- The tracer and its integrations can produce some additional metrics that can provide useful insight into the performance of your application. These metrics are collected with `dogstatsd-ruby`, and can be sent to the same Datadog agent to which you send your traces.
2546
-
2547
- To configure your application for metrics collection:
2548
-
2549
- 1. [Configure your Datadog agent for StatsD](https://docs.datadoghq.com/developers/dogstatsd/#setup)
2550
- 2. Add `gem 'dogstatsd-ruby', '~> 5.3'` to your Gemfile
2551
-
2552
- #### For application runtime
2553
-
2554
- If runtime metrics are configured, the trace library will automatically collect and send metrics about the health of your application.
2555
-
2556
- To configure runtime metrics, add the following configuration:
2557
-
2558
- ```ruby
2559
- # config/initializers/datadog.rb
2560
- require 'datadog/statsd'
2561
- require 'ddtrace'
2562
-
2563
- Datadog.configure do |c|
2564
- # To enable runtime metrics collection, set `true`. Defaults to `false`
2565
- # You can also set DD_RUNTIME_METRICS_ENABLED=true to configure this.
2566
- c.runtime_metrics.enabled = true
2567
-
2568
- # Optionally, you can configure the Statsd instance used for sending runtime metrics.
2569
- # Statsd is automatically configured with default settings if `dogstatsd-ruby` is available.
2570
- # You can configure with host and port of Datadog agent; defaults to 'localhost:8125'.
2571
- c.runtime_metrics.statsd = Datadog::Statsd.new
2572
- end
2573
- ```
2574
-
2575
- See the [Dogstatsd documentation](https://www.rubydoc.info/github/DataDog/dogstatsd-ruby/master/frames) for more details about configuring `Datadog::Statsd`.
2576
-
2577
- The stats are VM specific and will include:
2578
-
2579
- | Name | Type | Description | Available on |
2580
- | -------------------------- | ------- | -------------------------------------------------------- | ------------ |
2581
- | `runtime.ruby.class_count` | `gauge` | Number of classes in memory space. | CRuby |
2582
- | `runtime.ruby.gc.*` | `gauge` | Garbage collection statistics: collected from `GC.stat`. | All runtimes |
2583
- | `runtime.ruby.thread_count` | `gauge` | Number of threads. | All runtimes |
2584
- | `runtime.ruby.global_constant_state` | `gauge` | Global constant cache generation. | CRuby |
2585
- | `runtime.ruby.global_method_state` | `gauge` | [Global method cache generation.](https://tenderlovemaking.com/2015/12/23/inline-caching-in-mri.html) | [CRuby < 3.0.0](https://docs.ruby-lang.org/en/3.0.0/NEWS_md.html#label-Implementation+improvements) |
2586
-
2587
- In addition, all metrics include the following tags:
2588
-
2589
- | Name | Description |
2590
- | ------------ | ------------------------------------------------------- |
2591
- | `language` | Programming language traced. (e.g. `ruby`) |
2592
- | `service` | List of services this associated with this metric. |
2593
-
2594
- ### OpenTracing
2595
-
2596
- For setting up Datadog with OpenTracing, see our [Configuring OpenTracing](#configuring-opentracing) section for details.
2597
-
2598
- **Configuring Datadog tracer settings**
2599
-
2600
- The underlying Datadog tracer can be configured by passing options (which match `Datadog::Tracer`) when configuring the global tracer:
2601
-
2602
- ```ruby
2603
- # Where `options` is a Hash of options provided to Datadog::Tracer
2604
- OpenTracing.global_tracer = Datadog::OpenTracer::Tracer.new(**options)
2605
- ```
2606
-
2607
- It can also be configured by using `Datadog.configure` described in the [Additional Configuration](#additional-configuration) section.
2608
-
2609
- **Activating and configuring integrations**
2610
-
2611
- By default, configuring OpenTracing with Datadog will not automatically activate any additional instrumentation provided by Datadog. You will only receive spans and traces from OpenTracing instrumentation you have in your application.
2612
-
2613
- However, additional instrumentation provided by Datadog can be activated alongside OpenTracing using `Datadog.configure`, which can be used to enhance your tracing further. To activate this, see [Integration instrumentation](#integration-instrumentation) for more details.
2614
-
2615
- **Supported serialization formats**
2616
-
2617
- | Type | Supported? | Additional information |
2618
- | ------------------------------ | ---------- | ---------------------- |
2619
- | `OpenTracing::FORMAT_TEXT_MAP` | Yes | |
2620
- | `OpenTracing::FORMAT_RACK` | Yes | Because of the loss of resolution in the Rack format, please note that baggage items with names containing either upper case characters or `-` will be converted to lower case and `_` in a round-trip respectively. We recommend avoiding these characters or accommodating accordingly on the receiving end. |
2621
- | `OpenTracing::FORMAT_BINARY` | No | |
2622
-
2623
- ### Profiling
2624
-
2625
- *Currently available as BETA feature.*
2626
-
2627
- `ddtrace` can produce profiles that measure method-level application resource usage within production environments. These profiles can give insight into resources spent in Ruby code outside of existing trace instrumentation.
2628
-
2629
- **Setup**
2630
-
2631
- To get started with profiling, follow the [Enabling the Ruby Profiler](https://docs.datadoghq.com/tracing/profiler/enabling/ruby/) guide.
2632
-
2633
- #### Troubleshooting
2634
-
2635
- If you run into issues with profiling, please check the [Profiler Troubleshooting Guide](https://docs.datadoghq.com/tracing/profiler/profiler_troubleshooting/?code-lang=ruby).
2636
-
2637
- #### Profiling Resque jobs
2638
-
2639
- When profiling [Resque](https://github.com/resque/resque) jobs, you should set the `RUN_AT_EXIT_HOOKS=1` option described in the [Resque](https://github.com/resque/resque/blob/v2.0.0/docs/HOOKS.md#worker-hooks) documentation.
2640
-
2641
- Without this flag, profiles for short-lived Resque jobs will not be available as Resque kills worker processes before they have a chance to submit this information.
2642
-
2643
- ## Known issues and suggested configurations
2644
-
2645
- ### Payload too large
2646
-
2647
- By default, Datadog limits the size of trace payloads to prevent memory overhead within instrumented applications. As a result, traces containing thousands of operations may not be sent to Datadog.
2648
-
2649
- If traces are missing, enable [debug mode](#debugging-and-diagnostics) to check if messages containing `"Dropping trace. Payload too large"` are logged.
2650
-
2651
- Since debug mode is verbose, **Datadog does not recommend leaving this enabled or enabling this in production.** Disable it after confirming. You can inspect the [Datadog Agent logs](https://docs.datadoghq.com/agent/guide/agent-log-files/) for similar messages.
2652
-
2653
- If you have confirmed that traces are dropped due to large payloads, then enable the [partial_flush](#additional-configuration) setting to break down large traces into smaller chunks.
2654
-
2655
- ### Stack level too deep
2656
-
2657
- Datadog tracing collects trace data by adding instrumentation into other common libraries (e.g. Rails, Rack, etc.) Some libraries provide APIs to add this instrumentation, but some do not. In order to add instrumentation into libraries lacking an instrumentation API, Datadog uses a technique called "monkey-patching" to modify the code of that library.
2658
-
2659
- In Ruby version 1.9.3 and earlier, "monkey-patching" often involved the use of [`alias_method`](https://ruby-doc.org/core-3.0.0/Module.html#method-i-alias_method), also known as *method rewriting*, to destructively replace existing Ruby methods. However, this practice would often create conflicts & errors if two libraries attempted to "rewrite" the same method. (e.g. two different APM packages trying to instrument the same method.)
2660
-
2661
- In Ruby 2.0, the [`Module#prepend`](https://ruby-doc.org/core-3.0.0/Module.html#method-i-prepend) feature was introduced. This feature avoids destructive method rewriting and allows multiple "monkey patches" on the same method. Consequently, it has become the safest, preferred means to "monkey patch" code.
2662
-
2663
- Datadog instrumentation almost exclusively uses the `Module#prepend` feature to add instrumentation non-destructively. However, some other libraries (typically those supporting Ruby < 2.0) still use `alias_method` which can create conflicts with Datadog instrumentation, often resulting in `SystemStackError` or `stack level too deep` errors.
2664
-
2665
- As the implementation of `alias_method` exists within those libraries, Datadog generally cannot fix them. However, some libraries have known workarounds:
2666
-
2667
- * `rack-mini-profiler`: [Net::HTTP stack level too deep errors](https://github.com/MiniProfiler/rack-mini-profiler#nethttp-stack-level-too-deep-errors).
2668
-
2669
- For libraries without a known workaround, consider removing the library using `alias` or `Module#alias_method` or separating libraries into different environments for testing.
2670
-
2671
- For any further questions or to report an occurence of this issue, please [reach out to Datadog support](https://docs.datadoghq.com/help)