Configure the Ruby agent's distributed tracing settings to enable end-to-end request tracking, Infinite Tracing tail-based sampling, and span event collection.
Distributed Tracing
| Type | Boolean |
|---|---|
| Default | true |
| Environ variable | NEW_RELIC_DISTRIBUTED_TRACING_ENABLED |
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 before you enable this feature.
| Type | String |
|---|---|
| Default | "adaptive" |
| Environ variable | NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT |
This setting controls the behavior of transaction sampling for transactions without a remote parent (traces that originate within this instance of the New Relic agent). Available values are adaptive (the default), always_on, always_off, and trace_id_ratio_based.
| Type | String |
|---|---|
| Default | "adaptive" |
| Environ variable | NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED |
This setting controls the behavior of transaction sampling when a remote parent is sampled. Available values are adaptive (the default), always_on, always_off, and trace_id_ratio_based.
| Type | String |
|---|---|
| Default | "adaptive" |
| Environ variable | NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED |
This setting controls the behavior of transaction sampling when a remote parent is not sampled. Available values are adaptive (the default), always_on, always_off, and trace_id_ratio_based.
Infinite Tracing
| Type | String |
|---|---|
| Default | "" |
| Environ variable | NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST |
Configures the hostname for the trace observer Host. When configured, enables tail-based sampling by sending all recorded spans to a trace observer for further sampling decisions, irrespective of any usual agent sampling decision.
| Type | Integer |
|---|---|
| Default | 443 |
| Environ variable | NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT |
Configures the TCP/IP port for the trace observer Host
| Type | Boolean |
|---|---|
| Default | true |
| Environ variable | NEW_RELIC_INFINITE_TRACING_BATCHING |
If true (the default), data sent to the trace observer is batched instead of sending each span individually.
| Type | Symbol |
|---|---|
| Default | :high |
| Environ variable | NEW_RELIC_INFINITE_TRACING_COMPRESSION_LEVEL |
Configure the compression level for data sent to the trace observer. May be one of: :none, :low, :medium, :high. Set the level to :none to disable compression.
Span Events
| Type | Boolean |
|---|---|
| Default | true |
| Environ variable | NEW_RELIC_SPAN_EVENTS_ENABLED |
If true, enables span event sampling.
| Type | Integer |
|---|---|
| Default | 10000 |
| Environ variable | NEW_RELIC_SPAN_EVENTS_QUEUE_SIZE |
Sets the maximum number of span events to buffer when streaming to the trace observer.
| Type | Integer |
|---|---|
| Default | 2000 |
| Environ variable | NEW_RELIC_SPAN_EVENTS_MAX_SAMPLES_STORED |
Defines the maximum number of span events reported from a single harvest. Any Integer between 1 and 10000 is valid. When configuring the agent for AI monitoring, set to max value 10000. This ensures the agent captures the maximum amount of distributed traces.