• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • OS services monitoring

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: Alerting feature is included in host units, however if monitoring ​ is turned on for full availability metric DDU 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 IDSchema groupsScope
builtin:os-services-monitoring
  • group:monitoring
HOST - Host
HOST_GROUP - Host Group
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:os-services-monitoring
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:os-services-monitoring
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
systemSystemenum-required
nameRule nametext-required
monitoringMonitorboolean

Toggle the switch in order to enable or disable availability metric monitoring for this policy. Availability metrics consume custom metrics (DDUs). Refer to documentation for DDU consumption examples. Each monitored service consumes one custom metric.

required
alertingAlertboolean

Toggle the switch in order to enable or disable alerting for this policy

required
notInstalledAlertingAlert if service is not installedboolean

By default, Dynatrace does not alert if the service is not installed. Toggle the switch to enable or disable this feature

required
statusConditionWindowsService status condition for alertingtext

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
statusConditionLinuxService status condition for alertingtext

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
alertActivationDurationAlerting delayinteger

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
detectionConditionsWindowsDetection ruleslist-required
detectionConditionsLinuxDetection ruleslist-required
metadataPropertiesset

Set of additional key-value properties to be attached to the triggered event.

required

Request body objects

The MetadataItem object
PropertyLabelTypeDescriptionRequired
metadataKeyKeytext

Type 'dt.' for key hints.

required
metadataValueValuetext

Type '{' for placeholder hints.

required
The linuxDetectionCondition object
PropertyLabelTypeDescriptionRequired
propertyService propertyenum-required
conditionConditiontext

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
startupConditionConditiontext

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
PropertyLabelTypeDescriptionRequired
propertyService propertyenum-required
conditionConditiontext

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
startupConditionConditiontext

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