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 ID | Schema groups | Scope |
|---|---|---|
builtin:process-grouping-rules |
| HOST - HostKUBERNETES_CLUSTER - Kubernetes clusterHOST_GROUP - Host Groupenvironment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-grouping-rules |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-grouping-rules | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-grouping-rules |
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.
| Property | Type | Description | Required |
|---|---|---|---|
Enabledenabled | boolean | - | required |
Custom technology namecustomTechnologyName | text | Note: Reported only in full-stack, infrastructure and discovery modes. | optional |
Define the process groupspgExtraction | ProcessGroupExtraction[] | Define process groups and processes. | required |
ProcessGroupExtraction object| Property | Type | Description | Required |
|---|---|---|---|
1.1. Process group display name (optional)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 |
1.2. Report process groupreport | enum | Auto reports only processes which are important - meaning deep monitored or with high resource usage
| required |
1.3. Type of captured processes (optional)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.
| optional |
detection | DetectionCondition[] |
Define process detection rules to select processes on which this rule will apply to. At least one rule must be defined. | required |
pgIdSource | GroupIdSource |
3.1. Process group id source | required |
pgiIdSource | InstanceIdSource | 3.2. Process id source (optional) Define a property that should be used to identify your process. | optional |
DetectionCondition object| Property | Type | Description | Required |
|---|---|---|---|
2.1. Propertyproperty | text | - | required |
2.2. Variable namename | text | If Dynatrace detects this property at startup of a process, it will be matched to this grouping rule. | required |
2.2. Conditioncondition | text |
For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py. For more details, see documentation. | required |
Case sensitivecaseSensitive | boolean | When enabled, matching conditions are case sensitive. When disabled, matching conditions are case insensitive | required |
GroupIdSource object| Property | Type | Description | Required |
|---|---|---|---|
Standalone rulestandaloneRule | 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. | required |
3.1.1. Id typetype | enum | Pick which property should be used to identify your process group. You can pick a custom variable or pick an existing process property.
| required |
3.1.2. Process group identifierid | text | This identifier is used by Dynatrace to recognize this process group. | required |
3.1.2. Propertyproperty | text | - | required |
Variable namename | text | If Dynatrace detects this property at startup of a process, it will use its value to identify process groups. | required |
3.1.3. Advanced settings (optional)advancedSettings | AdvancedSettings | Set advanced options to customize delimiters and control how property values are processed. Consider an environment with processes such as:
To group production (prod) and development (dev) processes together you could use Command line property with:
| optional |
InstanceIdSource object| Property | Type | Description | Required |
|---|---|---|---|
3.2.1. Propertyproperty | text | - | optional |
Variable namename | text | If Dynatrace detects this property at startup of a process, it will use its value to identify process groups more granular. | required |
3.2.2. Advanced settings (optional)advancedSettings | AdvancedSettings | Set advanced options to customize delimiters and control how property values are processed. Consider an environment with processes such as:
To group production (prod) and development (dev) processes together you could use Command line property with:
| optional |
AdvancedSettings object| Property | Type | Description | Required |
|---|---|---|---|
Delimit from (optional)from | text | - | optional |
Delimit to (optional)to | text | - | optional |
Ignore numbersignoreNumbers | boolean | (e.g. versions, hex, dates, and build numbers) | required |