Settings API - Anomaly detection for infrastructure- Disk Edge schema table

Anomaly detection for infrastructure: Disk Edge (builtin:infrastructure.disk.edge.anomaly-detectors)

The Disk Edge feature within Dynatrace provides automatic detection of performance anomalies related to disk infrastructure. Use these settings to tailor detection sensitivity to a specific disk's name and/or custom metadata. Defining custom properties can help with post processing of the event.

Policy Hierarchy and Scope

The order of policies establishes a hierarchical structure. Disk is assigned to a policy it matches to (based on disk name and/or metadata) according to the policies hierarchy.

Policies can be defined within Host, Host Group and Tenant scope. Lower scope has priority over the higher one.

To learn more about Disk Edge visit its official documentation.

Schema IDSchema groupsScope
builtin:infrastructure.disk.edge.anomaly-detectors
  • group:anomaly-detection.infrastructure
  • group:anomaly-detection
HOST - Host
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:infrastructure.disk.edge.anomaly-detectors
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:infrastructure.disk.edge.anomaly-detectors
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:infrastructure.disk.edge.anomaly-detectors

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
Policy name
policyName
text-required
Enabled
enabled
boolean-required
Operating system
operatingSystem
Set<EOperatingSystem>

Select the operating systems on which policy should be applied

  • WINDOWS
  • LINUX
  • AIX
required
Alerts
alerts
Set<Alert>-required
Disk name filters
diskNameFilters
set

Disk will be included in this policy if any of the filters match

Disk name filter has to match a required format.

  • $match(/zSecure/snapshot?/*) – Matches string with wildcards: * any number (including zero) of characters and ? exactly one character.
  • $contains(/log/) – Matches if /log/ appears anywhere in disk name.
  • $eq(/) – Matches if / matches the disk name exactly.
  • $prefix(/srv/) – Matches if /srv/ matches the prefix of disk name.
  • $suffix(/backup) – Matches if /backup matches the suffix of disk name.

Available logic operations:

  • $not($eq(/usr)) – Matches if the disk name is different from /usr.
  • $and($prefix(/var),$suffix(/backup)) – Matches if disk name starts with /var and ends with /backup.
  • $or($prefix(/home/),$eq(/root)) – Matches if disk name starts with /home or equals /root.

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

required
Host custom metadata conditions
hostMetadataConditions
Set<HostMetadataConditionType>

The policy will be enabled if all conditions are met

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
Properties
eventProperties
Set<MetadataItem>

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

required
The Alert object
PropertyTypeDescriptionRequired
Trigger
trigger
enum
  • AVAILABLE_DISK_SPACE_MEBIBYTES_BELOW
  • AVAILABLE_DISK_SPACE_PERCENT_BELOW
  • AVAILABLE_INODES_NUMBER_BELOW
  • AVAILABLE_INODES_PERCENT_BELOW
  • READ_TIME_EXCEEDING
  • WRITE_TIME_EXCEEDING
  • READ_ONLY_FILE_SYSTEM
required
thresholdPercentfloat-required
thresholdMillisecondsfloat-required
thresholdMebibytesfloat-required
thresholdNumberfloat-required
sampleCountThresholdsImmediatelySampleCountThresholdsImmediately-required
sampleCountThresholdsSampleCountThresholds-required
The HostMetadataConditionType object
PropertyTypeDescriptionRequired
hostMetadataConditionHostMetadataCondition-required
The MetadataItem object
PropertyTypeDescriptionRequired
Key
metadataKey
text

Type 'dt.' for key hints.

required
Value
metadataValue
text

Type '{' for placeholder hints.

required
The SampleCountThresholdsImmediately object
PropertyTypeDescriptionRequired
Violating samples
violatingSamples
integer

The number of 10-second samples within the evaluation window that must exceed the threshold to trigger an event

required
Evaluation window size for violating samples
violatingEvaluationWindow
integer

The number of 10-second samples that form the sliding evaluation window to detect violating samples.

required
Dealerting samples
dealertingSamples
integer

The number of 10-second samples within the evaluation window that must be lower than the threshold to close an event

required
Evaluation window size for dealerting samples
dealertingEvaluationWindow
integer

The number of 10-second samples that form the sliding evaluation window for dealerting.

required
The SampleCountThresholds object
PropertyTypeDescriptionRequired
Violating samples
violatingSamples
integer

The number of 10-second samples within the evaluation window that must exceed the threshold to trigger an event

required
Evaluation window size for violating samples
violatingEvaluationWindow
integer

The number of 10-second samples that form the sliding evaluation window to detect violating samples.

required
Dealerting samples
dealertingSamples
integer

The number of 10-second samples within the evaluation window that must be lower than the threshold to close an event

required
Evaluation window size for dealerting samples
dealertingEvaluationWindow
integer

The number of 10-second samples that form the sliding evaluation window for dealerting.

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.

  • $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