Settings API - Declarative process grouping schema table

Declarative process grouping (`builtin:declarativegrouping)`

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

Note that declarative grouping does not work for processes that have deep monitoring enabled.

To add a new process group, you must first define the technology type. The technology type can be a generic technology name or a custom name. Each technology type can be associated with multiple process groups.

Next, give your process group a unique name and identifier. This name is used to identify the process group throughout your Dynatrace environment. Finally, add detection rules so that Dynatrace can automatically identify processes that belong in this group.

For complete details, see Declarative process grouping

Schema ID	Schema groups	Scope
`builtin:declarativegrouping`	`group:processes-and-containers.processes` `group:processes-and-containers`	`HOST` - Host `HOST_GROUP` - Host Group `environment`

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:declarativegrouping`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:declarativegrouping`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:declarativegrouping`

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
Enabled `enabled`	boolean	-	required
Monitored technology name `name`	text	-	required
Define the process group `detection`	ProcessDefinition[]	Enter a descriptive process group display name and a unique identifier that Dynatrace can use to recognize this process group.	required

The `ProcessDefinition` object

Property	Type	Description	Required
Process group display name `processGroupName`	text	This identifier is used by Dynatrace to recognize this process group.	required
Process group identifier `id`	text	-	required
Report process group `report`	enum	This property tells OneAgent a condition for reporting the created Process group to Dynatrace. `always` `highResourceUsage` `never`	required
Define detection rules `rules`	DetectionCondition[]	Define process detection rules by selecting a process property and a condition. Each process group can have multiple detection rules associated with it.	required

The `DetectionCondition` object

Property Type Description Required

Property	Type	Description	Required
Select process property `property`	enum	`executable` `executablePath` `commandLine`	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 Declarative process grouping.	required

Select process property
property

enum

executable
executablePath
commandLine

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 Declarative process grouping.