Settings API - Cloud application and workload detection schema table
Cloud application and workload detection (builtin:process-group.cloud-application-workload-detection)
Enabling this setting merges processes of similar workloads into process groups, and consequently, services. Please note that fine-grained process detection rules will still be applied, while ignoring container or platform specific properties.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:process-group.cloud-application-workload-detection |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.cloud-application-workload-detection |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-group.cloud-application-workload-detection | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.cloud-application-workload-detection |
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 |
---|---|---|---|
Cloud FoundrycloudFoundry | CloudFoundryCAWD | Enable this setting to get
| required |
Docker and Podmandocker | DockerCAWD | Enable this setting for plain Docker and Podman environments to get
| required |
Kubernetes/OpenShiftkubernetes | KubernetesOpenShiftCAWD | Enable this setting to get
| required |
The CloudFoundryCAWD
object
Property | Type | Description | Required |
---|---|---|---|
Enable cloud application and workload detection for Cloud Foundryenabled | boolean | - | required |
The DockerCAWD
object
Property | Type | Description | Required |
---|---|---|---|
Enable cloud application and workload detection for Docker and Podmanenabled | boolean | - | required |
The KubernetesOpenShiftCAWD
object
Property | Type | Description | Required |
---|---|---|---|
Enable cloud application and workload detection for Kubernetes/OpenShiftenabled | boolean | - | required |
filters | FilterComplex[] | Define rules to merge similar Kubernetes workloads into process groups. You can use workload properties like namespace name, base pod name or container name as well as the environment variables DT_RELEASE_STAGE and DT_RELEASE_PRODUCT for grouping processes of similar workloads. The first applicable rule will be applied. If no rule matches, “Namespace name” + “Base pod name” + “Container name” is used as fallback. | required |
The FilterComplex
object
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | - | required |
ID calculation based oninclusionToggles | InclusionToggles | - | required |
When namespacematchFilter | MatchFilter | - | required |
The InclusionToggles
object
Property | Type | Description | Required |
---|---|---|---|
Namespace nameincNamespace | boolean | - | required |
Base pod nameincBasepod | boolean | E.g. "cloud-credential-operator-" for "cloud-credential-operator-5ff6dbff57-gszgq" | required |
Container nameincContainer | boolean | - | required |
StageincStage | boolean | - | required |
ProductincProduct | boolean | If Product is enabled and has no value, it defaults to Base pod name | required |
The MatchFilter
object
Property | Type | Description | Required |
---|---|---|---|
Match operatormatchOperator | enum |
| required |
Namespace namenamespace | text | - | required |