Settings API - Site Reliability Guardian schema table

  • Published Dec 05, 2023

Site Reliability Guardian (app:dynatrace.site.reliability.guardian:guardians)

Create new guardians and add objectives. See documentation

Schema IDSchema groupsScope
app:dynatrace.site.reliability.guardian:guardians-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians

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
Name
name		text-Required
Description
description		text-Optional
Tags
tags		set

Define key/value pairs that further describe this guardian.

Required
DQL variables
variables		Variable[]

Define variables for dynamically defining DQL queries

Required
Objectives
objectives		Objective[]-Required
Event kind
eventKind		enum

If set to null/'BIZ_EVENT' validation events stored as bizevents in Grail. If set to 'SDLC_EVENT' validation events stored as SDLC events

The element has these enums
  • BIZ_EVENT
  • SDLC_EVENT
Optional
The Variable object
PropertyTypeDescriptionRequired
Name
name		text-Required
Value
definition		text-Required
The Objective object
PropertyTypeDescriptionRequired
Objective name
name		text-Required
Description
description		text-Optional
Objective type
objectiveType		enum
The element has these enums
  • DQL
  • REFERENCE_SLO
Required
DQL query
dqlQuery		text-Required
Display Unit
displayUnit		DisplayUnit-Optional
Enable auto adaptive threshold
autoAdaptiveThresholdEnabled		boolean-Optional
Reference SLO
referenceSlo		text

Please enter the metric key of your desired SLO. SLO metric keys have to start with 'func:slo.'

Required
Comparison operator
comparisonOperator		enum
The element has these enums
  • GREATER_THAN_OR_EQUAL
  • LESS_THAN_OR_EQUAL
Required
Target
target		float-Optional
Warning
warning		float-Optional
Segments
segments		Segment[]-Required
The DisplayUnit object
PropertyTypeDescriptionRequired
Base Unit
base		text-Required
display as unit
display		text-Required
Decimals
decimals		integer-Required
The Segment object
PropertyTypeDescriptionRequired
Segment ID
id		text-Required
Segment Variables
variables		SegmentVariable[]-Required
The SegmentVariable object
PropertyTypeDescriptionRequired
Variable Name
name		text-Required
Variable Values
values		list-Required