sitereliabilityguardian

Documentation

Index

• Variables
• type ComparisonOperator
• type Objective
  • func (me *Objective) HandlePreconditions() error
  • func (me *Objective) MarshalHCL(properties hcl.Properties) error
  • func (me *Objective) Schema() map[string]*schema.Schema
  • func (me *Objective) UnmarshalHCL(decoder hcl.Decoder) error
• type ObjectiveType
• type Objectives
  • func (me Objectives) MarshalHCL(properties hcl.Properties) error
  • func (me *Objectives) Schema() map[string]*schema.Schema
  • func (me *Objectives) 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 Variable
  • func (me *Variable) MarshalHCL(properties hcl.Properties) error
  • func (me *Variable) Schema() map[string]*schema.Schema
  • func (me *Variable) UnmarshalHCL(decoder hcl.Decoder) error
• type Variables
  • func (me Variables) MarshalHCL(properties hcl.Properties) error
  • func (me *Variables) Schema() map[string]*schema.Schema
  • func (me *Variables) UnmarshalHCL(decoder hcl.Decoder) error

Variables

var ComparisonOperators = struct {
	GreaterThanOrEqual ComparisonOperator
	LessThanOrEqual    ComparisonOperator
}{
	"GREATER_THAN_OR_EQUAL",
	"LESS_THAN_OR_EQUAL",
}

var ObjectiveTypes = struct {
	Dql          ObjectiveType
	ReferenceSlo ObjectiveType
}{
	"DQL",
	"REFERENCE_SLO",
}

Types

type ComparisonOperator

type ComparisonOperator string

type Objective

type Objective struct {
	ComparisonOperator ComparisonOperator `json:"comparisonOperator"` // Possible Values: `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`
	Description        *string            `json:"description,omitempty"`
	DqlQuery           *string            `json:"dqlQuery,omitempty"`     // DQL query
	Name               string             `json:"name"`                   // Objective name
	ObjectiveType      ObjectiveType      `json:"objectiveType"`          // Possible Values: `DQL`, `REFERENCE_SLO`
	ReferenceSlo       *string            `json:"referenceSlo,omitempty"` // Please enter the metric key of your desired SLO. SLO metric keys have to start with 'func:slo.'
	Target             *float64           `json:"target,omitempty"`
	Warning            *float64           `json:"warning,omitempty"`
}

func (*Objective) HandlePreconditions

func (me *Objective) HandlePreconditions() error

func (*Objective) MarshalHCL

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

func (*Objective) Schema

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

func (*Objective) UnmarshalHCL

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

type ObjectiveType

type ObjectiveType string

type Objectives

type Objectives []*Objective

func (Objectives) MarshalHCL

func (me Objectives) MarshalHCL(properties hcl.Properties) error

func (*Objectives) Schema

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

func (*Objectives) UnmarshalHCL

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

type Settings

type Settings struct {
	Description *string    `json:"description,omitempty"` // Description
	Name        string     `json:"name"`                  // Name
	Objectives  Objectives `json:"objectives"`            // Objectives
	Tags        []string   `json:"tags,omitempty"`        // Define key/value pairs that further describe this guardian.
	Variables   Variables  `json:"variables,omitempty"`   // Define variables for dynamically defining DQL queries
}

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 Variable

type Variable struct {
	Definition string `json:"definition"` // Value
	Name       string `json:"name"`
}

func (*Variable) MarshalHCL

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

func (*Variable) Schema

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

func (*Variable) UnmarshalHCL

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

type Variables

type Variables []*Variable

func (Variables) MarshalHCL

func (me Variables) MarshalHCL(properties hcl.Properties) error

func (*Variables) Schema

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

func (*Variables) UnmarshalHCL

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