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 ID | Schema groups | Scope |
---|---|---|
builtin:processavailability |
| HOST - HostHOST_GROUP - Host Groupenvironment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:processavailability |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:processavailability | |
Environment ActiveGate | https://{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
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | - | required |
Monitoring rule namename | text | - | required |
Operating systemoperatingSystem | Set<OperatingSystem> | Select the operating systems on which the monitoring rule should be applied.
| required |
Minimum number of matching processesminimumProcesses | integer | Specify a minimum number of processes matching the monitoring rule. If it's not satisfied, an alert will open. | required |
Define detection rulesrules | 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 |
Propertiesmetadata | Set<MetadataItem> | Set of additional key-value properties to be attached to the triggered event. | required |
The DetectionCondition
object
Property | Type | Description | Required |
---|---|---|---|
Rule scoperuleType | enum |
| required |
Select process propertyproperty | enum |
| required |
Conditioncondition | text |
For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py. For more details, see Process availability. | required |
Custom metadatahostMetadataCondition | 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. | required |
The MetadataItem
object
Property | Type | Description | Required |
---|---|---|---|
KeymetadataKey | text | Type 'dt.' for key hints. | required |
ValuemetadataValue | text | Type '{' for placeholder hints. | required |
The HostMetadataCondition
object
Property | Type | Description | Required |
---|---|---|---|
Key must existkeyMustExist | 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 |
KeymetadataKey | text | - | required |
ConditionmetadataCondition | text | This string has to match a required format.
Available logic operations:
Brackets ( and ) that are part of the matched property must be escaped with a tilde (~) | required |