• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Advanced detection rules

Settings API - Advanced detection rules schema table

Advanced detection rules (builtin:process-group.advanced-detection-rule)

Advanced process group detection rules enable you to adapt the detection logic for deep monitored processes by leveraging properties that are automatically detected by OneAgent during the startup of a process.

Advanced detection rules are capable to extract additional process group and instance identifier from processes to fine tune the automatic detection logic of OneAgent. More about custom process-group detection

Note: Detection rules change the composition, makeup, and identity of a process group, not just the name. If you only need to change default name use the naming rules instead.

Process-group detection rules only affect processes that are deep monitored by the Dynatrace OneAgent and require a restart of your processes to affect how processes are identified and grouped.

Schema IDSchema groupsScope
builtin:process-group.advanced-detection-rule
  • group:processes-and-containers.processes
  • group:processes-and-containers
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.advanced-detection-rule
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-group.advanced-detection-rule
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.advanced-detection-rule

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
enabledEnabledboolean-required
processDetectionProcess group detectionprocessGroupDetection

Apply this rule to processes where the selected property contains the specified string.

required
groupExtractionProcess group extractionprocessGroupExtraction

You can define the properties that should be used to identify your process groups.

required
instanceExtractionProcess instance extractionprocessInstanceExtraction

You can define the properties that should be used to identify your process instances.

required

Request body objects

The delimiter object
PropertyLabelTypeDescriptionRequired
fromDelimit fromtext-required
toDelimit totext-required
removeIdsIgnore numbersboolean

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

required
The processGroupDetection object
PropertyLabelTypeDescriptionRequired
propertyPropertytext-required
containedStringContained stringtext

(case sensitive)

required
restrictToProcessTypeRestrict this rule to specific process types.text

Note: Not all types can be detected at startup.

optional
The processGroupExtraction object
PropertyLabelTypeDescriptionRequired
propertyPropertytext-required
delimiter-delimiter

Optionally delimit this property between From and To.

required
standaloneRuleStandalone ruleboolean

If this option is selected, the default Dynatrace behavior is disabled for these 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
The processInstanceExtraction object
PropertyLabelTypeDescriptionRequired
propertyPropertytext-optional
delimiter-delimiter

Optionally delimit this property between From and To.

required