Class: Datadog::Core::Configuration::Settings::DSL::Profiling
- Inherits:
-
Object
- Object
- Datadog::Core::Configuration::Settings::DSL::Profiling
- Defined in:
- lib/datadog/core/configuration/settings.rb
Overview
Datadog Profiler-specific configurations.
Defined Under Namespace
Classes: Advanced, Exporter, Upload
Instance Attribute Summary collapse
-
#enabled ⇒ Boolean
Enable profiling.
Instance Method Summary collapse
-
#advanced ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Advanced
A configuration object.
-
#exporter ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Exporter
A configuration object.
-
#upload ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Upload
A configuration object.
Instance Attribute Details
#enabled ⇒ Boolean
Enable profiling.
197 198 199 |
# File 'lib/datadog/core/configuration/settings.rb', line 197 def enabled @enabled end |
Instance Method Details
#advanced ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Advanced
Returns a configuration object.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/datadog/core/configuration/settings.rb', line 209 settings :advanced do # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0. # # This was used prior to the GA of the new CPU Profiling 2.0 profiler. The CPU Profiling 2.0 profiler does not # use or need this setting and thus it doesn't do anything. option :max_events do |o| o.after_set do Datadog.logger.warn( 'The profiling.advanced.max_events setting has been deprecated for removal and no ' \ 'longer does anything. Please remove it from your Datadog.configure block.' ) end end # Controls the maximum number of frames for each thread sampled. Can be tuned to avoid omitted frames in the # produced profiles. Increasing this may increase the overhead of profiling. # # @default `DD_PROFILING_MAX_FRAMES` environment variable, otherwise 400 option :max_frames do |o| o.type :int o.env Profiling::Ext::ENV_MAX_FRAMES o.default 400 end # @public_api settings :endpoint do settings :collection do # When using profiling together with tracing, this controls if endpoint names # are gathered and reported together with profiles. # # @default `DD_PROFILING_ENDPOINT_COLLECTION_ENABLED` environment variable, otherwise `true` # @return [Boolean] option :enabled do |o| o.env Profiling::Ext::ENV_ENDPOINT_COLLECTION_ENABLED o.default true o.type :bool end end end # Can be used to disable the gathering of names and versions of gems in use by the service, used to power # grouping and categorization of stack traces. option :code_provenance_enabled, default: true # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0. # # This was added as a temporary support option in case of issues with the new `Profiling::HttpTransport` class # but we're now confident it's working nicely so we've removed the old code path. option :legacy_transport_enabled do |o| o.after_set do Datadog.logger.warn( 'The profiling.advanced.legacy_transport_enabled setting has been deprecated for removal and no ' \ 'longer does anything. Please remove it from your Datadog.configure block.' ) end end # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0. # # This was used prior to the GA of the new CPU Profiling 2.0 profiler. Using CPU Profiling 2.0 is now the # default and this doesn't do anything. option :force_enable_new_profiler do |o| o.after_set do Datadog.logger.warn( 'The profiling.advanced.force_enable_new_profiler setting has been deprecated for removal and no ' \ 'longer does anything. Please remove it from your Datadog.configure block.' ) end end # @deprecated No longer does anything, and will be removed on dd-trace-rb 2.0. # # This was used prior to the GA of the new CPU Profiling 2.0 profiler. Using CPU Profiling 2.0 is now the # default and this doesn't do anything. option :force_enable_legacy_profiler do |o| o.after_set do Datadog.logger.warn( 'The profiling.advanced.force_enable_legacy_profiler setting has been deprecated for removal and no ' \ 'longer does anything. Please remove it from your Datadog.configure block.' ) end end # Forces enabling of profiling of time/resources spent in Garbage Collection. # # Note that setting this to "false" (or not setting it) will not prevent the feature from being # being automatically enabled in the future. # # This feature defaults to off for two reasons: # 1. Currently this feature can add a lot of overhead for GC-heavy workloads. # 2. Although this feature is safe on Ruby 2.x, on Ruby 3.x it can break in applications that make use of # Ractors due to two Ruby VM bugs: # https://bugs.ruby-lang.org/issues/19112 AND https://bugs.ruby-lang.org/issues/18464. # If you use Ruby 3.x and your application does not use Ractors (or if your Ruby has been patched), the # feature is fully safe to enable and this toggle can be used to do so. # # We expect the once the above issues are overcome, we'll automatically enable the feature on fixed Ruby # versions. # # @default `DD_PROFILING_FORCE_ENABLE_GC` environment variable, otherwise `false` option :force_enable_gc_profiling do |o| o.env 'DD_PROFILING_FORCE_ENABLE_GC' o.type :bool o.default false end # Can be used to enable/disable the Datadog::Profiling.allocation_count feature. # # This feature is safe and enabled by default on Ruby 2.x, but has a few caveats on Ruby 3.x. # # Caveat 1 (severe): # On Ruby versions 3.0 (all), 3.1.0 to 3.1.3, and 3.2.0 to 3.2.2 this is disabled by default because it # can trigger a VM bug that causes a segmentation fault during garbage collection of Ractors # (https://bugs.ruby-lang.org/issues/18464). We don't recommend using this feature on such Rubies. # This bug is fixed on Ruby versions 3.1.4, 3.2.3 and 3.3.0. # # Caveat 2 (annoyance): # On all known versions of Ruby 3.x, due to https://bugs.ruby-lang.org/issues/19112, when a ractor gets # garbage collected, Ruby will disable all active tracepoints, which this feature internally relies on. # Thus this feature is only usable if you're not using Ractors. # # @default `true` on Ruby 2.x and 3.1.4+, 3.2.3+ and 3.3.0+; `false` for Ruby 3.0 and unpatched Rubies. option :allocation_counting_enabled do |o| o.default do RUBY_VERSION.start_with?('2.') || (RUBY_VERSION.start_with?('3.1.') && RUBY_VERSION >= '3.1.4') || (RUBY_VERSION.start_with?('3.2.') && RUBY_VERSION >= '3.2.3') || RUBY_VERSION >= '3.3.' end end # Can be used to disable checking which version of `libmysqlclient` is being used by the `mysql2` gem. # # This setting is only used when the `mysql2` gem is installed. # # @default `DD_PROFILING_SKIP_MYSQL2_CHECK` environment variable, otherwise `false` option :skip_mysql2_check do |o| o.type :bool o.env 'DD_PROFILING_SKIP_MYSQL2_CHECK' o.default false end # Enables data collection for the timeline feature. This is still experimental and not recommended yet. # # @default `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED` environment variable as a boolean, otherwise `false` option :experimental_timeline_enabled do |o| o.type :bool o.env 'DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED' o.default false end # The profiler gathers data by sending `SIGPROF` unix signals to Ruby application threads. # # Sending `SIGPROF` is a common profiling approach, and may cause system calls from native # extensions/libraries to be interrupted with a system # [EINTR error code.](https://man7.org/linux/man-pages/man7/signal.7.html#:~:text=Interruption%20of%20system%20calls%20and%20library%20functions%20by%20signal%20handlers) # Rarely, native extensions or libraries called by them may have missing or incorrect error handling for the # `EINTR` error code. # # The "no signals" workaround, when enabled, enables an alternative mode for the profiler where it does not # send `SIGPROF` unix signals. The downside of this approach is that the profiler data will have lower # quality. # # This workaround is automatically enabled when gems that are known to have issues handling # `EINTR` error codes are detected. If you suspect you may be seeing an issue due to the profiler's use of # signals, you can try manually enabling this mode as a fallback. # Please also report these issues to us on <https://github.com/DataDog/dd-trace-rb/issues/new>, so we can # work with the gem authors to fix them! # # @default `DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED` environment variable as a boolean, otherwise `:auto` option :no_signals_workaround_enabled do |o| o.env 'DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED' o.default :auto o.env_parser do |value| if value value = value.strip.downcase ['true', '1'].include?(value) end end end end |
#exporter ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Exporter
Returns a configuration object.
204 205 206 |
# File 'lib/datadog/core/configuration/settings.rb', line 204 settings :exporter do option :transport end |
#upload ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling::Upload
Returns a configuration object.
392 393 394 395 396 397 398 399 400 401 |
# File 'lib/datadog/core/configuration/settings.rb', line 392 settings :upload do # Network timeout for reporting profiling data to Datadog. # # @default `DD_PROFILING_UPLOAD_TIMEOUT` environment variable, otherwise `30.0` option :timeout_seconds do |o| o.type :float o.env Profiling::Ext::ENV_UPLOAD_TIMEOUT o.default 30.0 end end |