Settings API - Built-in detection rules schema table

Built-in detection rules (builtin:process-group.detection-flags)

Enable or disable process group detection flags

Schema ID
Schema groups
Scope
builtin:process-group.detection-flags
  • group:processes-and-containers.processes
  • group:processes-and-containers
HOST - Host
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.detection-flags
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process-group.detection-flags
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process-group.detection-flags

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
Ignore versions, builds, dates, and GUIDs in process directory names
ignoreUniqueIdentifiers
boolean

To determine the unique identity of each detected process, and to generate a unique name for each detected process, Dynatrace evaluates the name of the directory that each process binary is contained within. For application containers like Tomcat and JBoss, Dynatrace evaluates important directories like CATALINA_HOME and JBOSS_HOME for this information. In some automated deployment scenarios such directory names are updated automatically with new version numbers, build numbers, dates, or GUIDs. Enable this setting to ensure that automated directory name changes don't result in Dynatrace registering pre-existing processes as new processes.

required
Use CATALINA_BASE to identify Tomcat cluster nodes
useCatalinaBase
boolean

By default, Tomcat clusters are identified and named based on the CATALINA_HOME directory name. This setting results in the use of the CATALINA_BASE directory name to identify multiple Tomcat nodes within each Tomcat cluster. If this setting is not enabled, each CATALINA_HOME+CATALINA_BASE combination will be considered a separate Tomcat cluster. In other words, Tomcat clusters can't have multiple nodes on a single host.

required
Use Docker container name to distinguish multiple containers
useDockerContainerName
boolean

For Docker outside container platforms only. By default, Dynatrace uses image names as identifiers for individual process groups, with one process-group instance per host. Normally Docker container names can't serve as stable identifiers of process group instances because they are variable and auto-generated. You can however manually assign proper container names to their Docker instances. Such manually-assigned container names can serve as reliable process-group instance identifiers. This flag instructs Dynatrace to use Docker-provided names to distinguish between multiple instances of the same image. If this flag is not applied and you run multiple containers of the same image on the same host, the resulting processes will be consolidated into a single process view. Use this flag with caution!

required
Automatically detect Cassandra clusters
autoDetectCassandraClusters
boolean

Enabling this flag will detect separate Cassandra process groups based on the configured Cassandra cluster name.

required
Use Node.js script name to distinguish processes started from same directory in addition to application id.
addNodeJsScriptName
boolean

In older versions, Node.js applications were distinguished based on their directory name, omitting the script name. Changing this setting may change the general handling of Node.js process groups. Leave unchanged if in doubt.

required
Automatically detect TIBCO BusinessWorks engines
autoDetectTibcoEngines
boolean

Enabling this flag will detect separate TIBCO BusinessWorks process groups per engine property file.

required
Identify and name JBoss servers based on system property jboss.server.name
identifyJbossServerBySystemProperty
boolean

Enabling this flag will detect the JBoss server name from the system property jboss.server.name=, only if -D[Server:] is not set.

required
Automatically detect webMethods Integration Server
autoDetectWebMethodsIntegrationServer
boolean

Enabling this flag will detect webMethods Integration Server including specific properties like install root and product name.

required
Automatically detect Spring Boot applications
autoDetectSpringBoot
boolean

Enabling this flag will detect Spring Boot process groups based on command line and applications' configuration files.

required
Automatically detect TIBCO BusinessWorks Container Edition engines
autoDetectTibcoContainerEditionEngines
boolean

Enabling this flag will detect separate TIBCO BusinessWorks process groups per engine property file.

required
Group Oracle database processes by SID
splitOracleDatabasePG
boolean

Enable to group and separately analyze the processes of each Oracle DB. Each process group receives a unique name based on the Oracle DB SID.

required
Group Oracle listener processes by name
splitOracleListenerPG
boolean

Enable to group and separately analyze the processes of each Oracle Listener. Each process group receives a unique name based on the Oracle Listener name.

required
Automatically detect WebSphere Liberty application
autoDetectWebSphereLibertyApplication
boolean

Enabling this flag will detect separate WebSphere Liberty process groups based on java command line.

required
Monitor short lived processes
shortLivedProcessesMonitoring
boolean

Enable to monitor CPU and memory usage of short lived processes, otherwise being lost by traditional monitoring. Disabling this flag blocks passing data to cluster only, it does not stop data collection and has no effect on performance.

required
Group IBM MQ processes by queue manager name
groupIBMMQbyInstanceName
boolean

Enable to group and separately analyze the processes of each IBM MQ Queue manager instance. Each process group receives a unique name based on the queue manager instance name.

required