slo

Documentation

Index

• type ErrorBudgetBurnRate
  • func (me *ErrorBudgetBurnRate) IsEmpty() bool
  • 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 SLO
  • func (me *SLO) MarshalHCL(properties hcl.Properties) error
  • func (me *SLO) Schema() map[string]*schema.Schema
  • func (me *SLO) UnmarshalHCL(decoder hcl.Decoder) error

Types

type ErrorBudgetBurnRate

type ErrorBudgetBurnRate struct {
	BurnRateVisualizationEnabled *bool    `json:"burnRateVisualizationEnabled,omitempty"` // The error budget burn rate calculation is enabled (true) or disabled (false).
	FastBurnThreshold            *float64 `json:"fastBurnThreshold,omitempty"`            // The threshold between a slow and a fast burn rate.
}

func (*ErrorBudgetBurnRate) IsEmpty

func (me *ErrorBudgetBurnRate) IsEmpty() bool

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 SLO

type SLO struct {
	Name                string               `json:"name"`                          // The name of the SLO
	MetricName          *string              `json:"metricName,omitempty"`          // The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
	Enabled             bool                 `json:"enabled,omitempty"`             // The SLO is enabled (`true`) or disabled (`false`)
	Description         *string              `json:"description,omitempty"`         // The custom description of the SLO (optional)
	UseRateMetric       bool                 `json:"useRateMetric"`                 // The type of the metric to use for SLO calculation: \n\n* `true`: An existing percentage-based metric. \n* `false`: A ratio of two metrics. \n\nFor a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call
	MetricRate          *string              `json:"metricRate,omitempty"`          // The percentage-based metric for the calculation of the SLO. \n\nRequired when the **useRateMetric** is set to `true`
	MetricExpression    *string              `json:"metricExpression,omitempty"`    // The percentage-based metric expression for the calculation of the SLO
	MetricNumerator     *string              `json:"metricNumerator,omitempty"`     // The metric for the count of successes (the numerator in rate calculation). \n\nRequired when the **useRateMetric** is set to `false`
	MetricDenominator   *string              `json:"metricDenominator,omitempty"`   // The total count metric (the denominator in rate calculation). \n\nRequired when the **useRateMetric** is set to `false`
	EvaluationType      string               `json:"evaluationType"`                // The evaluation type of the SLO. Currently only `AGGREGATE` is supported
	Filter              *string              `json:"filter,omitempty"`              // The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector)
	Target              float64              `json:"target"`                        // The target value of the SLO
	Warning             float64              `json:"warning"`                       // The warning value of the SLO. \n\n At warning state the SLO is still fulfilled but is getting close to failure
	Timeframe           string               `json:"timeframe"`                     // The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector
	ErrorBudgetBurnRate *ErrorBudgetBurnRate `json:"errorBudgetBurnRate,omitempty"` // Error budget burn rate configuration of a service-level objective (SLO).
}

func (*SLO) MarshalHCL

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

func (*SLO) Schema

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

func (*SLO) UnmarshalHCL

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