Settings API - URL-based sampling schema table
URL-based sampling (builtin:url-based-sampling)
PurePath® distributed traces will be discarded based on your environment licensed limit. Here you can configure the importance of specific URLs. URLs with higher importance will be treated to be captured more often and vice versa.
Hint: Use this Multi-dimensional analysis (<your-dynatrace-url>//ui/diagnostictools/mda?mdaId=atm) to get an overview over the current sample rates per URL. Additionally use the context-menu of the URLs to up- or downscale certain URLs in a convenient way.
This configuration represents an ordered list of rules. Each rule has conditions, based on request method, the URL path and query parameters. The first rule where all conditions are met will be applied. All string comparisons of the conditions are case sensitive. Use the Enabled switch to turn a rule on or off.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:url-based-sampling |
| PROCESS_GROUP_INSTANCE - ProcessPROCESS_GROUP - Process GroupCLOUD_APPLICATION - Kubernetes workloadCLOUD_APPLICATION_NAMESPACE - Kubernetes namespaceKUBERNETES_CLUSTER - Kubernetes clusterenvironment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:url-based-sampling |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:url-based-sampling | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:url-based-sampling |
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
| Property | Type | Description | Required |
|---|---|---|---|
Enabledenabled | boolean | - | required |
Ignore URLs with specific path and/or query parametersignore | boolean | The matching URLs will always be ignored, also if Adaptive Traffic Management is not active. | required |
Importance of a specific URLfactor | enum | Select the scaling factor for the current sampling rate of the system.
| required |
Pathpath | text | Path of the URL. Specify only the URL path without including any preceding or subsequent elements of the URL. You can use the wildcard '**' between two path segments to ignore that part. If the path is empty, at least one query parameter must be specified that can be used for URL matching. | optional |
Path comparison conditionpathComparisonType | enum |
| required |
Query parametersqueryParameters | Set<QueryParameter> | Add URL parameters in any order. All specified parameters must be present in the query of an URL to get a match. | required |
Any HTTP methodhttpMethodAny | boolean | The scaling factor for the matching URLs will be applied to any HTTP method. | required |
HTTP methodhttpMethod | Set<HttpMethod> |
| required |
The QueryParameter object
| Property | Type | Description | Required |
|---|---|---|---|
Query parameter namename | text | - | required |
Query parameter valuevalue | text | The value must be equal for a match. | optional |
Query parameter value is undefinedvalueIsUndefined | boolean | If enabled, the value is treated as undefined (/...&foo), otherwise as empty (/...&foo=). | required |