newrelic_rpm 7.0.0 → 8.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -0
- data/CHANGELOG.md +226 -0
- data/CONTRIBUTING.md +13 -2
- data/README.md +5 -1
- data/lib/new_relic/agent/adaptive_sampler.rb +2 -2
- data/lib/new_relic/agent/agent.rb +8 -7
- data/lib/new_relic/agent/commands/thread_profiler_session.rb +7 -3
- data/lib/new_relic/agent/configuration/default_source.rb +229 -158
- data/lib/new_relic/agent/configuration/event_harvest_config.rb +28 -12
- data/lib/new_relic/agent/configuration/manager.rb +1 -2
- data/lib/new_relic/agent/configuration/server_source.rb +3 -2
- data/lib/new_relic/agent/configuration/yaml_source.rb +22 -1
- data/lib/new_relic/agent/connect/request_builder.rb +4 -2
- data/lib/new_relic/agent/custom_event_aggregator.rb +2 -1
- data/lib/new_relic/agent/database.rb +5 -2
- data/lib/new_relic/agent/datastores/mongo.rb +5 -10
- data/lib/new_relic/agent/datastores.rb +7 -7
- data/lib/new_relic/agent/distributed_tracing/cross_app_payload.rb +5 -5
- data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb +10 -6
- data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +0 -1
- data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb +1 -1
- data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +6 -6
- data/lib/new_relic/agent/error_collector.rb +52 -37
- data/lib/new_relic/agent/error_filter.rb +175 -0
- data/lib/new_relic/agent/event_loop.rb +6 -6
- data/lib/new_relic/agent/external.rb +0 -32
- data/lib/new_relic/agent/http_clients/abstract.rb +2 -2
- data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +7 -1
- data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +1 -1
- data/lib/new_relic/agent/instrumentation/active_merchant.rb +3 -3
- data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +1 -3
- data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb +1 -1
- data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +2 -1
- data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb +4 -4
- data/lib/new_relic/agent/instrumentation/excon.rb +4 -23
- data/lib/new_relic/agent/instrumentation/logger/chain.rb +21 -0
- data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb +59 -0
- data/lib/new_relic/agent/instrumentation/logger/prepend.rb +13 -0
- data/lib/new_relic/agent/instrumentation/logger.rb +25 -0
- data/lib/new_relic/agent/instrumentation/memcache/dalli.rb +5 -1
- data/lib/new_relic/agent/instrumentation/memcache/helper.rb +5 -0
- data/lib/new_relic/agent/instrumentation/memcache/prepend.rb +8 -2
- data/lib/new_relic/agent/instrumentation/mongo.rb +3 -141
- data/lib/new_relic/agent/instrumentation/net_http.rb +6 -1
- data/lib/new_relic/agent/instrumentation/padrino/chain.rb +23 -19
- data/lib/new_relic/agent/instrumentation/padrino/prepend.rb +1 -1
- data/lib/new_relic/agent/instrumentation/padrino.rb +4 -2
- data/lib/new_relic/agent/instrumentation/queue_time.rb +4 -4
- data/lib/new_relic/agent/instrumentation/rack/chain.rb +3 -2
- data/lib/new_relic/agent/instrumentation/rack/prepend.rb +2 -1
- data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +5 -41
- data/lib/new_relic/agent/instrumentation/redis.rb +4 -0
- data/lib/new_relic/agent/instrumentation/resque/helper.rb +19 -0
- data/lib/new_relic/agent/instrumentation/resque/instrumentation.rb +5 -3
- data/lib/new_relic/agent/instrumentation/resque.rb +13 -4
- data/lib/new_relic/agent/instrumentation/sidekiq.rb +6 -1
- data/lib/new_relic/agent/instrumentation/sinatra/instrumentation.rb +8 -2
- data/lib/new_relic/agent/instrumentation/tilt/chain.rb +24 -0
- data/lib/new_relic/agent/instrumentation/tilt/instrumentation.rb +41 -0
- data/lib/new_relic/agent/instrumentation/tilt/prepend.rb +13 -0
- data/lib/new_relic/agent/instrumentation/tilt.rb +25 -0
- data/lib/new_relic/agent/javascript_instrumentor.rb +15 -10
- data/lib/new_relic/agent/logging.rb +5 -6
- data/lib/new_relic/agent/messaging.rb +10 -24
- data/lib/new_relic/agent/method_tracer.rb +137 -138
- data/lib/new_relic/agent/monitors/cross_app_monitor.rb +8 -1
- data/lib/new_relic/agent/new_relic_service.rb +16 -12
- data/lib/new_relic/agent/pipe_channel_manager.rb +10 -6
- data/lib/new_relic/agent/pipe_service.rb +1 -1
- data/lib/new_relic/agent/samplers/cpu_sampler.rb +1 -1
- data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +9 -6
- data/lib/new_relic/agent/span_event_aggregator.rb +2 -2
- data/lib/new_relic/agent/sql_sampler.rb +3 -3
- data/lib/new_relic/agent/stats_engine/stats_hash.rb +1 -1
- data/lib/new_relic/agent/stats_engine.rb +1 -1
- data/lib/new_relic/agent/threading/backtrace_service.rb +4 -5
- data/lib/new_relic/agent/threading/thread_profile.rb +1 -1
- data/lib/new_relic/agent/tracer.rb +15 -37
- data/lib/new_relic/agent/transaction/abstract_segment.rb +3 -3
- data/lib/new_relic/agent/transaction/datastore_segment.rb +3 -0
- data/lib/new_relic/agent/transaction/distributed_tracer.rb +1 -0
- data/lib/new_relic/agent/transaction/external_request_segment.rb +3 -0
- data/lib/new_relic/agent/transaction/message_broker_segment.rb +5 -11
- data/lib/new_relic/agent/transaction/segment.rb +3 -0
- data/lib/new_relic/agent/transaction.rb +7 -28
- data/lib/new_relic/agent/transaction_time_aggregator.rb +5 -5
- data/lib/new_relic/agent/vm/snapshot.rb +1 -1
- data/lib/new_relic/agent/worker_loop.rb +5 -5
- data/lib/new_relic/agent.rb +10 -7
- data/lib/new_relic/cli/commands/deployments.rb +2 -2
- data/lib/new_relic/constants.rb +0 -4
- data/lib/new_relic/noticed_error.rb +4 -4
- data/lib/new_relic/version.rb +2 -2
- data/lib/newrelic_rpm.rb +10 -34
- data/lib/tasks/all.rb +1 -1
- data/lib/tasks/config.html.erb +14 -25
- data/lib/tasks/config.rake +8 -7
- data/newrelic.yml +580 -3
- data/newrelic_rpm.gemspec +1 -1
- data/test/agent_helper.rb +27 -2
- metadata +13 -11
- data/lib/new_relic/agent/datastores/mongo/statement_formatter.rb +0 -53
- data/lib/new_relic/agent/instrumentation/excon/connection.rb +0 -49
- data/lib/new_relic/agent/instrumentation/merb/controller.rb +0 -44
- data/lib/new_relic/agent/instrumentation/merb/errors.rb +0 -33
- data/lib/new_relic/agent/instrumentation/rails/action_controller.rb +0 -125
- data/lib/new_relic/agent/instrumentation/rails/action_web_service.rb +0 -46
- data/lib/new_relic/agent/supported_versions.rb +0 -275
- data/lib/new_relic/control/frameworks/merb.rb +0 -29
@@ -39,9 +39,11 @@ module NewRelic
|
|
39
39
|
end
|
40
40
|
end
|
41
41
|
|
42
|
+
# Marks the config option as deprecated in the documentation once generated.
|
43
|
+
# Does not appear in logs.
|
42
44
|
def self.deprecated_description new_setting, description
|
43
45
|
link_ref = new_setting.to_s.gsub(".", "-")
|
44
|
-
%{
|
46
|
+
%{Please see: [#{new_setting}](docs/agents/ruby-agent/configuration/ruby-agent-configuration##{link_ref}). \n\n#{description}}
|
45
47
|
end
|
46
48
|
|
47
49
|
class Boolean
|
@@ -120,7 +122,6 @@ module NewRelic
|
|
120
122
|
Proc.new {
|
121
123
|
case
|
122
124
|
when defined?(::NewRelic::TEST) then :test
|
123
|
-
when defined?(::Merb) && defined?(::Merb::Plugins) then :merb
|
124
125
|
when defined?(::Rails::VERSION)
|
125
126
|
case Rails::VERSION::MAJOR
|
126
127
|
when 0..2
|
@@ -325,14 +326,14 @@ module NewRelic
|
|
325
326
|
:public => true,
|
326
327
|
:type => String,
|
327
328
|
:allowed_from_server => false,
|
328
|
-
:description => 'Your New Relic
|
329
|
+
:description => 'Your New Relic [license key](/docs/accounts-partnerships/accounts/account-setup/license-key).'
|
329
330
|
},
|
330
331
|
:agent_enabled => {
|
331
332
|
:default => DefaultSource.agent_enabled,
|
332
333
|
:public => true,
|
333
334
|
:type => Boolean,
|
334
335
|
:allowed_from_server => false,
|
335
|
-
:description => 'If
|
336
|
+
:description => 'If `true`, allows the Ruby agent to run.'
|
336
337
|
},
|
337
338
|
:enabled => {
|
338
339
|
:default => true,
|
@@ -348,43 +349,43 @@ module NewRelic
|
|
348
349
|
:type => String,
|
349
350
|
:allowed_from_server => false,
|
350
351
|
:transform => DefaultSource.method(:convert_to_list_on_semicolon),
|
351
|
-
:description => 'Specify the
|
352
|
+
:description => 'Specify the [application name](/docs/apm/new-relic-apm/installation-configuration/name-your-application) used to aggregate data in the New Relic UI. To report data to [multiple apps at the same time](/docs/apm/new-relic-apm/installation-configuration/using-multiple-names-app), specify a list of names separated by a semicolon `;`. For example, `MyApp` or `MyStagingApp;Instance1`.'
|
352
353
|
},
|
353
354
|
:entity_guid => {
|
354
355
|
:default => nil,
|
355
356
|
:allow_nil => true,
|
356
|
-
:public =>
|
357
|
+
:public => false,
|
357
358
|
:type => String,
|
358
359
|
:allowed_from_server => true,
|
359
|
-
:description => 'The
|
360
|
+
:description => 'The [Entity GUID](/attribute-dictionary/span/entityguid) for the entity running this agent.'
|
360
361
|
},
|
361
362
|
:monitor_mode => {
|
362
363
|
:default => value_of(:enabled),
|
363
364
|
:public => true,
|
364
365
|
:type => Boolean,
|
365
366
|
:allowed_from_server => false,
|
366
|
-
:description => 'When
|
367
|
+
:description => 'When `true`, the agent transmits data about your app to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector).'
|
367
368
|
},
|
368
369
|
:test_mode => {
|
369
370
|
:default => false,
|
370
371
|
:public => false,
|
371
372
|
:type => Boolean,
|
372
373
|
:allowed_from_server => false,
|
373
|
-
:description => 'Used in tests for agent to start up but not connect to collector. Formerly used
|
374
|
+
:description => 'Used in tests for agent to start up but not connect to collector. Formerly used `developer_mode` in test config for this purpose.'
|
374
375
|
},
|
375
376
|
:log_level => {
|
376
377
|
:default => 'info',
|
377
378
|
:public => true,
|
378
379
|
:type => String,
|
379
380
|
:allowed_from_server => false,
|
380
|
-
:description => 'Sets the level of detail of log messages. Possible log levels, in increasing verbosity, are:
|
381
|
+
:description => 'Sets the level of detail of log messages. Possible log levels, in increasing verbosity, are: `error`, `warn`, `info` or `debug`.'
|
381
382
|
},
|
382
383
|
:high_security => {
|
383
384
|
:default => false,
|
384
385
|
:public => true,
|
385
386
|
:type => Boolean,
|
386
387
|
:allowed_from_server => false,
|
387
|
-
:description => 'If
|
388
|
+
:description => 'If `true`, enables [high security mode](/docs/accounts-partnerships/accounts/security/high-security). Ensure you understand the implications of high security mode before enabling this setting.'
|
388
389
|
},
|
389
390
|
:security_policies_token => {
|
390
391
|
:default => '',
|
@@ -399,7 +400,7 @@ module NewRelic
|
|
399
400
|
:public => true,
|
400
401
|
:type => String,
|
401
402
|
:allowed_from_server => false,
|
402
|
-
:description => 'Defines a host for communicating with the New Relic
|
403
|
+
:description => 'Defines a host for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server.'
|
403
404
|
},
|
404
405
|
:proxy_port => {
|
405
406
|
:default => 8080,
|
@@ -407,7 +408,7 @@ module NewRelic
|
|
407
408
|
:public => true,
|
408
409
|
:type => Integer,
|
409
410
|
:allowed_from_server => false,
|
410
|
-
:description => 'Defines a port for communicating with the New Relic
|
411
|
+
:description => 'Defines a port for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server.'
|
411
412
|
},
|
412
413
|
:proxy_user => {
|
413
414
|
:default => nil,
|
@@ -416,7 +417,7 @@ module NewRelic
|
|
416
417
|
:type => String,
|
417
418
|
:allowed_from_server => false,
|
418
419
|
:exclude_from_reported_settings => true,
|
419
|
-
:description => 'Defines a user for communicating with the New Relic
|
420
|
+
:description => 'Defines a user for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server.'
|
420
421
|
},
|
421
422
|
:proxy_pass => {
|
422
423
|
:default => nil,
|
@@ -425,27 +426,26 @@ module NewRelic
|
|
425
426
|
:type => String,
|
426
427
|
:allowed_from_server => false,
|
427
428
|
:exclude_from_reported_settings => true,
|
428
|
-
:description => 'Defines a password for communicating with the New Relic
|
429
|
+
:description => 'Defines a password for communicating with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) via a proxy server.'
|
429
430
|
},
|
430
431
|
:capture_params => {
|
431
432
|
:default => false,
|
432
433
|
:public => true,
|
433
434
|
:type => Boolean,
|
434
435
|
:allowed_from_server => false,
|
435
|
-
:description => 'When
|
436
|
+
:description => 'When `true`, the agent captures HTTP request parameters ' \
|
436
437
|
'and attaches them to transaction traces, traced errors, and ' \
|
437
|
-
'
|
438
|
-
'<code>TransactionError</code> events.' \
|
438
|
+
'[`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241)'\
|
439
439
|
"\n" \
|
440
440
|
'<div class="callout-warning">' \
|
441
441
|
"\n" \
|
442
|
-
'
|
442
|
+
'When using the `capture_params` setting, the Ruby agent will not attempt ' \
|
443
443
|
'to filter secret information. <b>Recommendation:</b> To filter secret information from ' \
|
444
|
-
'request parameters, use the
|
445
|
-
'
|
444
|
+
'request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) ' \
|
445
|
+
'instead. For more information, see the ' \
|
446
446
|
'<a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">' \
|
447
447
|
'Ruby attribute examples</a>.' \
|
448
|
-
"
|
448
|
+
"\n" \
|
449
449
|
'</div>'
|
450
450
|
},
|
451
451
|
:config_path => {
|
@@ -481,21 +481,21 @@ module NewRelic
|
|
481
481
|
:public => true,
|
482
482
|
:type => String,
|
483
483
|
:allowed_from_server => false,
|
484
|
-
:description => 'Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma
|
484
|
+
:description => 'Specify a list of constants that should prevent the agent from starting automatically. Separate individual constants with a comma `,`. For example, `Rails::Console,UninstrumentedBackgroundJob`.'
|
485
485
|
},
|
486
486
|
:'autostart.denylisted_executables' => {
|
487
487
|
:default => 'irb,rspec',
|
488
488
|
:public => true,
|
489
489
|
:type => String,
|
490
490
|
:allowed_from_server => false,
|
491
|
-
:description => 'Defines a comma-delimited list of executables that the agent should not instrument. For example,
|
491
|
+
:description => 'Defines a comma-delimited list of executables that the agent should not instrument. For example, `rake,my_ruby_script.rb`.'
|
492
492
|
},
|
493
493
|
:'autostart.denylisted_rake_tasks' => {
|
494
494
|
:default => AUTOSTART_DENYLISTED_RAKE_TASKS,
|
495
495
|
:public => true,
|
496
496
|
:type => String,
|
497
497
|
:allowed_from_server => false,
|
498
|
-
:description => 'Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example,
|
498
|
+
:description => 'Defines a comma-delimited list of Rake tasks that the agent should not instrument. For example, `assets:precompile,db:migrate`.'
|
499
499
|
},
|
500
500
|
|
501
501
|
:disable_rake => {
|
@@ -504,7 +504,7 @@ module NewRelic
|
|
504
504
|
:type => Boolean,
|
505
505
|
:allowed_from_server => false,
|
506
506
|
:deprecated => true,
|
507
|
-
:description => deprecated_description(:'instrumentation.rake', 'If
|
507
|
+
:description => deprecated_description(:'instrumentation.rake', 'If `true`, disables Rake instrumentation.')
|
508
508
|
},
|
509
509
|
:disable_rake_instrumentation => {
|
510
510
|
:default => false,
|
@@ -535,14 +535,14 @@ module NewRelic
|
|
535
535
|
:type => Float,
|
536
536
|
:allowed_from_server => true,
|
537
537
|
:deprecated => true,
|
538
|
-
:description => '
|
538
|
+
:description => 'For agent versions 3.5.0 or higher, [set your Apdex T via the New Relic UI](/docs/apm/new-relic-apm/apdex/changing-your-apdex-settings).'
|
539
539
|
},
|
540
540
|
:'strip_exception_messages.enabled' => {
|
541
541
|
:default => value_of(:high_security),
|
542
542
|
:public => true,
|
543
543
|
:type => Boolean,
|
544
544
|
:allowed_from_server => false,
|
545
|
-
:description => 'If true, the agent strips messages from all exceptions except those in the
|
545
|
+
:description => 'If true, the agent strips messages from all exceptions except those in the [allowlist](#strip_exception_messages-allowlist). Enabled automatically in [high security mode](/docs/accounts-partnerships/accounts/security/high-security).'
|
546
546
|
},
|
547
547
|
:'strip_exception_messages.allowed_classes' => {
|
548
548
|
:default => '',
|
@@ -550,7 +550,7 @@ module NewRelic
|
|
550
550
|
:type => String,
|
551
551
|
:allowed_from_server => false,
|
552
552
|
:transform => DefaultSource.method(:convert_to_constant_list),
|
553
|
-
:description => 'Specify a list of exceptions you do not want the agent to strip when
|
553
|
+
:description => 'Specify a list of exceptions you do not want the agent to strip when [strip_exception_messages](#strip_exception_messages-enabled) is `true`. Separate exceptions with a comma. For example, `"ImportantException,PreserveMessageException"`.'
|
554
554
|
},
|
555
555
|
:host => {
|
556
556
|
:default => DefaultSource.host,
|
@@ -585,14 +585,14 @@ module NewRelic
|
|
585
585
|
:public => true,
|
586
586
|
:type => Boolean,
|
587
587
|
:allowed_from_server => false,
|
588
|
-
:description => 'When set to
|
588
|
+
:description => 'When set to `true`, forces a synchronous connection to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) during application startup. For very short-lived processes, this helps ensure the New Relic agent has time to report.'
|
589
589
|
},
|
590
590
|
:send_data_on_exit => {
|
591
591
|
:default => true,
|
592
592
|
:public => true,
|
593
593
|
:type => Boolean,
|
594
594
|
:allowed_from_server => false,
|
595
|
-
:description => 'If
|
595
|
+
:description => 'If `true`, enables the exit handler that sends data to the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector) before shutting down.'
|
596
596
|
},
|
597
597
|
:max_payload_size_in_bytes => {
|
598
598
|
:default => 1000000,
|
@@ -696,11 +696,11 @@ module NewRelic
|
|
696
696
|
:type => Boolean,
|
697
697
|
:allowed_from_server => false,
|
698
698
|
:description => 'Forces the exit handler that sends all cached data to collector ' \
|
699
|
-
'before
|
699
|
+
'before shutting down to be installed regardless of detecting scenarios where it generally should not be. ' \
|
700
700
|
'Known use-case for this option is where Sinatra is running as an embedded service within another framework ' \
|
701
|
-
'and the agent is detecting the Sinatra app and skipping the at_exit handler as a result. Sinatra classically ' \
|
702
|
-
'runs the entire application in an at_exit block and would otherwise misbehave if the Agent\'s at_exit handler ' \
|
703
|
-
'
|
701
|
+
'and the agent is detecting the Sinatra app and skipping the `at_exit` handler as a result. Sinatra classically ' \
|
702
|
+
'runs the entire application in an `at_exit` block and would otherwise misbehave if the Agent\'s `at_exit` handler ' \
|
703
|
+
'was also installed in those circumstances. Note: `send_data_on_exit` should also be set to `true` in tandem with this setting.'
|
704
704
|
},
|
705
705
|
:force_reconnect => {
|
706
706
|
:default => false,
|
@@ -735,7 +735,7 @@ module NewRelic
|
|
735
735
|
:public => true,
|
736
736
|
:type => Boolean,
|
737
737
|
:allowed_from_server => false,
|
738
|
-
:description => 'If
|
738
|
+
:description => 'If `true`, enables an audit log which logs communications with the New Relic [collector](/docs/using-new-relic/welcome-new-relic/get-started/glossary/#collector).'
|
739
739
|
},
|
740
740
|
:'audit_log.path' => {
|
741
741
|
:default => DefaultSource.audit_log_path,
|
@@ -757,7 +757,7 @@ module NewRelic
|
|
757
757
|
:public => true,
|
758
758
|
:type => Boolean,
|
759
759
|
:allowed_from_server => false,
|
760
|
-
:description => 'If
|
760
|
+
:description => 'If `true`, disables the collection of sampler metrics. Sampler metrics are metrics that are not event-based (such as CPU time or memory usage).'
|
761
761
|
},
|
762
762
|
:disable_resque => {
|
763
763
|
:default => false,
|
@@ -765,14 +765,14 @@ module NewRelic
|
|
765
765
|
:type => Boolean,
|
766
766
|
:deprecated => true,
|
767
767
|
:allowed_from_server => false,
|
768
|
-
:description => deprecated_description(:'instrumentation.resque', 'If
|
768
|
+
:description => deprecated_description(:'instrumentation.resque', 'If `true`, disables [Resque instrumentation](/docs/agents/ruby-agent/background-jobs/resque-instrumentation).')
|
769
769
|
},
|
770
770
|
:disable_sidekiq => {
|
771
771
|
:default => false,
|
772
772
|
:public => true,
|
773
773
|
:type => Boolean,
|
774
774
|
:allowed_from_server => false,
|
775
|
-
:description => 'If
|
775
|
+
:description => 'If `true`, disables [Sidekiq instrumentation](/docs/agents/ruby-agent/background-jobs/sidekiq-instrumentation).'
|
776
776
|
},
|
777
777
|
:disable_dj => {
|
778
778
|
:default => false,
|
@@ -780,29 +780,30 @@ module NewRelic
|
|
780
780
|
:deprecated => true,
|
781
781
|
:type => Boolean,
|
782
782
|
:allowed_from_server => false,
|
783
|
-
:description => deprecated_description(:'instrumentation.delayed_job', 'If
|
783
|
+
:description => deprecated_description(:'instrumentation.delayed_job', 'If `true`, disables [Delayed::Job instrumentation](/docs/agents/ruby-agent/background-jobs/delayedjob).'
|
784
784
|
)
|
785
785
|
},
|
786
786
|
:disable_sinatra => {
|
787
787
|
:default => false,
|
788
788
|
:public => true,
|
789
789
|
:type => Boolean,
|
790
|
+
:deprecated => true,
|
790
791
|
:allowed_from_server => false,
|
791
|
-
:description => deprecated_description(:'instrumentation.sinatra', 'If
|
792
|
+
:description => deprecated_description(:'instrumentation.sinatra', 'If `true` , disables [Sinatra instrumentation](/docs/agents/ruby-agent/frameworks/sinatra-support).' )
|
792
793
|
},
|
793
794
|
:disable_sinatra_auto_middleware => {
|
794
795
|
:default => false,
|
795
796
|
:public => true,
|
796
797
|
:type => Boolean,
|
797
798
|
:allowed_from_server => false,
|
798
|
-
:description => 'If
|
799
|
+
:description => 'If `true`, disables agent middleware for Sinatra. This middleware is responsible for advanced feature support such as [cross application tracing](/docs/apm/transactions/cross-application-traces/cross-application-tracing), [page load timing](/docs/browser/new-relic-browser/getting-started/new-relic-browser), and [error collection](/docs/apm/applications-menu/events/view-apm-error-analytics).'
|
799
800
|
},
|
800
801
|
:disable_view_instrumentation => {
|
801
802
|
:default => false,
|
802
803
|
:public => true,
|
803
804
|
:type => Boolean,
|
804
805
|
:allowed_from_server => false,
|
805
|
-
:description => 'If
|
806
|
+
:description => 'If `true`, disables view instrumentation.'
|
806
807
|
},
|
807
808
|
:disable_harvest_thread => {
|
808
809
|
:default => false,
|
@@ -823,14 +824,14 @@ module NewRelic
|
|
823
824
|
:public => true,
|
824
825
|
:type => Boolean,
|
825
826
|
:allowed_from_server => false,
|
826
|
-
:description => 'If
|
827
|
+
:description => 'If `true`, disables active record instrumentation.'
|
827
828
|
},
|
828
829
|
:prepend_active_record_instrumentation => {
|
829
830
|
:default => false,
|
830
831
|
:public => true,
|
831
832
|
:type => Boolean,
|
832
833
|
:allowed_from_server => false,
|
833
|
-
:description => 'If
|
834
|
+
:description => 'If `true`, uses `Module#prepend` rather than `alias_method` for ActiveRecord instrumentation.'
|
834
835
|
},
|
835
836
|
:prepend_net_instrumentation => {
|
836
837
|
:default => true,
|
@@ -839,7 +840,7 @@ module NewRelic
|
|
839
840
|
:allowed_from_server => false,
|
840
841
|
:deprecated => true,
|
841
842
|
:description => deprecated_description(:'instrumentation.net_http',
|
842
|
-
'If
|
843
|
+
'If `true`, uses `Module#prepend` rather than alias_method for Net::HTTP instrumentation.'
|
843
844
|
)
|
844
845
|
},
|
845
846
|
:'instrumentation.net_http' => {
|
@@ -945,7 +946,7 @@ module NewRelic
|
|
945
946
|
:dynamic_name => true,
|
946
947
|
:allowed_from_server => false,
|
947
948
|
:description => "Controls auto-instrumentation of Rack. When enabled, the agent hooks into the " \
|
948
|
-
"
|
949
|
+
"`to_app` method in Rack::Builder to find gems to instrument during " \
|
949
950
|
"application startup. May be one of [auto|prepend|chain|disabled]."
|
950
951
|
},
|
951
952
|
:'instrumentation.rack_urlmap' => {
|
@@ -963,7 +964,7 @@ module NewRelic
|
|
963
964
|
:dynamic_name => true,
|
964
965
|
:allowed_from_server => false,
|
965
966
|
:description => "Controls auto-instrumentation of Puma::Rack. When enabled, the agent hooks into the " \
|
966
|
-
"
|
967
|
+
"`to_app` method in Puma::Rack::Builder to find gems to instrument during " \
|
967
968
|
"application startup. May be one of [auto|prepend|chain|disabled]."
|
968
969
|
},
|
969
970
|
:'instrumentation.puma_rack_urlmap' => {
|
@@ -998,12 +999,28 @@ module NewRelic
|
|
998
999
|
:allowed_from_server => false,
|
999
1000
|
:description => 'Controls auto-instrumentation of dalli gem for Memcache at start up. May be one of [auto|prepend|chain|disabled].'
|
1000
1001
|
},
|
1002
|
+
:'instrumentation.logger' => {
|
1003
|
+
:default => "auto",
|
1004
|
+
:public => true,
|
1005
|
+
:type => String,
|
1006
|
+
:dynamic_name => true,
|
1007
|
+
:allowed_from_server => false,
|
1008
|
+
:description => 'Controls auto-instrumentation of Ruby standard library Logger at start up. May be one of [auto|prepend|chain|disabled].'
|
1009
|
+
},
|
1010
|
+
:'instrumentation.tilt' => {
|
1011
|
+
:default => "auto",
|
1012
|
+
:public => true,
|
1013
|
+
:type => String,
|
1014
|
+
:dynamic_name => true,
|
1015
|
+
:allowed_from_server => false,
|
1016
|
+
:description => 'Controls auto-instrumentation of Tilt at start up. May be one of [auto|prepend|chain|disabled].'
|
1017
|
+
},
|
1001
1018
|
:disable_data_mapper => {
|
1002
1019
|
:default => false,
|
1003
1020
|
:public => true,
|
1004
1021
|
:type => Boolean,
|
1005
1022
|
:allowed_from_server => false,
|
1006
|
-
:description => 'If
|
1023
|
+
:description => 'If `true`, disables DataMapper instrumentation.'
|
1007
1024
|
},
|
1008
1025
|
:disable_activejob => {
|
1009
1026
|
:default => false,
|
@@ -1011,7 +1028,7 @@ module NewRelic
|
|
1011
1028
|
:type => Boolean,
|
1012
1029
|
:dynamic_name => true,
|
1013
1030
|
:allowed_from_server => false,
|
1014
|
-
:description => 'If
|
1031
|
+
:description => 'If `true`, disables ActiveJob instrumentation.'
|
1015
1032
|
},
|
1016
1033
|
:disable_action_cable_instrumentation => {
|
1017
1034
|
:default => false,
|
@@ -1019,7 +1036,7 @@ module NewRelic
|
|
1019
1036
|
:type => Boolean,
|
1020
1037
|
:dynamic_name => true,
|
1021
1038
|
:allowed_from_server => false,
|
1022
|
-
:description => 'If
|
1039
|
+
:description => 'If `true`, disables Action Cable instrumentation.'
|
1023
1040
|
},
|
1024
1041
|
:disable_active_storage => {
|
1025
1042
|
:default => false,
|
@@ -1027,7 +1044,7 @@ module NewRelic
|
|
1027
1044
|
:type => Boolean,
|
1028
1045
|
:dynamic_name => true,
|
1029
1046
|
:allowed_from_server => false,
|
1030
|
-
:description => 'If
|
1047
|
+
:description => 'If `true`, disables ActiveStorage instrumentation.'
|
1031
1048
|
},
|
1032
1049
|
:disable_memcached => {
|
1033
1050
|
:default => value_of(:disable_memcache_instrumentation),
|
@@ -1035,7 +1052,7 @@ module NewRelic
|
|
1035
1052
|
:type => Boolean,
|
1036
1053
|
:deprecated => true,
|
1037
1054
|
:allowed_from_server => false,
|
1038
|
-
:description => deprecated_description(:'instrumentation.memcached', 'If
|
1055
|
+
:description => deprecated_description(:'instrumentation.memcached', 'If `true`, disables instrumentation for the memcached gem.')
|
1039
1056
|
},
|
1040
1057
|
:disable_memcache_client => {
|
1041
1058
|
:default => value_of(:disable_memcache_instrumentation),
|
@@ -1043,7 +1060,7 @@ module NewRelic
|
|
1043
1060
|
:type => Boolean,
|
1044
1061
|
:deprecated => true,
|
1045
1062
|
:allowed_from_server => false,
|
1046
|
-
:description => deprecated_description(:'instrumentation.memcache-client', 'If
|
1063
|
+
:description => deprecated_description(:'instrumentation.memcache-client', 'If `true`, disables instrumentation for the memcache-client gem.')
|
1047
1064
|
},
|
1048
1065
|
:disable_dalli => {
|
1049
1066
|
:default => value_of(:disable_memcache_instrumentation),
|
@@ -1051,7 +1068,7 @@ module NewRelic
|
|
1051
1068
|
:type => Boolean,
|
1052
1069
|
:deprecated => true,
|
1053
1070
|
:allowed_from_server => false,
|
1054
|
-
:description => deprecated_description(:'instrumentation.memcache', 'If
|
1071
|
+
:description => deprecated_description(:'instrumentation.memcache', 'If `true`, disables instrumentation for the dalli gem.')
|
1055
1072
|
},
|
1056
1073
|
:disable_dalli_cas_client => {
|
1057
1074
|
:default => value_of(:disable_memcache_instrumentation),
|
@@ -1059,7 +1076,7 @@ module NewRelic
|
|
1059
1076
|
:type => Boolean,
|
1060
1077
|
:deprecated => true,
|
1061
1078
|
:allowed_from_server => false,
|
1062
|
-
:description => deprecated_description(:'instrumentation.memcache', "If
|
1079
|
+
:description => deprecated_description(:'instrumentation.memcache', "If `true`, disables instrumentation for the dalli gem\'s additional CAS client support.")
|
1063
1080
|
},
|
1064
1081
|
:disable_memcache_instrumentation => {
|
1065
1082
|
:default => false,
|
@@ -1067,14 +1084,14 @@ module NewRelic
|
|
1067
1084
|
:type => Boolean,
|
1068
1085
|
:deprecated => true,
|
1069
1086
|
:allowed_from_server => false,
|
1070
|
-
:description => deprecated_description(:'instrumentation.memcache', 'If
|
1087
|
+
:description => deprecated_description(:'instrumentation.memcache', 'If `true`, disables memcache instrumentation.')
|
1071
1088
|
},
|
1072
1089
|
:disable_gc_profiler => {
|
1073
1090
|
:default => false,
|
1074
1091
|
:public => true,
|
1075
1092
|
:type => Boolean,
|
1076
1093
|
:allowed_from_server => false,
|
1077
|
-
:description => 'If
|
1094
|
+
:description => 'If `true`, disables the use of GC::Profiler to measure time spent in garbage collection'
|
1078
1095
|
},
|
1079
1096
|
:'sidekiq.capture_params' => {
|
1080
1097
|
:default => false,
|
@@ -1083,7 +1100,7 @@ module NewRelic
|
|
1083
1100
|
:allowed_from_server => false,
|
1084
1101
|
:dynamic_name => true,
|
1085
1102
|
:deprecated => true,
|
1086
|
-
:description => 'If
|
1103
|
+
:description => 'If `true`, enables the capture of job arguments for transaction traces and traced errors in Sidekiq.'
|
1087
1104
|
},
|
1088
1105
|
:'resque.capture_params' => {
|
1089
1106
|
:default => false,
|
@@ -1092,7 +1109,7 @@ module NewRelic
|
|
1092
1109
|
:allowed_from_server => false,
|
1093
1110
|
:dynamic_name => true,
|
1094
1111
|
:deprecated => true,
|
1095
|
-
:description => 'If
|
1112
|
+
:description => 'If `true`, enables the capture of job arguments for transaction traces and traced errors in Resque.'
|
1096
1113
|
},
|
1097
1114
|
:'resque.use_ruby_dns' => {
|
1098
1115
|
:default => true,
|
@@ -1113,37 +1130,37 @@ module NewRelic
|
|
1113
1130
|
:public => true,
|
1114
1131
|
:type => Boolean,
|
1115
1132
|
:allowed_from_server => true,
|
1116
|
-
:description => 'If
|
1133
|
+
:description => 'If `true`, enables collection of [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces).'
|
1117
1134
|
},
|
1118
1135
|
:'transaction_tracer.transaction_threshold' => {
|
1119
1136
|
:default => DefaultSource.transaction_tracer_transaction_threshold,
|
1120
1137
|
:public => true,
|
1121
1138
|
:type => Float,
|
1122
1139
|
:allowed_from_server => true,
|
1123
|
-
:description => 'Specify a threshold in seconds. Transactions with a duration longer than this threshold are eligible for transaction traces. Specify a float value or the string
|
1140
|
+
:description => 'Specify a threshold in seconds. Transactions with a duration longer than this threshold are eligible for transaction traces. Specify a float value or the string `apdex_f`.'
|
1124
1141
|
},
|
1125
1142
|
:'transaction_tracer.record_sql' => {
|
1126
1143
|
:default => 'obfuscated',
|
1127
1144
|
:public => true,
|
1128
1145
|
:type => String,
|
1129
1146
|
:allowed_from_server => true,
|
1130
|
-
:description => 'Obfuscation level for SQL queries reported in transaction trace nodes
|
1147
|
+
:description => 'Obfuscation level for SQL queries reported in transaction trace nodes.
|
1131
1148
|
|
1132
|
-
|
1149
|
+
By default, this is set to `obfuscated`, which strips out the numeric and string literals.
|
1133
1150
|
|
1134
1151
|
<ul>
|
1135
|
-
<li>If you do not want the agent to capture query information, set this to
|
1136
|
-
<li>If you want the agent to capture all query information in its original form, set this to
|
1137
|
-
<li>When you enable
|
1152
|
+
<li>If you do not want the agent to capture query information, set this to `none`.</li>
|
1153
|
+
<li>If you want the agent to capture all query information in its original form, set this to `raw`.</li>
|
1154
|
+
<li>When you enable [high security mode](/docs/agents/manage-apm-agents/configuration/high-security-mode), this is automatically set to `obfuscated`.</li>
|
1138
1155
|
</ul>
|
1139
|
-
|
1156
|
+
'
|
1140
1157
|
},
|
1141
1158
|
:'transaction_tracer.record_redis_arguments' => {
|
1142
1159
|
:default => false,
|
1143
1160
|
:public => true,
|
1144
1161
|
:type => Boolean,
|
1145
1162
|
:allowed_from_server => false,
|
1146
|
-
:description => 'If
|
1163
|
+
:description => 'If `true`, the agent records Redis command arguments in transaction traces.'
|
1147
1164
|
},
|
1148
1165
|
:'transaction_tracer.capture_attributes' => {
|
1149
1166
|
:default => true,
|
@@ -1151,21 +1168,21 @@ module NewRelic
|
|
1151
1168
|
:type => Boolean,
|
1152
1169
|
:deprecated => true,
|
1153
1170
|
:allowed_from_server => false,
|
1154
|
-
:description => '
|
1171
|
+
:description => 'Use [`transaction_tracer.attributes.enabled`](#transaction_tracer-attributes-enabled) instead.'
|
1155
1172
|
},
|
1156
1173
|
:'transaction_tracer.explain_threshold' => {
|
1157
1174
|
:default => 0.5,
|
1158
1175
|
:public => true,
|
1159
1176
|
:type => Float,
|
1160
1177
|
:allowed_from_server => true,
|
1161
|
-
:description => 'Threshold (in seconds) above which the agent will collect explain plans. Relevant only when
|
1178
|
+
:description => 'Threshold (in seconds) above which the agent will collect explain plans. Relevant only when [`explain_enabled`](#transaction_tracer.explain_enabled) is true.'
|
1162
1179
|
},
|
1163
1180
|
:'transaction_tracer.explain_enabled' => {
|
1164
1181
|
:default => true,
|
1165
1182
|
:public => true,
|
1166
1183
|
:type => Boolean,
|
1167
1184
|
:allowed_from_server => true,
|
1168
|
-
:description => 'If
|
1185
|
+
:description => 'If `true`, enables the collection of explain plans in transaction traces. This setting will also apply to explain plans in slow SQL traces if [`slow_sql.explain_enabled`](#slow_sql-explain_enabled) is not set separately.'
|
1169
1186
|
},
|
1170
1187
|
:'transaction_tracer.stack_trace_threshold' => {
|
1171
1188
|
:default => 0.5,
|
@@ -1186,7 +1203,7 @@ module NewRelic
|
|
1186
1203
|
:public => true,
|
1187
1204
|
:type => Boolean,
|
1188
1205
|
:allowed_from_server => false,
|
1189
|
-
:description => 'If
|
1206
|
+
:description => 'If `true`, disables [Sequel instrumentation](/docs/agents/ruby-agent/frameworks/sequel-instrumentation).'
|
1190
1207
|
},
|
1191
1208
|
:disable_database_instrumentation => {
|
1192
1209
|
:default => false,
|
@@ -1194,7 +1211,7 @@ module NewRelic
|
|
1194
1211
|
:type => Boolean,
|
1195
1212
|
:allowed_from_server => false,
|
1196
1213
|
:deprecated => true,
|
1197
|
-
:description => '
|
1214
|
+
:description => 'Use [`disable_sequel_instrumentation`](#disable_sequel_instrumentation) instead.'
|
1198
1215
|
},
|
1199
1216
|
:disable_mongo => {
|
1200
1217
|
:default => false,
|
@@ -1203,7 +1220,7 @@ module NewRelic
|
|
1203
1220
|
:allowed_from_server => false,
|
1204
1221
|
:dynamic_name => true,
|
1205
1222
|
:deprecated => true,
|
1206
|
-
:description => deprecated_description(:'instrumentation.mongo', 'If
|
1223
|
+
:description => deprecated_description(:'instrumentation.mongo', 'If `true`, the agent won\'t install [instrumentation for the Mongo gem](/docs/agents/ruby-agent/frameworks/mongo-instrumentation).')
|
1207
1224
|
},
|
1208
1225
|
:disable_redis => {
|
1209
1226
|
:default => false,
|
@@ -1211,7 +1228,7 @@ module NewRelic
|
|
1211
1228
|
:type => Boolean,
|
1212
1229
|
:deprecated => true,
|
1213
1230
|
:allowed_from_server => false,
|
1214
|
-
:description => deprecated_description(:'instrumentation.redis', 'If
|
1231
|
+
:description => deprecated_description(:'instrumentation.redis', 'If `true`, the agent won\'t install [instrumentation for Redis](/docs/agents/ruby-agent/frameworks/redis-instrumentation).')
|
1215
1232
|
},
|
1216
1233
|
:disable_redis_instrumentation => {
|
1217
1234
|
:default => false,
|
@@ -1226,35 +1243,35 @@ module NewRelic
|
|
1226
1243
|
:public => true,
|
1227
1244
|
:type => Boolean,
|
1228
1245
|
:allowed_from_server => true,
|
1229
|
-
:description => 'If
|
1246
|
+
:description => 'If `true`, the agent will collect metadata about messages and attach them as segment parameters.'
|
1230
1247
|
},
|
1231
1248
|
:'slow_sql.enabled' => {
|
1232
1249
|
:default => value_of(:'transaction_tracer.enabled'),
|
1233
1250
|
:public => true,
|
1234
1251
|
:type => Boolean,
|
1235
1252
|
:allowed_from_server => true,
|
1236
|
-
:description => 'If
|
1253
|
+
:description => 'If `true`, the agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details).'
|
1237
1254
|
},
|
1238
1255
|
:'slow_sql.explain_threshold' => {
|
1239
1256
|
:default => value_of(:'transaction_tracer.explain_threshold'),
|
1240
1257
|
:public => true,
|
1241
1258
|
:type => Float,
|
1242
1259
|
:allowed_from_server => true,
|
1243
|
-
:description => 'Specify a threshold in seconds. The agent collects
|
1260
|
+
:description => 'Specify a threshold in seconds. The agent collects [slow SQL queries](/docs/apm/applications-menu/monitoring/viewing-slow-query-details) and explain plans that exceed this threshold.'
|
1244
1261
|
},
|
1245
1262
|
:'slow_sql.explain_enabled' => {
|
1246
1263
|
:default => value_of(:'transaction_tracer.explain_enabled'),
|
1247
1264
|
:public => true,
|
1248
1265
|
:type => Boolean,
|
1249
1266
|
:allowed_from_server => true,
|
1250
|
-
:description => 'If
|
1267
|
+
:description => 'If `true`, the agent collects explain plans in slow SQL queries. If this setting is omitted, the [`transaction_tracer.explain_enabled`](#transaction_tracer-explain_enabled) setting will be applied as the default setting for explain plans in slow SQL as well.'
|
1251
1268
|
},
|
1252
1269
|
:'slow_sql.record_sql' => {
|
1253
1270
|
:default => value_of(:'transaction_tracer.record_sql'),
|
1254
1271
|
:public => true,
|
1255
1272
|
:type => String,
|
1256
1273
|
:allowed_from_server => true,
|
1257
|
-
:description => 'Defines an obfuscation level for slow SQL queries. Valid options are
|
1274
|
+
:description => 'Defines an obfuscation level for slow SQL queries. Valid options are `obfuscated`, `raw`, or `none`).'
|
1258
1275
|
},
|
1259
1276
|
:'slow_sql.use_longer_sql_id' => {
|
1260
1277
|
:default => false,
|
@@ -1268,21 +1285,21 @@ module NewRelic
|
|
1268
1285
|
:public => true,
|
1269
1286
|
:type => Boolean,
|
1270
1287
|
:allowed_from_server => true,
|
1271
|
-
:description => 'If
|
1288
|
+
:description => 'If `true`, the agent captures Mongo queries in transaction traces.'
|
1272
1289
|
},
|
1273
1290
|
:'mongo.obfuscate_queries' => {
|
1274
1291
|
:default => true,
|
1275
1292
|
:public => true,
|
1276
1293
|
:type => Boolean,
|
1277
1294
|
:allowed_from_server => true,
|
1278
|
-
:description => 'If
|
1295
|
+
:description => 'If `true`, the agent obfuscates Mongo queries in transaction traces.'
|
1279
1296
|
},
|
1280
1297
|
:'error_collector.enabled' => {
|
1281
1298
|
:default => true,
|
1282
1299
|
:public => true,
|
1283
1300
|
:type => Boolean,
|
1284
1301
|
:allowed_from_server => true,
|
1285
|
-
:description => 'If
|
1302
|
+
:description => 'If `true`, the agent captures traced errors and error count metrics.'
|
1286
1303
|
},
|
1287
1304
|
:'error_collector.capture_attributes' => {
|
1288
1305
|
:default => true,
|
@@ -1290,14 +1307,64 @@ module NewRelic
|
|
1290
1307
|
:type => Boolean,
|
1291
1308
|
:deprecated => true,
|
1292
1309
|
:allowed_from_server => false,
|
1293
|
-
:description => '
|
1310
|
+
:description => 'Use [`error_collector.attributes.enabled`](#error_collector-attributes-enabled) instead.'
|
1294
1311
|
},
|
1295
1312
|
:'error_collector.ignore_errors' => {
|
1296
1313
|
:default => 'ActionController::RoutingError,Sinatra::NotFound',
|
1297
1314
|
:public => true,
|
1298
1315
|
:type => String,
|
1316
|
+
:deprecated => true,
|
1317
|
+
:allowed_from_server => true,
|
1318
|
+
:dynamic_name => true,
|
1319
|
+
:description => 'Use `error_collector.ignore_classes` instead. Specify a comma-delimited list of error classes that the agent should ignore.'
|
1320
|
+
},
|
1321
|
+
:'error_collector.ignore_classes' => {
|
1322
|
+
:default => [],
|
1323
|
+
:public => true,
|
1324
|
+
:type => Array,
|
1325
|
+
:allowed_from_server => true,
|
1326
|
+
:dynamic_name => true,
|
1327
|
+
:description => 'A list of error classes that the agent should ignore. *Note: this setting cannot be set via environment variable.*'
|
1328
|
+
},
|
1329
|
+
:'error_collector.ignore_messages' => {
|
1330
|
+
:default => {},
|
1331
|
+
:public => true,
|
1332
|
+
:type => Hash,
|
1333
|
+
:allowed_from_server => true,
|
1334
|
+
:dynamic_name => true,
|
1335
|
+
:description => 'A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be ignored. *Note: this setting cannot be set via environment variable.*'
|
1336
|
+
},
|
1337
|
+
:'error_collector.ignore_status_codes' => {
|
1338
|
+
:default => '',
|
1339
|
+
:public => true,
|
1340
|
+
:type => String,
|
1341
|
+
:allowed_from_server => true,
|
1342
|
+
:dynamic_name => true,
|
1343
|
+
:description => 'A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be ignored.'
|
1344
|
+
},
|
1345
|
+
:'error_collector.expected_classes' => {
|
1346
|
+
:default => [],
|
1347
|
+
:public => true,
|
1348
|
+
:type => Array,
|
1299
1349
|
:allowed_from_server => true,
|
1300
|
-
:
|
1350
|
+
:dynamic_name => true,
|
1351
|
+
:description => 'A list of error classes that the agent should treat as expected. *Note: this setting cannot be set via environment variable.*'
|
1352
|
+
},
|
1353
|
+
:'error_collector.expected_messages' => {
|
1354
|
+
:default => {},
|
1355
|
+
:public => true,
|
1356
|
+
:type => Hash,
|
1357
|
+
:allowed_from_server => true,
|
1358
|
+
:dynamic_name => true,
|
1359
|
+
:description => 'A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be treated as expected. *Note: this setting cannot be set via environment variable.*'
|
1360
|
+
},
|
1361
|
+
:'error_collector.expected_status_codes' => {
|
1362
|
+
:default => '',
|
1363
|
+
:public => true,
|
1364
|
+
:type => String,
|
1365
|
+
:allowed_from_server => true,
|
1366
|
+
:dynamic_name => true,
|
1367
|
+
:description => 'A comma separated list of status codes, possibly including ranges. Errors associated with these status codes, where applicable, will be treated as expected.'
|
1301
1368
|
},
|
1302
1369
|
:'error_collector.max_backtrace_frames' => {
|
1303
1370
|
:default => 50,
|
@@ -1312,14 +1379,14 @@ module NewRelic
|
|
1312
1379
|
:type => Boolean,
|
1313
1380
|
:allowed_from_server => true,
|
1314
1381
|
:dynamic_name => true,
|
1315
|
-
:description => 'If
|
1382
|
+
:description => 'If `true`, the agent collects [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights).'
|
1316
1383
|
},
|
1317
1384
|
:'error_collector.max_event_samples_stored' => {
|
1318
1385
|
:default => 100,
|
1319
1386
|
:public => true,
|
1320
1387
|
:type => Integer,
|
1321
1388
|
:allowed_from_server => true,
|
1322
|
-
:description => 'Defines the maximum number of
|
1389
|
+
:description => 'Defines the maximum number of [TransactionError events](/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights) sent to Insights per harvest cycle.'
|
1323
1390
|
},
|
1324
1391
|
:'rum.enabled' => {
|
1325
1392
|
:default => true,
|
@@ -1368,7 +1435,7 @@ module NewRelic
|
|
1368
1435
|
:public => true,
|
1369
1436
|
:type => Boolean,
|
1370
1437
|
:allowed_from_server => true,
|
1371
|
-
:description => 'If
|
1438
|
+
:description => 'If `true`, enables [auto-injection](/docs/browser/new-relic-browser/installation-configuration/adding-apps-new-relic-browser#select-apm-app) of the JavaScript header for page load timing (sometimes referred to as real user monitoring or RUM).'
|
1372
1439
|
},
|
1373
1440
|
:'browser_monitoring.capture_attributes' => {
|
1374
1441
|
:default => false,
|
@@ -1376,7 +1443,7 @@ module NewRelic
|
|
1376
1443
|
:type => Boolean,
|
1377
1444
|
:deprecated => true,
|
1378
1445
|
:allowed_from_server => false,
|
1379
|
-
:description => '
|
1446
|
+
:description => 'Use [`browser_monitoring.attributes.enabled`](#browser_monitoring-attributes-enabled) instead.'
|
1380
1447
|
},
|
1381
1448
|
:'browser_monitoring.loader' => {
|
1382
1449
|
:default => DefaultSource.browser_monitoring_loader,
|
@@ -1390,7 +1457,7 @@ module NewRelic
|
|
1390
1457
|
:public => false,
|
1391
1458
|
:type => String,
|
1392
1459
|
:allowed_from_server => true,
|
1393
|
-
:description => 'Version of JavaScript agent loader (returned from the New Relic
|
1460
|
+
:description => 'Version of JavaScript agent loader (returned from the New Relic [collector](/docs/apm/new-relic-apm/getting-started/glossary#collector).)'
|
1394
1461
|
},
|
1395
1462
|
:'browser_monitoring.debug' => {
|
1396
1463
|
:default => false,
|
@@ -1430,11 +1497,15 @@ module NewRelic
|
|
1430
1497
|
:description => 'List of trusted New Relic account IDs for the purposes of cross-application tracing. Inbound requests from applications including cross-application headers that do not come from an account in this list will be ignored.'
|
1431
1498
|
},
|
1432
1499
|
:"cross_application_tracer.enabled" => {
|
1433
|
-
:default =>
|
1500
|
+
:default => false,
|
1434
1501
|
:public => true,
|
1435
1502
|
:type => Boolean,
|
1436
1503
|
:allowed_from_server => true,
|
1437
|
-
:
|
1504
|
+
:deprecated => true,
|
1505
|
+
:description => deprecated_description(
|
1506
|
+
:'distributed_tracing-enabled',
|
1507
|
+
'If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/cross-application-tracing-ruby/)'
|
1508
|
+
)
|
1438
1509
|
},
|
1439
1510
|
:cross_application_tracing => {
|
1440
1511
|
:default => nil,
|
@@ -1443,7 +1514,7 @@ module NewRelic
|
|
1443
1514
|
:type => Boolean,
|
1444
1515
|
:allowed_from_server => false,
|
1445
1516
|
:deprecated => true,
|
1446
|
-
:description => 'Deprecated in favor of
|
1517
|
+
:description => 'Deprecated in favor of distributed_tracing.enabled'
|
1447
1518
|
},
|
1448
1519
|
:encoding_key => {
|
1449
1520
|
:default => '',
|
@@ -1464,7 +1535,7 @@ module NewRelic
|
|
1464
1535
|
:public => true,
|
1465
1536
|
:type => Boolean,
|
1466
1537
|
:allowed_from_server => true,
|
1467
|
-
:description => 'If
|
1538
|
+
:description => 'If `true`, enables use of the [thread profiler](/docs/apm/applications-menu/events/thread-profiler-tool).'
|
1468
1539
|
},
|
1469
1540
|
:'thread_profiler.max_profile_overhead' => {
|
1470
1541
|
:default => 0.05,
|
@@ -1478,14 +1549,14 @@ module NewRelic
|
|
1478
1549
|
:public => true,
|
1479
1550
|
:type => String,
|
1480
1551
|
:allowed_from_server => false,
|
1481
|
-
:description => 'Specifies a marshaller for transmitting data to the New Relic
|
1552
|
+
:description => 'Specifies a marshaller for transmitting data to the New Relic [collector](/docs/apm/new-relic-apm/getting-started/glossary#collector). Currently `json` is the only valid value for this setting.'
|
1482
1553
|
},
|
1483
1554
|
:'analytics_events.enabled' => {
|
1484
1555
|
:default => true,
|
1485
1556
|
:public => true,
|
1486
1557
|
:type => Boolean,
|
1487
1558
|
:allowed_from_server => true,
|
1488
|
-
:description => 'If
|
1559
|
+
:description => 'If `true`, enables analytics event sampling.'
|
1489
1560
|
},
|
1490
1561
|
:'analytics_events.max_samples_stored' => {
|
1491
1562
|
:default => 1200,
|
@@ -1500,7 +1571,7 @@ module NewRelic
|
|
1500
1571
|
:type => Boolean,
|
1501
1572
|
:deprecated => true,
|
1502
1573
|
:allowed_from_server => false,
|
1503
|
-
:description => '
|
1574
|
+
:description => 'Use [`transaction_events.attributes.enabled`](#transaction_events-attributes-enabled) instead.'
|
1504
1575
|
},
|
1505
1576
|
:restart_thread_in_children => {
|
1506
1577
|
:default => true,
|
@@ -1529,7 +1600,7 @@ module NewRelic
|
|
1529
1600
|
:type => Boolean,
|
1530
1601
|
:dynamic_name => true,
|
1531
1602
|
:allowed_from_server => false,
|
1532
|
-
:description => 'If
|
1603
|
+
:description => 'If `true`, the agent won\'t [sample performance measurements from the Ruby VM](/docs/agents/ruby-agent/features/ruby-vm-measurements).'
|
1533
1604
|
},
|
1534
1605
|
:disable_memory_sampler => {
|
1535
1606
|
:default => false,
|
@@ -1537,7 +1608,7 @@ module NewRelic
|
|
1537
1608
|
:type => Boolean,
|
1538
1609
|
:dynamic_name => true,
|
1539
1610
|
:allowed_from_server => false,
|
1540
|
-
:description => 'If
|
1611
|
+
:description => 'If `true`, the agent won\'t sample the memory usage of the host process.'
|
1541
1612
|
},
|
1542
1613
|
:disable_cpu_sampler => {
|
1543
1614
|
:default => false,
|
@@ -1545,7 +1616,7 @@ module NewRelic
|
|
1545
1616
|
:type => Boolean,
|
1546
1617
|
:dynamic_name => true,
|
1547
1618
|
:allowed_from_server => false,
|
1548
|
-
:description => 'If
|
1619
|
+
:description => 'If `true`, the agent won\'t sample the CPU usage of the host process.'
|
1549
1620
|
},
|
1550
1621
|
:disable_delayed_job_sampler => {
|
1551
1622
|
:default => false,
|
@@ -1553,7 +1624,7 @@ module NewRelic
|
|
1553
1624
|
:type => Boolean,
|
1554
1625
|
:dynamic_name => true,
|
1555
1626
|
:allowed_from_server => false,
|
1556
|
-
:description => 'If
|
1627
|
+
:description => 'If `true`, the agent won\'t measure the depth of Delayed Job queues.'
|
1557
1628
|
},
|
1558
1629
|
:disable_active_record_notifications => {
|
1559
1630
|
:default => false,
|
@@ -1561,7 +1632,7 @@ module NewRelic
|
|
1561
1632
|
:type => Boolean,
|
1562
1633
|
:dynamic_name => true,
|
1563
1634
|
:allowed_from_server => false,
|
1564
|
-
:description => 'If
|
1635
|
+
:description => 'If `true`, disables instrumentation for ActiveRecord 4, 5, and 6.'
|
1565
1636
|
},
|
1566
1637
|
:disable_bunny => {
|
1567
1638
|
:default => false,
|
@@ -1570,7 +1641,7 @@ module NewRelic
|
|
1570
1641
|
:deprecated => true,
|
1571
1642
|
:dynamic_name => true,
|
1572
1643
|
:allowed_from_server => false,
|
1573
|
-
:description => deprecated_description(:'instrumentation.bunny', 'If
|
1644
|
+
:description => deprecated_description(:'instrumentation.bunny', 'If `true`, disables instrumentation for the bunny gem.')
|
1574
1645
|
},
|
1575
1646
|
:disable_curb => {
|
1576
1647
|
:default => false,
|
@@ -1579,7 +1650,7 @@ module NewRelic
|
|
1579
1650
|
:deprecated => true,
|
1580
1651
|
:dynamic_name => true,
|
1581
1652
|
:allowed_from_server => false,
|
1582
|
-
:description => deprecated_description(:'instrumentation.curb', 'If
|
1653
|
+
:description => deprecated_description(:'instrumentation.curb', 'If `true`, disables instrumentation for the curb gem.' )
|
1583
1654
|
},
|
1584
1655
|
:disable_excon => {
|
1585
1656
|
:default => false,
|
@@ -1588,7 +1659,7 @@ module NewRelic
|
|
1588
1659
|
:dynamic_name => true,
|
1589
1660
|
:deprecated => true,
|
1590
1661
|
:allowed_from_server => false,
|
1591
|
-
:description => deprecated_description(:'instrumentation.excon', 'If
|
1662
|
+
:description => deprecated_description(:'instrumentation.excon', 'If `true`, disables instrumentation for the excon gem.')
|
1592
1663
|
},
|
1593
1664
|
:'instrumentation.excon' => {
|
1594
1665
|
:default => instrumentation_value_of(:disable_excon),
|
@@ -1605,7 +1676,7 @@ module NewRelic
|
|
1605
1676
|
:dynamic_name => true,
|
1606
1677
|
:deprecated => true,
|
1607
1678
|
:allowed_from_server => false,
|
1608
|
-
:description => deprecated_description(:'instrumentation.httpclient', 'If
|
1679
|
+
:description => deprecated_description(:'instrumentation.httpclient', 'If `true`, disables instrumentation for the httpclient gem.')
|
1609
1680
|
},
|
1610
1681
|
:disable_net_http => {
|
1611
1682
|
:default => false,
|
@@ -1615,7 +1686,7 @@ module NewRelic
|
|
1615
1686
|
:allowed_from_server => false,
|
1616
1687
|
:deprecated => true,
|
1617
1688
|
:description => deprecated_description(:'instrumentation.net_http',
|
1618
|
-
'If
|
1689
|
+
'If `true`, disables instrumentation for Net::HTTP.'
|
1619
1690
|
)
|
1620
1691
|
},
|
1621
1692
|
:disable_rack => {
|
@@ -1625,7 +1696,7 @@ module NewRelic
|
|
1625
1696
|
:dynamic_name => true,
|
1626
1697
|
:allowed_from_server => false,
|
1627
1698
|
:deprecated => true,
|
1628
|
-
:description => deprecated_description(:'instrumentation.rack', 'If
|
1699
|
+
:description => deprecated_description(:'instrumentation.rack', 'If `true`, prevents the agent from hooking into the `to_app` method in Rack::Builder to find gems to instrument during application startup.')
|
1629
1700
|
},
|
1630
1701
|
:disable_rack_urlmap => {
|
1631
1702
|
:default => false,
|
@@ -1634,7 +1705,7 @@ module NewRelic
|
|
1634
1705
|
:dynamic_name => true,
|
1635
1706
|
:allowed_from_server => false,
|
1636
1707
|
:deprecated => true,
|
1637
|
-
:description => deprecated_description(:'instrumentation.rack_urlmap', 'If
|
1708
|
+
:description => deprecated_description(:'instrumentation.rack_urlmap', 'If `true`, prevents the agent from hooking into Rack::URLMap to install middleware tracing.')
|
1638
1709
|
},
|
1639
1710
|
:disable_puma_rack => {
|
1640
1711
|
:default => value_of(:disable_rack),
|
@@ -1643,7 +1714,7 @@ module NewRelic
|
|
1643
1714
|
:dynamic_name => true,
|
1644
1715
|
:allowed_from_server => false,
|
1645
1716
|
:deprecated => true,
|
1646
|
-
:description => deprecated_description(:'instrumentation.puma_rack', 'If
|
1717
|
+
:description => deprecated_description(:'instrumentation.puma_rack', 'If `true`, prevents the agent from hooking into the `to_app` method in Puma::Rack::Builder to find gems to instrument during application startup.')
|
1647
1718
|
},
|
1648
1719
|
:disable_puma_rack_urlmap => {
|
1649
1720
|
:default => value_of(:disable_rack_urlmap),
|
@@ -1652,7 +1723,7 @@ module NewRelic
|
|
1652
1723
|
:dynamic_name => true,
|
1653
1724
|
:allowed_from_server => false,
|
1654
1725
|
:deprecated => true,
|
1655
|
-
:description => deprecated_description(:'instrumentation.puma_rack_urlmap', 'If
|
1726
|
+
:description => deprecated_description(:'instrumentation.puma_rack_urlmap', 'If `true`, prevents the agent from hooking into Puma::Rack::URLMap to install middleware tracing.')
|
1656
1727
|
},
|
1657
1728
|
:disable_typhoeus => {
|
1658
1729
|
:default => false,
|
@@ -1661,7 +1732,7 @@ module NewRelic
|
|
1661
1732
|
:dynamic_name => true,
|
1662
1733
|
:deprecated => true,
|
1663
1734
|
:allowed_from_server => false,
|
1664
|
-
:description => deprecated_description(:'instrumentation.typhoeus', 'If
|
1735
|
+
:description => deprecated_description(:'instrumentation.typhoeus', 'If `true`, the agent won\'t install instrumentation for the typhoeus gem.' )
|
1665
1736
|
},
|
1666
1737
|
:disable_httprb => {
|
1667
1738
|
:default => false,
|
@@ -1670,14 +1741,14 @@ module NewRelic
|
|
1670
1741
|
:dynamic_name => true,
|
1671
1742
|
:deprecated => true,
|
1672
1743
|
:allowed_from_server => false,
|
1673
|
-
:description => deprecated_description(:'instrumentation.httprb', 'If
|
1744
|
+
:description => deprecated_description(:'instrumentation.httprb', 'If `true`, the agent won\'t install instrumentation for the http.rb gem.' )
|
1674
1745
|
},
|
1675
1746
|
:disable_middleware_instrumentation => {
|
1676
1747
|
:default => false,
|
1677
1748
|
:public => true,
|
1678
1749
|
:type => Boolean,
|
1679
1750
|
:allowed_from_server => false,
|
1680
|
-
:description => 'If
|
1751
|
+
:description => 'If `true`, the agent won\'t wrap third-party middlewares in instrumentation (regardless of whether they are installed via Rack::Builder or Rails).'
|
1681
1752
|
},
|
1682
1753
|
:disable_rails_middleware => {
|
1683
1754
|
:default => false,
|
@@ -1691,7 +1762,7 @@ module NewRelic
|
|
1691
1762
|
:public => true,
|
1692
1763
|
:type => Boolean,
|
1693
1764
|
:allowed_from_server => false,
|
1694
|
-
:description => 'If
|
1765
|
+
:description => 'If `true`, the agent uses Heroku dyno names as the hostname.'
|
1695
1766
|
},
|
1696
1767
|
:'heroku.dyno_name_prefixes_to_shorten' => {
|
1697
1768
|
:default => ['scheduler', 'run'],
|
@@ -1706,14 +1777,14 @@ module NewRelic
|
|
1706
1777
|
:public => true,
|
1707
1778
|
:type => String,
|
1708
1779
|
:allowed_from_server => false,
|
1709
|
-
:description => 'Specify a custom host name for
|
1780
|
+
:description => 'Specify a custom host name for [display in the New Relic UI](/docs/apm/new-relic-apm/maintenance/add-rename-remove-hosts#display_name).'
|
1710
1781
|
},
|
1711
1782
|
:labels => {
|
1712
1783
|
:default => '',
|
1713
1784
|
:public => true,
|
1714
1785
|
:type => String,
|
1715
1786
|
:allowed_from_server => false,
|
1716
|
-
:description => 'A dictionary of
|
1787
|
+
:description => 'A dictionary of [label names](/docs/data-analysis/user-interface-functions/labels-categories-organize-your-apps-servers) and values that will be applied to the data sent from this agent. May also be expressed as a semicolon-delimited `;` string of colon-separated `:` pairs. For example, `<var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>`.'
|
1717
1788
|
},
|
1718
1789
|
:aggressive_keepalive => {
|
1719
1790
|
:default => true,
|
@@ -1743,7 +1814,7 @@ module NewRelic
|
|
1743
1814
|
:type => Array,
|
1744
1815
|
:allowed_from_server => true,
|
1745
1816
|
:transform => DefaultSource.method(:convert_to_regexp_list),
|
1746
|
-
:description => 'Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore.'
|
1817
|
+
:description => 'Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore.'
|
1747
1818
|
},
|
1748
1819
|
:'synthetics.traces_limit' => {
|
1749
1820
|
:default => 20,
|
@@ -1764,7 +1835,7 @@ module NewRelic
|
|
1764
1835
|
:public => true,
|
1765
1836
|
:type => Boolean,
|
1766
1837
|
:allowed_from_server => true,
|
1767
|
-
:description => 'If
|
1838
|
+
:description => 'If `true`, the agent captures [New Relic Insights custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents).'
|
1768
1839
|
},
|
1769
1840
|
:'custom_insights_events.max_samples_stored' => {
|
1770
1841
|
:default => 1000,
|
@@ -1781,7 +1852,7 @@ module NewRelic
|
|
1781
1852
|
:allowed_from_server => false,
|
1782
1853
|
:deprecated => true,
|
1783
1854
|
:description => deprecated_description(:'instrumentation.grape',
|
1784
|
-
'If
|
1855
|
+
'If `true`, the agent won\'t install Grape instrumentation.'
|
1785
1856
|
)
|
1786
1857
|
},
|
1787
1858
|
:disable_grape => {
|
@@ -1791,7 +1862,7 @@ module NewRelic
|
|
1791
1862
|
:allowed_from_server => false,
|
1792
1863
|
:deprecated => true,
|
1793
1864
|
:description => deprecated_description(:'instrumentation.grape',
|
1794
|
-
'If
|
1865
|
+
'If `true`, the agent won\'t install Grape instrumentation.'
|
1795
1866
|
)
|
1796
1867
|
},
|
1797
1868
|
:'instrumentation.grape' => {
|
@@ -1807,49 +1878,49 @@ module NewRelic
|
|
1807
1878
|
:public => true,
|
1808
1879
|
:type => Boolean,
|
1809
1880
|
:allowed_from_server => false,
|
1810
|
-
:description => 'If
|
1881
|
+
:description => 'If `true`, enables capture of attributes for all destinations.'
|
1811
1882
|
},
|
1812
1883
|
:'transaction_tracer.attributes.enabled' => {
|
1813
1884
|
:default => value_of(:'transaction_tracer.capture_attributes'),
|
1814
1885
|
:public => true,
|
1815
1886
|
:type => Boolean,
|
1816
1887
|
:allowed_from_server => false,
|
1817
|
-
:description => 'If
|
1888
|
+
:description => 'If `true`, the agent captures attributes from transaction traces.'
|
1818
1889
|
},
|
1819
1890
|
:'transaction_events.attributes.enabled' => {
|
1820
1891
|
:default => value_of(:'analytics_events.capture_attributes'),
|
1821
1892
|
:public => true,
|
1822
1893
|
:type => Boolean,
|
1823
1894
|
:allowed_from_server => false,
|
1824
|
-
:description => 'If
|
1895
|
+
:description => 'If `true`, the agent captures attributes from transaction events.'
|
1825
1896
|
},
|
1826
1897
|
:'error_collector.attributes.enabled' => {
|
1827
1898
|
:default => value_of(:'error_collector.capture_attributes'),
|
1828
1899
|
:public => true,
|
1829
1900
|
:type => Boolean,
|
1830
1901
|
:allowed_from_server => false,
|
1831
|
-
:description => 'If
|
1902
|
+
:description => 'If `true`, the agent captures attributes from error collection.'
|
1832
1903
|
},
|
1833
1904
|
:'browser_monitoring.attributes.enabled' => {
|
1834
1905
|
:default => value_of(:'browser_monitoring.capture_attributes'),
|
1835
1906
|
:public => true,
|
1836
1907
|
:type => Boolean,
|
1837
1908
|
:allowed_from_server => false,
|
1838
|
-
:description => 'If
|
1909
|
+
:description => 'If `true`, the agent captures attributes from browser monitoring.'
|
1839
1910
|
},
|
1840
1911
|
:'span_events.attributes.enabled' => {
|
1841
1912
|
:default => true,
|
1842
1913
|
:public => true,
|
1843
1914
|
:type => Boolean,
|
1844
1915
|
:allowed_from_server => false,
|
1845
|
-
:description => 'If
|
1916
|
+
:description => 'If `true`, the agent captures attributes on span events.'
|
1846
1917
|
},
|
1847
1918
|
:'transaction_segments.attributes.enabled' => {
|
1848
1919
|
:default => true,
|
1849
1920
|
:public => true,
|
1850
1921
|
:type => Boolean,
|
1851
1922
|
:allowed_from_server => false,
|
1852
|
-
:description => 'If
|
1923
|
+
:description => 'If `true`, the agent captures attributes on transaction segments.'
|
1853
1924
|
},
|
1854
1925
|
:'attributes.exclude' => {
|
1855
1926
|
:default => [],
|
@@ -1857,7 +1928,7 @@ module NewRelic
|
|
1857
1928
|
:type => Array,
|
1858
1929
|
:allowed_from_server => false,
|
1859
1930
|
:transform => DefaultSource.method(:convert_to_list),
|
1860
|
-
:description => 'Prefix of attributes to exclude from all destinations. Allows
|
1931
|
+
:description => 'Prefix of attributes to exclude from all destinations. Allows `*` as wildcard at end.'
|
1861
1932
|
},
|
1862
1933
|
:'transaction_tracer.attributes.exclude' => {
|
1863
1934
|
:default => [],
|
@@ -1865,7 +1936,7 @@ module NewRelic
|
|
1865
1936
|
:type => Array,
|
1866
1937
|
:allowed_from_server => false,
|
1867
1938
|
:transform => DefaultSource.method(:convert_to_list),
|
1868
|
-
:description => 'Prefix of attributes to exclude from transaction traces. Allows
|
1939
|
+
:description => 'Prefix of attributes to exclude from transaction traces. Allows `*` as wildcard at end.'
|
1869
1940
|
},
|
1870
1941
|
:'transaction_events.attributes.exclude' => {
|
1871
1942
|
:default => [],
|
@@ -1873,7 +1944,7 @@ module NewRelic
|
|
1873
1944
|
:type => Array,
|
1874
1945
|
:allowed_from_server => false,
|
1875
1946
|
:transform => DefaultSource.method(:convert_to_list),
|
1876
|
-
:description => 'Prefix of attributes to exclude from transaction events. Allows
|
1947
|
+
:description => 'Prefix of attributes to exclude from transaction events. Allows `*` as wildcard at end.'
|
1877
1948
|
},
|
1878
1949
|
:'error_collector.attributes.exclude' => {
|
1879
1950
|
:default => [],
|
@@ -1881,7 +1952,7 @@ module NewRelic
|
|
1881
1952
|
:type => Array,
|
1882
1953
|
:allowed_from_server => false,
|
1883
1954
|
:transform => DefaultSource.method(:convert_to_list),
|
1884
|
-
:description => 'Prefix of attributes to exclude from error collection. Allows
|
1955
|
+
:description => 'Prefix of attributes to exclude from error collection. Allows `*` as wildcard at end.'
|
1885
1956
|
},
|
1886
1957
|
:'browser_monitoring.attributes.exclude' => {
|
1887
1958
|
:default => [],
|
@@ -1889,7 +1960,7 @@ module NewRelic
|
|
1889
1960
|
:type => Array,
|
1890
1961
|
:allowed_from_server => false,
|
1891
1962
|
:transform => DefaultSource.method(:convert_to_list),
|
1892
|
-
:description => 'Prefix of attributes to exclude from browser monitoring. Allows
|
1963
|
+
:description => 'Prefix of attributes to exclude from browser monitoring. Allows `*` as wildcard at end.'
|
1893
1964
|
},
|
1894
1965
|
:'span_events.attributes.exclude' => {
|
1895
1966
|
:default => [],
|
@@ -1897,7 +1968,7 @@ module NewRelic
|
|
1897
1968
|
:type => Array,
|
1898
1969
|
:allowed_from_server => false,
|
1899
1970
|
:transform => DefaultSource.method(:convert_to_list),
|
1900
|
-
:description => 'Prefix of attributes to exclude from span events. Allows
|
1971
|
+
:description => 'Prefix of attributes to exclude from span events. Allows `*` as wildcard at end.'
|
1901
1972
|
},
|
1902
1973
|
:'transaction_segments.attributes.exclude' => {
|
1903
1974
|
:default => [],
|
@@ -1905,7 +1976,7 @@ module NewRelic
|
|
1905
1976
|
:type => Array,
|
1906
1977
|
:allowed_from_server => false,
|
1907
1978
|
:transform => DefaultSource.method(:convert_to_list),
|
1908
|
-
:description => 'Prefix of attributes to exclude from transaction segments. Allows
|
1979
|
+
:description => 'Prefix of attributes to exclude from transaction segments. Allows `*` as wildcard at end.'
|
1909
1980
|
},
|
1910
1981
|
:'attributes.include' => {
|
1911
1982
|
:default => [],
|
@@ -1913,7 +1984,7 @@ module NewRelic
|
|
1913
1984
|
:type => Array,
|
1914
1985
|
:allowed_from_server => false,
|
1915
1986
|
:transform => DefaultSource.method(:convert_to_list),
|
1916
|
-
:description => 'Prefix of attributes to include in all destinations. Allows
|
1987
|
+
:description => 'Prefix of attributes to include in all destinations. Allows `*` as wildcard at end.'
|
1917
1988
|
},
|
1918
1989
|
:'transaction_tracer.attributes.include' => {
|
1919
1990
|
:default => [],
|
@@ -1921,7 +1992,7 @@ module NewRelic
|
|
1921
1992
|
:type => Array,
|
1922
1993
|
:allowed_from_server => false,
|
1923
1994
|
:transform => DefaultSource.method(:convert_to_list),
|
1924
|
-
:description => 'Prefix of attributes to include in transaction traces. Allows
|
1995
|
+
:description => 'Prefix of attributes to include in transaction traces. Allows `*` as wildcard at end.'
|
1925
1996
|
},
|
1926
1997
|
:'transaction_events.attributes.include' => {
|
1927
1998
|
:default => [],
|
@@ -1929,7 +2000,7 @@ module NewRelic
|
|
1929
2000
|
:type => Array,
|
1930
2001
|
:allowed_from_server => false,
|
1931
2002
|
:transform => DefaultSource.method(:convert_to_list),
|
1932
|
-
:description => 'Prefix of attributes to include in transaction events. Allows
|
2003
|
+
:description => 'Prefix of attributes to include in transaction events. Allows `*` as wildcard at end.'
|
1933
2004
|
},
|
1934
2005
|
:'error_collector.attributes.include' => {
|
1935
2006
|
:default => [],
|
@@ -1937,7 +2008,7 @@ module NewRelic
|
|
1937
2008
|
:type => Array,
|
1938
2009
|
:allowed_from_server => false,
|
1939
2010
|
:transform => DefaultSource.method(:convert_to_list),
|
1940
|
-
:description => 'Prefix of attributes to include in error collection. Allows
|
2011
|
+
:description => 'Prefix of attributes to include in error collection. Allows `*` as wildcard at end.'
|
1941
2012
|
},
|
1942
2013
|
:'browser_monitoring.attributes.include' => {
|
1943
2014
|
:default => [],
|
@@ -1945,7 +2016,7 @@ module NewRelic
|
|
1945
2016
|
:type => Array,
|
1946
2017
|
:allowed_from_server => false,
|
1947
2018
|
:transform => DefaultSource.method(:convert_to_list),
|
1948
|
-
:description => 'Prefix of attributes to include in browser monitoring. Allows
|
2019
|
+
:description => 'Prefix of attributes to include in browser monitoring. Allows `*` as wildcard at end.'
|
1949
2020
|
},
|
1950
2021
|
:'span_events.attributes.include' => {
|
1951
2022
|
:default => [],
|
@@ -1953,7 +2024,7 @@ module NewRelic
|
|
1953
2024
|
:type => Array,
|
1954
2025
|
:allowed_from_server => false,
|
1955
2026
|
:transform => DefaultSource.method(:convert_to_list),
|
1956
|
-
:description => 'Prefix of attributes to include on span events. Allows
|
2027
|
+
:description => 'Prefix of attributes to include on span events. Allows `*` as wildcard at end.'
|
1957
2028
|
},
|
1958
2029
|
:'transaction_segments.attributes.include' => {
|
1959
2030
|
:default => [],
|
@@ -1961,14 +2032,14 @@ module NewRelic
|
|
1961
2032
|
:type => Array,
|
1962
2033
|
:allowed_from_server => false,
|
1963
2034
|
:transform => DefaultSource.method(:convert_to_list),
|
1964
|
-
:description => 'Prefix of attributes to include on transaction segments. Allows
|
2035
|
+
:description => 'Prefix of attributes to include on transaction segments. Allows `*` as wildcard at end.'
|
1965
2036
|
},
|
1966
2037
|
:'custom_attributes.enabled' => {
|
1967
2038
|
:default => true,
|
1968
2039
|
:public => true,
|
1969
2040
|
:type => Boolean,
|
1970
2041
|
:allowed_from_server => false,
|
1971
|
-
:description => 'If
|
2042
|
+
:description => 'If `false`, custom attributes will not be sent on Insights events.'
|
1972
2043
|
},
|
1973
2044
|
:'utilization.detect_aws' => {
|
1974
2045
|
:default => true,
|
@@ -1976,7 +2047,7 @@ module NewRelic
|
|
1976
2047
|
:type => Boolean,
|
1977
2048
|
:allowed_from_server => false,
|
1978
2049
|
:dynamic_name => true,
|
1979
|
-
:description => 'If
|
2050
|
+
:description => 'If `true`, the agent automatically detects that it is running in an AWS environment.'
|
1980
2051
|
},
|
1981
2052
|
:'utilization.detect_azure' => {
|
1982
2053
|
:default => true,
|
@@ -1984,7 +2055,7 @@ module NewRelic
|
|
1984
2055
|
:type => Boolean,
|
1985
2056
|
:allowed_from_server => false,
|
1986
2057
|
:dynamic_name => true,
|
1987
|
-
:description => 'If
|
2058
|
+
:description => 'If `true`, the agent automatically detects that it is running in an Azure environment.'
|
1988
2059
|
},
|
1989
2060
|
:'utilization.detect_gcp' => {
|
1990
2061
|
:default => true,
|
@@ -1992,7 +2063,7 @@ module NewRelic
|
|
1992
2063
|
:type => Boolean,
|
1993
2064
|
:allowed_from_server => false,
|
1994
2065
|
:dynamic_name => true,
|
1995
|
-
:description => 'If
|
2066
|
+
:description => 'If `true`, the agent automatically detects that it is running in an Google Cloud Platform environment.'
|
1996
2067
|
},
|
1997
2068
|
:'utilization.detect_pcf' => {
|
1998
2069
|
:default => true,
|
@@ -2000,21 +2071,21 @@ module NewRelic
|
|
2000
2071
|
:type => Boolean,
|
2001
2072
|
:allowed_from_server => false,
|
2002
2073
|
:dynamic_name => true,
|
2003
|
-
:description => 'If
|
2074
|
+
:description => 'If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment.'
|
2004
2075
|
},
|
2005
2076
|
:'utilization.detect_docker' => {
|
2006
2077
|
:default => true,
|
2007
2078
|
:public => true,
|
2008
2079
|
:type => Boolean,
|
2009
2080
|
:allowed_from_server => false,
|
2010
|
-
:description => 'If
|
2081
|
+
:description => 'If `true`, the agent automatically detects that it is running in Docker.'
|
2011
2082
|
},
|
2012
2083
|
:'utilization.detect_kubernetes' => {
|
2013
2084
|
:default => true,
|
2014
2085
|
:public => true,
|
2015
2086
|
:type => Boolean,
|
2016
2087
|
:allowed_from_server => false,
|
2017
|
-
:description => 'If
|
2088
|
+
:description => 'If `true`, the agent automatically detects that it is running in Kubernetes.'
|
2018
2089
|
},
|
2019
2090
|
:'utilization.billing_hostname' => {
|
2020
2091
|
:default => nil,
|
@@ -2045,21 +2116,21 @@ module NewRelic
|
|
2045
2116
|
:public => true,
|
2046
2117
|
:type => Boolean,
|
2047
2118
|
:allowed_from_server => false,
|
2048
|
-
:description => 'If
|
2119
|
+
:description => 'If `false`, the agent will not report datastore instance metrics, nor add `host` or `port_path_or_id` parameters to transaction or slow SQL traces.'
|
2049
2120
|
},
|
2050
2121
|
:'datastore_tracer.database_name_reporting.enabled' => {
|
2051
2122
|
:default => true,
|
2052
2123
|
:public => true,
|
2053
2124
|
:type => Boolean,
|
2054
2125
|
:allowed_from_server => false,
|
2055
|
-
:description => 'If
|
2126
|
+
:description => 'If `false`, the agent will not add `database_name` parameter to transaction or slow sql traces.'
|
2056
2127
|
},
|
2057
2128
|
:'clear_transaction_state_after_fork' => {
|
2058
2129
|
:default => false,
|
2059
2130
|
:public => true,
|
2060
2131
|
:type => Boolean,
|
2061
2132
|
:allowed_from_server => false,
|
2062
|
-
:description => 'If
|
2133
|
+
:description => 'If `true`, the agent will clear `Tracer::State` in `Agent.drop_buffered_data`.'
|
2063
2134
|
},
|
2064
2135
|
:account_id => {
|
2065
2136
|
:default => nil,
|
@@ -2078,11 +2149,11 @@ module NewRelic
|
|
2078
2149
|
:description => 'The primary id associated with this application.'
|
2079
2150
|
},
|
2080
2151
|
:'distributed_tracing.enabled' => {
|
2081
|
-
:default =>
|
2152
|
+
:default => true,
|
2082
2153
|
:public => true,
|
2083
2154
|
:type => Boolean,
|
2084
|
-
:allowed_from_server =>
|
2085
|
-
:description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the
|
2155
|
+
:allowed_from_server => true,
|
2156
|
+
:description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the [transition guide](/docs/transition-guide-distributed-tracing) before you enable this feature.'
|
2086
2157
|
},
|
2087
2158
|
:trusted_account_key => {
|
2088
2159
|
:default => nil,
|
@@ -2111,7 +2182,7 @@ module NewRelic
|
|
2111
2182
|
:public => true,
|
2112
2183
|
:type => Boolean,
|
2113
2184
|
:allowed_from_server => true,
|
2114
|
-
:description => 'If
|
2185
|
+
:description => 'If `true`, enables span event sampling.'
|
2115
2186
|
},
|
2116
2187
|
:'span_events.queue_size' => {
|
2117
2188
|
:default => 10_000,
|
@@ -2122,7 +2193,7 @@ module NewRelic
|
|
2122
2193
|
:description => "Sets the maximum number of span events to buffer when streaming to the trace observer."
|
2123
2194
|
},
|
2124
2195
|
:'span_events.max_samples_stored' => {
|
2125
|
-
:default =>
|
2196
|
+
:default => 2000,
|
2126
2197
|
:public => true,
|
2127
2198
|
:type => Integer,
|
2128
2199
|
:allowed_from_server => true,
|