Settings API - Custom process monitoring rules schema table

    Custom process monitoring rules (builtin:process.custom-process-monitoring-rule)

    Dynatrace OneAgent automatically monitors all process groups detected in your environment (processes running during OneAgent installation must be restarted to initiate monitoring).

    OneAgent additionally provides deep monitoring for all processes that it can monitor at the request- and PurePath levels. Define process monitoring rules below if you don’t want to monitor all your processes automatically, or if you need to define an exception for specific processes.

    Schema IDSchema groupsScope
    builtin:process.custom-process-monitoring-rule
    • group:processes-and-containers.processes
    • group:processes-and-containers
    HOST_GROUP - Host Group
    environment
    GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process.custom-process-monitoring-rule
    SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:process.custom-process-monitoring-rule
    Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:process.custom-process-monitoring-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

    PropertyTypeDescriptionRequired
    Enabled
    enabled
    boolean-required
    Mode
    mode
    enum
    • MONITORING_OFF
    • MONITORING_ON
    required
    Condition
    condition
    Condition-required
    The Condition object
    PropertyTypeDescriptionRequired
    Condition target
    item
    enum
    • UNKNOWN
    • APACHE_CONFIG_PATH
    • APACHE_SPARK_MASTER_IP_ADDRESS
    • CATALINA_BASE
    • CATALINA_HOME
    • CLOUD_FOUNDRY_APP_NAME
    • CLOUD_FOUNDRY_INSTANCE_INDEX
    • CLOUD_FOUNDRY_SPACE_ID
    • CLOUD_FOUNDRY_SPACE_NAME
    • COLDFUSION_JVM_CONFIG_FILE
    • CONTAINER_ID
    • CONTAINER_IMAGE_NAME
    • CONTAINER_NAME
    • DECLARATIVE_ID
    • DOTNET_COMMAND
    • DOTNET_COMMAND_PATH
    • ELASTIC_SEARCH_CLUSTER_NAME
    • ELASTIC_SEARCH_NODE_NAME
    • EXE_NAME
    • EXE_PATH
    • GLASSFISH_DOMAIN_NAME
    • GLASSFISH_INSTANCE_NAME
    • IIS_APP_POOL
    • IIS_ROLE_NAME
    • JAVA_JAR_FILE
    • JAVA_JAR_PATH
    • JAVA_MAIN_CLASS
    • JBOSS_MODE
    • JBOSS_HOME
    • JBOSS_SERVER_NAME
    • KUBERNETES_BASEPODNAME
    • KUBERNETES_CONTAINERNAME
    • KUBERNETES_FULLPODNAME
    • KUBERNETES_NAMESPACE
    • KUBERNETES_PODUID
    • NODEJS_APP_NAME
    • NODEJS_SCRIPT_NAME
    • RUXIT_CLUSTER_ID
    • RUXIT_NODE_ID
    • SERVICE_NAME
    • VARNISH_INSTANCE_NAME
    • WEBLOGIC_HOME
    • WEBLOGIC_NAME
    • WEBSPHERE_CELL_NAME
    • WEBSPHERE_CLUSTER_NAME
    • WEBSPHERE_NODE_NAME
    • WEBSPHERE_SERVER_NAME
    • WEBSPHERE_LIBERTY_SERVER_NAME
    • COMMAND_LINE_ARGS
    • AWS_ECR_ACCOUNT_ID
    • AWS_ECR_REGION
    • CONTAINER_IMAGE_VERSION
    • WEBLOGIC_CLUSTER_NAME
    • WEBLOGIC_DOMAIN_NAME
    • AWS_REGION
    • AWS_LAMBDA_FUNCTION_NAME
    • ASP_NET_CORE_APPLICATION_PATH
    • HYBRIS_CONFIG_DIR
    • HYBRIS_DATA_DIR
    • HYBRIS_BIN_DIR
    • NODEJS_APP_BASE_DIR
    • TIPCO_BUSINESSWORKS_PROPERTY_FILE
    • TIPCO_BUSINESSWORKS_PROPERTY_FILE_PATH
    • CLOUD_FOUNDRY_APPLICATION_ID
    • IIB_BROKER_NAME
    • IIB_EXECUTION_GROUP_NAME
    • PHP_CLI_SCRIPT_PATH
    • PHP_CLI_WORKING_DIR
    • GOOGLE_CLOUD_PROJECT
    • GAE_SERVICE
    • GAE_INSTANCE
    • IBM_CICS_REGION
    • IBM_IMS_CONTROL
    • IBM_IMS_MPR
    • IBM_IMS_CONNECT
    • TIBCO_BUSINESSWORKS_HOME
    • TIBCO_BUSINESSWORKS_DOMAIN_NAME
    • TIBCO_BUSINESSWORKS_APP_SPACE_NAME
    • TIBCO_BUSINESSWORKS_APP_NODE_NAME
    • IBM_CTG_NAME
    • IBM_CICS_IMS_APPLID
    • IBM_CICS_IMS_JOBNAME
    • IBM_IMS_SOAP_GW_NAME
    • Z_CM_VERSION
    • RKE2_TYPE
    • DATASOURCE_MONITORING_CONFIG_ID
    • EQUINOX_CONFIG_PATH
    • SOFTWAREAG_INSTALL_ROOT
    • SOFTWAREAG_PRODUCTPROPNAME
    • AWS_ECS_CLUSTER
    • AWS_ECS_CONTAINERNAME
    • AWS_ECS_FAMILY
    • AWS_ECS_REVISION
    • SPRINGBOOT_STARTUP_CLASS
    • SPRINGBOOT_APP_NAME
    • SPRINGBOOT_PROFILE_NAME
    • ORACLE_SID
    • MSSQL_INSTANCE_NAME
    • TIBCO_BUSINESSWORKS_CE_VERSION
    • TIBCO_BUSINESSWORKS_CE_APP_NAME
    • PG_ID_CALC_INPUT_KEY_LINKAGE
    required
    Environment variable key
    envVar
    text

    supported only with OneAgent 1.167+

    required
    Condition operator
    operator
    enum
    • STARTS
    • NOT_STARTS
    • ENDS
    • NOT_ENDS
    • CONTAINS
    • NOT_CONTAINS
    • EQUALS
    • NOT_EQUALS
    • EXISTS
    • NOT_EXISTS
    required
    Condition value
    value
    text-required