Settings API - OS services monitoring schema table

OS services monitoring (`builtin:os-services-monitoring`)

Set up alerts for OS services in undesirable states both for Windows and Linux systemd. Note: If monitoring is turned on for full availability metric, custom metric consumption takes place. Refer to documentation for more details.

Please provide feedback to us about this feature on Dynatrace Community.

In order to set up the alert for a certain group of OS services, you must first define a new policy. Specify which service's states you would like to be alerted about and then add detection rules in order to tell Dynatrace which exact OS services you are interested in. You may specify multiple detection rules.

Note that policies are specified for each of supported operating systems individually and that some of the parameters and properties vary between them.

Schema ID	Schema groups	Scope
`builtin:os-services-monitoring`	`group:monitoring`	`HOST` - Host `HOST_GROUP` - Host Group `environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:os-services-monitoring`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:os-services-monitoring`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:os-services-monitoring`

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	Label	Type	Description	Required
enabled	Enabled	boolean	-	required
system	System	enum	-	required
name	Rule name	text	-	required
monitoring	Monitor	boolean	Toggle the switch in order to enable or disable availability metric monitoring for this policy. Availability metrics produce custom metrics. Refer to documentation for consumption examples. Each monitored service consumes one custom metric.	required
alerting	Alert	boolean	Toggle the switch in order to enable or disable alerting for this policy	required
notInstalledAlerting	Alert if service is not installed	boolean	By default, Dynatrace does not alert if the service is not installed. Toggle the switch to enable or disable this feature	required
statusConditionWindows	Service status condition for alerting	text	This string has to match a required format. See OS services monitoring. `$eq(paused)` – Matches services that are in paused state. Available logic operations: `$not($eq(paused))` – Matches services that are in state different from paused. `$or($eq(paused),$eq(running))` – Matches services that are either in paused or running state. Use one of the following values as a parameter for this condition: `running` `stopped` `start_pending` `stop_pending` `continue_pending` `pause_pending` `paused`	required
statusConditionLinux	Service status condition for alerting	text	This string has to match a required format. See OS services monitoring. `$eq(failed)` – Matches services that are in failed state. Available logic operations: `$not($eq(active))` – Matches services with state different from active. `$or($eq(inactive),$eq(failed))` – Matches services that are either in inactive or failed state. Use one of the following values as a parameter for this condition: `reloading` `activating` `deactivating` `failed` `inactive` `active`	required
alertActivationDuration	Alerting delay	integer	The number of 10-second measurement cycles before alerting is triggered Set this value to control the speed of alerting. One is the lowest setting equal to one 10-second sample. If you set this value to 30, alerting is triggered after 5 minutes.	required
detectionConditionsWindows	Detection rules	list	-	required
detectionConditionsLinux	Detection rules	list	-	required
metadata	Properties	set	Set of additional key-value properties to be attached to the triggered event.	required

Request body objects

The `MetadataItem` object

Property	Label	Type	Description	Required
metadataKey	Key	text	Type 'dt.' for key hints.	required
metadataValue	Value	text	Type '{' for placeholder hints.	required

The `linuxDetectionCondition` object

Property Label Type Description Required

property Service property enum - required

condition

Condition

Property	Label	Type	Description	Required
property	Service property	enum	-	required
condition	Condition	text	This string has to match a required format. See OS services monitoring. `$contains(ssh)` – Matches if `ssh` appears anywhere in the service's property value. `$eq(sshd)` – Matches if `sshd` matches the service's property value exactly. `$prefix(ss)` – Matches if `ss` matches the prefix of the service's property value. `$suffix(hd)` – Matches if `hd` matches the suffix of the service's property value. Available logic operations: `$not($eq(sshd))` – Matches if the service's property value is different from `sshd`. `$and($prefix(ss),$suffix(hd))` – Matches if service's property value starts with `ss` and ends with `hd`. `$or($prefix(ss),$suffix(hd))` – Matches if service's property value starts with `ss` or ends with `hd`.	required
startupCondition	Condition	text	This string has to match a required format. See OS services monitoring. `$eq(enabled)` – Matches services with startup type equal to enabled. Available logic operations: `$not($eq(enabled))` – Matches services with startup type different from enabled. `$or($eq(enabled),$eq(disabled))` - Matches services that are either enabled or disabled. Use one of the following values as a parameter for this condition: `enabled` `enabled-runtime` `static` `disabled`	required

text

This string has to match a required format. See OS services monitoring.

$contains(ssh) – Matches if ssh appears anywhere in the service's property value.
$eq(sshd) – Matches if sshd matches the service's property value exactly.
$prefix(ss) – Matches if ss matches the prefix of the service's property value.
$suffix(hd) – Matches if hd matches the suffix of the service's property value.

Available logic operations:

$not($eq(sshd)) – Matches if the service's property value is different from sshd.
$and($prefix(ss),$suffix(hd)) – Matches if service's property value starts with ss and ends with hd.
$or($prefix(ss),$suffix(hd)) – Matches if service's property value starts with ss or ends with hd.

required

startupCondition

Condition

text

This string has to match a required format. See OS services monitoring.

$eq(enabled) – Matches services with startup type equal to enabled.

Available logic operations:

$not($eq(enabled)) – Matches services with startup type different from enabled.
$or($eq(enabled),$eq(disabled)) - Matches services that are either enabled or disabled.

Use one of the following values as a parameter for this condition:

enabled
enabled-runtime
static
disabled

required

The `windowsDetectionCondition` object

Property Label Type Description Required

property Service property enum - required

condition

Condition

Property	Label	Type	Description	Required
property	Service property	enum	-	required
condition	Condition	text	This string has to match a required format. See OS services monitoring. `$contains(ssh)` – Matches if `ssh` appears anywhere in the service's property value. `$eq(sshd)` – Matches if `sshd` matches the service's property value exactly. `$prefix(ss)` – Matches if `ss` matches the prefix of the service's property value. `$suffix(hd)` – Matches if `hd` matches the suffix of the service's property value. Available logic operations: `$not($eq(sshd))` – Matches if the service's property value is different from `sshd`. `$and($prefix(ss),$suffix(hd))` – Matches if service's property value starts with `ss` and ends with `hd`. `$or($prefix(ss),$suffix(hd))` – Matches if service's property value starts with `ss` or ends with `hd`.	required
startupCondition	Condition	text	This string has to match a required format. See OS services monitoring. `$eq(manual)` – Matches services that are started manually. Available logic operations: `$not($eq(auto))` – Matches services with startup type different from Automatic. `$or($eq(auto),$eq(manual))` – Matches if service's startup type is either Automatic or Manual. Use one of the following values as a parameter for this condition: `manual` for Manual `manual_trigger` for Manual (Trigger Start) `auto` for Automatic `auto_delay` for Automatic (Delayed Start) `auto_trigger` for Automatic (Trigger Start) `auto_delay_trigger` for Automatic (Delayed Start, Trigger Start) `disabled` for Disabled	required

text

This string has to match a required format. See OS services monitoring.

$contains(ssh) – Matches if ssh appears anywhere in the service's property value.
$eq(sshd) – Matches if sshd matches the service's property value exactly.
$prefix(ss) – Matches if ss matches the prefix of the service's property value.
$suffix(hd) – Matches if hd matches the suffix of the service's property value.

Available logic operations:

$not($eq(sshd)) – Matches if the service's property value is different from sshd.
$and($prefix(ss),$suffix(hd)) – Matches if service's property value starts with ss and ends with hd.
$or($prefix(ss),$suffix(hd)) – Matches if service's property value starts with ss or ends with hd.

required

startupCondition

Condition

text

This string has to match a required format. See OS services monitoring.

$eq(manual) – Matches services that are started manually.

Available logic operations:

$not($eq(auto)) – Matches services with startup type different from Automatic.
$or($eq(auto),$eq(manual)) – Matches if service's startup type is either Automatic or Manual.

Use one of the following values as a parameter for this condition:

manual for Manual
manual_trigger for Manual (Trigger Start)
auto for Automatic
auto_delay for Automatic (Delayed Start)
auto_trigger for Automatic (Trigger Start)
auto_delay_trigger for Automatic (Delayed Start, Trigger Start)
disabled for Disabled

required

Settings API - OS services monitoring schema table

OS services monitoring (builtin:os-services-monitoring)

Authentication

Parameters

Request body objects

The MetadataItem object

The linuxDetectionCondition object

The windowsDetectionCondition object

OS services monitoring (`builtin:os-services-monitoring`)

The `MetadataItem` object

The `linuxDetectionCondition` object

The `windowsDetectionCondition` object