slo

Documentation

Index

• Variables
• type ErrorBudgetBurnRate
  • func (me *ErrorBudgetBurnRate) HandlePreconditions() error
  • func (me *ErrorBudgetBurnRate) MarshalHCL(properties hcl.Properties) error
  • func (me *ErrorBudgetBurnRate) Schema() map[string]*schema.Schema
  • func (me *ErrorBudgetBurnRate) UnmarshalHCL(decoder hcl.Decoder) error
• type FlagDefaultTrue
  • func (me *FlagDefaultTrue) MarshalHCL(properties hcl.Properties) error
  • func (me *FlagDefaultTrue) Schema() map[string]*schema.Schema
  • func (me *FlagDefaultTrue) UnmarshalHCL(decoder hcl.Decoder) error
• type Settings
  • func (me *Settings) MarshalHCL(properties hcl.Properties) error
  • func (me *Settings) Schema() map[string]*schema.Schema
  • func (me *Settings) UnmarshalHCL(decoder hcl.Decoder) error
• type SloEvaluationType

Variables

var SloEvaluationTypes = struct {
	Aggregate SloEvaluationType
}{
	"AGGREGATE",
}

Types

type ErrorBudgetBurnRate

type ErrorBudgetBurnRate struct {
	BurnRateVisualizationEnabled bool     `json:"burnRateVisualizationEnabled"` // Burn rate visualization enabled
	FastBurnThreshold            *float64 `json:"fastBurnThreshold,omitempty"`  // The threshold defines when a burn rate is marked as fast-burning (high-emergency). Burn rates lower than this threshold (and greater than 1) are highlighted as slow-burn (low-emergency).
}

func (*ErrorBudgetBurnRate) HandlePreconditions

func (me *ErrorBudgetBurnRate) HandlePreconditions() error

func (*ErrorBudgetBurnRate) MarshalHCL

func (me *ErrorBudgetBurnRate) MarshalHCL(properties hcl.Properties) error

func (*ErrorBudgetBurnRate) Schema

func (me *ErrorBudgetBurnRate) Schema() map[string]*schema.Schema

func (*ErrorBudgetBurnRate) UnmarshalHCL

func (me *ErrorBudgetBurnRate) UnmarshalHCL(decoder hcl.Decoder) error

type FlagDefaultTrue

type FlagDefaultTrue struct {
	Enabled bool `json:"enabled"` // This setting is enabled (`true`) or disabled (`false`)
}

func (*FlagDefaultTrue) MarshalHCL

func (me *FlagDefaultTrue) MarshalHCL(properties hcl.Properties) error

func (*FlagDefaultTrue) Schema

func (me *FlagDefaultTrue) Schema() map[string]*schema.Schema

func (*FlagDefaultTrue) UnmarshalHCL

func (me *FlagDefaultTrue) UnmarshalHCL(decoder hcl.Decoder) error

type Settings

type Settings struct {
	CustomDescription   *string              `json:"customDescription,omitempty"` // The description of the SLO
	Enabled             bool                 `json:"enabled"`                     // This setting is enabled (`true`) or disabled (`false`)
	ErrorBudgetBurnRate *ErrorBudgetBurnRate `json:"errorBudgetBurnRate"`         // ### Error budget burn rate
	EvaluationType      SloEvaluationType    `json:"evaluationType"`              // Possible Values: `AGGREGATE`
	EvaluationWindow    string               `json:"evaluationWindow"`            // Define the timeframe during which the SLO is to be evaluated. For the timeframe you can enter expressions like -1h (last hour), -1w (last week) or complex expressions like -2d to now (last two days), -1d/d to now/d (beginning of yesterday to beginning of today).
	Filter              string               `json:"filter"`                      // Set a filter parameter (entitySelector) on any GET call to evaluate this SLO against specific services only (for example, type(\"SERVICE\")).  For details, see the [Entity Selector documentation](https://dt-url.net/entityselector).
	MetricExpression    string               `json:"metricExpression"`            // For details, see the [Metrics page](/ui/metrics \"Metrics page\").
	MetricName          string               `json:"metricName"`                  // Metric name
	Name                string               `json:"name"`                        // SLO name
	TargetSuccess       float64              `json:"targetSuccess"`               // Set the target value of the SLO. A percentage below this value indicates a failure.
	TargetWarning       float64              `json:"targetWarning"`               // Set the warning value of the SLO. At the warning state the SLO is fulfilled. However, it is getting close to a failure.
	LegacyID            *string              `json:"-"`
}

func (*Settings) MarshalHCL

func (me *Settings) MarshalHCL(properties hcl.Properties) error

func (*Settings) Schema

func (me *Settings) Schema() map[string]*schema.Schema

func (*Settings) UnmarshalHCL

func (me *Settings) UnmarshalHCL(decoder hcl.Decoder) error

type SloEvaluationType

type SloEvaluationType string