• Home
  • API
  • Environment
  • Settings
  • Schemas
  • Cloud application and workload detection

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
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
cloudFoundryCloud FoundryCloudFoundryCAWD

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
dockerDocker and PodmanDockerCAWD

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
kubernetesKubernetes/OpenShiftKubernetesOpenShiftCAWD

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

Request body objects

The InclusionToggles object
PropertyLabelTypeDescriptionRequired
incNamespaceNamespace nameboolean-required
incBasepodBase pod nameboolean

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

required
incContainerContainer nameboolean-required
incStageStageboolean-required
incProductProductboolean

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

required
The MatchFilter object
PropertyLabelTypeDescriptionRequired
matchOperatorMatch operatorenum-required
namespaceNamespace nametext-required
The FilterComplex object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
inclusionTogglesID calculation based onInclusionToggles-required
matchFilterWhen namespaceMatchFilter-required
The CloudFoundryCAWD object
PropertyLabelTypeDescriptionRequired
enabledEnable cloud application and workload detection for Cloud Foundryboolean-required
The DockerCAWD object
PropertyLabelTypeDescriptionRequired
enabledEnable cloud application and workload detection for Docker and Podmanboolean-required
The KubernetesOpenShiftCAWD object
PropertyLabelTypeDescriptionRequired
enabledEnable cloud application and workload detection for Kubernetes/OpenShiftboolean-required
filters-list

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