Settings API - Trace ingest control schema table

  • Published Dec 15, 2025

Trace ingest control (builtin:trace.ingest.control)

Use this setting to steer the usage of the Full-Stack Monitoring included trace volume at a settings scope level.

Typically, Adaptive Traffic Management distributes the available volume equally to all OneAgents. It achieves this by adjusting the trace ingest rate limit every 15 minutes, ensuring that the overall trace ingest volume remains within the included volume, along with any additional extended trace volume that has been configured.

With trace ingest control, you can influence the trace ingest rate of OneAgents in specific host groups, K8s cluster or K8s namespaces allowing them to capture traces at a higher or lower rate than normal. This results in a higher trace capture rate for targeted parts of your system. Consequently, Adaptive Traffic Management might lower the trace ingest rate overall on average so that the resulting overall trace ingest volume stays within the defined bounds.

Schema IDSchema groupsScope
builtin:trace.ingest.control
  • group:service-monitoring
  • group:preferences
PROCESS_GROUP_INSTANCE - Process
PROCESS_GROUP - Process Group
CLOUD_APPLICATION - Kubernetes workload
CLOUD_APPLICATION_NAMESPACE - Kubernetes namespace
KUBERNETES_CLUSTER - Kubernetes cluster
HOST_GROUP - Host Group
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:trace.ingest.control
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:trace.ingest.control
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:trace.ingest.control

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Adaptive Sampling
adaptiveSamplingSwitch		boolean-Required
Adaptive trace ingest rate factor
adaptiveTraceIngestRateFactor		float

Setting this field to 1 enables OneAgents within this scope to capture traces at a standard, adaptively determined rate. You can increase or decrease this rate limit in multiples. For instance, choosing a factor of 0.5 means that the trace ingest rate limit will be halved, whereas choosing a factor of 10 means 10 times the default trace ingest rate limit.

Required
(Upcoming) Fixed sampling rate
fixedSamplingRate		integer

Do not use this setting yet! In a future release, this will enable setting a fixed capture rate for all traces started by OneAgents within this scope.

NOTE: This feature will be available in a future release.

Required