Settings API - Process grouping rules schema table

Process grouping rules (builtin:process-grouping-rules)

Dynatrace automatically monitors process groups that are of known technology types or that consume significant resources. With process grouping rules, you can automatically monitor additional technologies.

Process grouping rules also work for processes that have deep monitoring enabled.

Schema IDSchema groupsScope
builtin:process-grouping-rules
  • group:processes-and-containers.processes
  • group:processes-and-containers
HOST - Host
KUBERNETES_CLUSTER - Kubernetes cluster
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-grouping-rules
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-grouping-rules
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-grouping-rules

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
Enabled
enabled		boolean-required
Custom technology name
customTechnologyName		text-optional
Define the process groups
pgExtraction		ProcessGroupExtraction[]

Define process groups and processes.

required
The ProcessGroupExtraction object
PropertyTypeDescriptionRequired
Process group display name
name		text

When this field is empty, OneAgent will automatically assign the process group name based on process type and properties like executable name. If you expect that multiple processes will be matched by the rule, it is highly recommended that you fill this field because it is unspecified which process will be used as the group name source.

optional
Report process group
report		enum

Auto reports only processes which are important - meaning deep monitored or with high resource usage

  • always
  • auto
  • never
required
Type of captured processes
processType		enum

Note: Not all types can be detected at startup.

Restrict this rule to specific process types to avoid mixing deep monitored properties leading to confusing results.

  • PROCESS_TYPE_APACHE_HTTPD
  • PROCESS_TYPE_GLASSFISH
  • PROCESS_TYPE_GO
  • PROCESS_TYPE_IIS_APP_POOL
  • PROCESS_TYPE_JBOSS
  • PROCESS_TYPE_JAVA
  • PROCESS_TYPE_NGINX
  • PROCESS_TYPE_NODE_JS
  • PROCESS_TYPE_PHP
  • PROCESS_TYPE_TOMCAT
  • PROCESS_TYPE_WEBLOGIC
  • PROCESS_TYPE_WEBSPHERE
optional
detectionDetectionCondition[]

Define process detection rules to select processes on which this rule will apply to. At least one rule must be defined.

required
pgIdSourceGroupIdSource

Process group id source

Define a property that should be used to identify your process group. You can pick a custom variable or pick an existing process property.

required
pgiIdSourceInstanceIdSource

Process id source

Define a property that should be used to identify your process.

optional
The DetectionCondition object
PropertyTypeDescriptionRequired
Property
property		text-required
Variable name
name		text

If Dynatrace detects this property at startup of a process, it will be matched to this grouping rule.

required
Condition
condition		text
  • $contains(svc) – Matches if svc appears anywhere in the process property value.
  • $eq(svc.exe) – Matches if svc.exe matches the process property value exactly.
  • $prefix(svc) – Matches if app matches the prefix of the process property value.
  • $suffix(svc.py) – Matches if svc.py matches the suffix of the process property value.

For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py.

For more details, see documentation.

required
Case sensitive
caseSensitive		boolean

When enabled, matching conditions are case sensitive. When disabled, matching conditions are case insensitive

required
The GroupIdSource object
PropertyTypeDescriptionRequired
Standalone rule
standaloneRule		boolean

Valid only for deep monitored processes.

If this option is selected, the default Dynatrace behavior is disabled for the detected processes. Only this rule is used to separate the process group.

If this option is not selected, this rule contributes to the default Dynatrace process group detection.

See our help page for examples.

required
Process group identifier
id		text

This identifier is used by Dynatrace to recognize this process group.

optional
Property
property		text-optional
Variable name
name		text

If Dynatrace detects this property at startup of a process, it will use its value to identify process groups.

required
Advanced settings
advancedSettings		AdvancedSettings

Set advanced options to customize delimiters and control how property values are processed.

optional
The InstanceIdSource object
PropertyTypeDescriptionRequired
Property
property		text-optional
Variable name
name		text

If Dynatrace detects this property at startup of a process, it will use its value to identify process groups more granular.

required
Advanced settings
advancedSettings		AdvancedSettings

Set advanced options to customize delimiters and control how property values are processed.

optional
The AdvancedSettings object
PropertyTypeDescriptionRequired
Delimit from
from		text-optional
Delimit to
to		text-optional
Ignore numbers
ignoreNumbers		boolean

(e.g. versions, hex, dates, and build numbers)

required