Settings API - Process availability schema table

    Process availability (builtin:processavailability)

    This feature allows you to monitor if a minimum number of processes matching the specified monitoring rule are running on your host. If there aren't enough processes matching the rule, you receive an alert. If you also enable Process instance snapshots, you receive a detailed report on the activity of the most resource-consuming processes, as well as on the latest activity of the processes matching the rule.

    In order to monitor the availability of a certain group of processes, you must first define a monitoring rule. Give your monitoring rule a unique name and add its detection rules to which Dynatrace will match the processes on your host.

    For more details, see Process availability

    Schema IDSchema groupsScope
    builtin:processavailability
    • 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:processavailability
    SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:processavailability
    Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:processavailability

    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
    Monitoring rule name
    name    		text-required
    Operating system
    operatingSystem    		Set<OperatingSystem>

    Select the operating systems on which the monitoring rule should be applied.

    • WINDOWS
    • LINUX
    • AIX
    		required
    Minimum number of matching processes
    minimumProcesses    		integer

    Specify a minimum number of processes matching the monitoring rule. If it's not satisfied, an alert will open.

    		required
    Define detection rules
    rules    		DetectionCondition[]

    Define process detection rules by selecting a process property and a condition. Each monitoring rule can have multiple detection rules associated with it.

    		required
    Properties
    metadata    		Set<MetadataItem>

    Set of additional key-value properties to be attached to the triggered event. You can retrieve the available property keys using the Events API v2.

    		required
    The DetectionCondition object
    PropertyTypeDescriptionRequired
    Rule scope
    ruleType    		enum
    • RuleTypeProcess
    • RuleTypeHost
    		required
    Select process property
    property    		enum
    • executable
    • executablePath
    • commandLine
    • user
    		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 Process availability.

    		required
    Custom metadata
    hostMetadataCondition    		HostMetadataCondition

    Host custom metadata refers to user-defined key-value pairs that you can assign to hosts monitored by Dynatrace.

    By defining custom metadata, you can enrich the monitoring data with context specific to your organization's needs, such as environment names, team ownership, application versions, or any other relevant details.

    See Define tags and metadata for hosts.

    		required
    The MetadataItem object
    PropertyTypeDescriptionRequired
    Key
    metadataKey    		text

    Type 'dt.' for key hints.

    		required
    Value
    metadataValue    		text

    Type '{' for placeholder hints.

    		required
    The HostMetadataCondition object
    PropertyTypeDescriptionRequired
    Key must exist
    keyMustExist    		boolean

    When enabled, the condition requires a metadata key to exist and match the constraints; when disabled, the key is optional but must still match the constrains if it is present.

    		required
    Key
    metadataKey    		text-required
    Condition
    metadataCondition    		text

    This string has to match a required format.

    • $match(ver*_1.2.?) – Matches string with wildcards: * any number (including zero) of characters and ? exactly one character.
    • $contains(production) – Matches if production appears anywhere in the host metadata value.
    • $eq(production) – Matches if production matches the host metadata value exactly.
    • $prefix(production) – Matches if production matches the prefix of the host metadata value.
    • $suffix(production) – Matches if production matches the suffix of the host metadata value.

    Available logic operations:

    • $not($eq(production)) – Matches if the host metadata value is different from production.
    • $and($prefix(production),$suffix(main)) – Matches if host metadata value starts with production and ends with main.
    • $or($prefix(production),$suffix(main)) – Matches if host metadata value starts with production or ends with main.

    Brackets ( and ) that are part of the matched property must be escaped with a tilde (~)

    		required