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 IDSchema groupsScope
builtin:process-group.cloud-application-workload-detection
  • group:processes-and-containers.containers
  • group:processes-and-containers
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.cloud-application-workload-detection
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-group.cloud-application-workload-detection
Environment ActiveGatehttps://{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

PropertyTypeDescriptionRequired
Serverless Container Services
serverless		ServerlessCAWD

Enable this setting to

  • Detect containers based on captured cloud-vendor metadata such as e.g. AWS ECS / Fargate, Azure Container Apps, and many more.
  • Container resource metrics (Container group instance entities) and related screens.
required
Cloud Foundry
cloudFoundry		CloudFoundryCAWD

Enable this setting to get

  • Processes of Cloud Foundry application instances merged into process groups by Cloud Foundry application.
  • Container resource metrics (Container group instance entities) and related screens.
required
Docker and Podman
docker		DockerCAWD

Enable this setting for plain Docker and Podman environments to get

  • Container resource metrics (Container group instance entities) and related screens.
  • Docker support requires OneAgent 1.257+.
  • Podman support requires OneAgent 1.267+.
required
Kubernetes/OpenShift
kubernetes		KubernetesOpenShiftCAWD

Enable this setting to get

  • Insights into your Kubernetes namespaces, workloads and pods (cloud application namespace, cloud application and cloud application instance and entities).
  • Container resource metrics (container group instance entities) and related screens.
  • Similar workloads merged into process groups based on defined rules (see below).
  • Version detection for services that run in Kubernetes workloads.
required
The ServerlessCAWD object
PropertyTypeDescriptionRequired
Enable container detection for serverless container services
enabled		boolean-required
The CloudFoundryCAWD object
PropertyTypeDescriptionRequired
Enable cloud application and workload detection for Cloud Foundry
enabled		boolean-required
The DockerCAWD object
PropertyTypeDescriptionRequired
Enable cloud application and workload detection for Docker and Podman
enabled		boolean-required
The KubernetesOpenShiftCAWD object
PropertyTypeDescriptionRequired
Enable cloud application and workload detection for Kubernetes/OpenShift
enabled		boolean-required
filtersFilterComplex[]

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
PropertyTypeDescriptionRequired
Enabled
enabled		boolean-required
ID calculation based on
inclusionToggles		InclusionToggles-required
When namespace
matchFilter		MatchFilter-required
The InclusionToggles object
PropertyTypeDescriptionRequired
Namespace name
incNamespace		boolean-required
Base pod name
incBasepod		boolean

E.g. "cloud-credential-operator-" for "cloud-credential-operator-5ff6dbff57-gszgq"

required
Container name
incContainer		boolean-required
Stage
incStage		boolean-required
Product
incProduct		boolean

If Product is enabled and has no value, it defaults to Base pod name

required
The MatchFilter object
PropertyTypeDescriptionRequired
Match operator
matchOperator		enum
  • EXISTS
  • EQUALS
  • NOT_EQUALS
  • CONTAINS
  • NOT_CONTAINS
  • STARTS
  • NOT_STARTS
  • ENDS
  • NOT_ENDS
required
Namespace name
namespace		text-required