monitors

package
v1.71.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 13, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Aggregations = struct {
	Avg Aggregation
	Max Aggregation
	Min Aggregation
}{
	"AVG",
	"MAX",
	"MIN",
}
View Source
var MonitorTypes = struct {
	MultiProtocol MonitorType
}{
	"MULTI_PROTOCOL",
}
View Source
var RequestTypes = struct {
	ICMP RequestType
	TCP  RequestType
	DNS  RequestType
}{
	"ICMP",
	"TCP",
	"DNS",
}
View Source
var TagSources = struct {
	Auto      TagSource
	RuleBased TagSource
	User      TagSource
}{
	"AUTO",
	"RULE_BASED",
	"USER",
}

Functions

This section is empty.

Types

type Aggregation

type Aggregation string

type Constraint

type Constraint struct {
	Type       string            `json:"type"`       // Constraint type
	Properties map[string]string `json:"properties"` // Key/value pairs of constraint properties
}

func (Constraint) MarshalHCL

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

func (*Constraint) Schema

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

func (*Constraint) UnmarshalHCL

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

type Constraints

type Constraints []*Constraint

func (Constraints) MarshalHCL

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

func (*Constraints) Schema

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

func (*Constraints) UnmarshalHCL

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

type MonitorType

type MonitorType string

type MonitorsList

type MonitorsList struct {
	Monitors []MonitorsResponseElement `json:"monitors"` // A list of monitors
}

func (MonitorsList) ToStubs

func (me MonitorsList) ToStubs() api.Stubs

type MonitorsResponseElement

type MonitorsResponseElement struct {
	EntityId string      `json:"entityId"` // Entity ID of the monitor
	Name     string      `json:"name"`     // Name of the monitor
	Type     MonitorType `json:"type"`     // Type of the monitor
	Enabled  bool        `json:"enabled"`  // If true, the monitor is enabled
}

type OutageHandling

type OutageHandling struct {
	GlobalConsecutiveOutageCountThreshold int  `json:"globalConsecutiveOutageCountThreshold"`          // Number of consecutive failures for all locations
	GlobalOutages                         bool `json:"globalOutages"`                                  // Generate a problem and send an alert when the monitor is unavailable at all configured locations
	LocalConsecutiveOutageCountThreshold  *int `json:"localConsecutiveOutageCountThreshold,omitempty"` // Number of consecutive failures
	LocalLocationOutageCountThreshold     *int `json:"localLocationOutageCountThreshold,omitempty"`    // Number of failing locations
	LocalOutages                          bool `json:"localOutages"`                                   // Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location
}

func (*OutageHandling) MarshalHCL

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

func (*OutageHandling) Schema

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

func (*OutageHandling) UnmarshalHCL

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

type PerformanceThresholds

type PerformanceThresholds struct {
	Enabled    bool       `json:"enabled"`              // Performance threshold is enabled (true) or disabled (false)
	Thresholds Thresholds `json:"thresholds,omitempty"` // The list of performance threshold rules
}

func (*PerformanceThresholds) MarshalHCL

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

func (*PerformanceThresholds) Schema

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

func (*PerformanceThresholds) UnmarshalHCL

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

type RequestConfiguration

type RequestConfiguration struct {
	Constraints Constraints `json:"constraints,omitempty"` // Request constraints
}

func (RequestConfiguration) MarshalHCL

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

func (*RequestConfiguration) Schema

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

func (*RequestConfiguration) UnmarshalHCL

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

type RequestConfigurations

type RequestConfigurations []*RequestConfiguration

func (RequestConfigurations) MarshalHCL

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

func (*RequestConfigurations) Schema

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

func (*RequestConfigurations) UnmarshalHCL

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

type RequestType

type RequestType string

type Settings

type Settings struct {
	Enabled               bool                   `json:"enabled"`                                          // If true, the monitor is enabled
	Name                  string                 `json:"name"`                                             // Name of the monitor
	Type                  MonitorType            `json:"type"`                                             // Type of the monitor, possible values: `MULTI_PROTOCOL`
	Description           *string                `json:"description,omitempty"`                            // Description of the monitor
	Tags                  TagsWithSourceInfo     `json:"tags,omitempty"`                                   // A set of tags assigned to the monitor.\n\nYou can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.
	Steps                 Steps                  `json:"steps"`                                            // The steps of the monitor
	FrequencyMin          *int64                 `json:"frequencyMin,omitempty"`                           // Frequency of the monitor, in minutes
	Locations             []string               `json:"locations"`                                        // The locations to which the monitor is assigned
	OutageHandling        *OutageHandling        `json:"syntheticMonitorOutageHandlingSettings,omitempty"` // Outage handling configuration
	PerformanceThresholds *PerformanceThresholds `json:"performanceThresholds,omitempty"`                  // Performance thresholds configuration
}

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 Step

type Step struct {
	Name                  string                `json:"name"`                   // Step name
	RequestType           RequestType           `json:"requestType"`            // Request type, possible values `ICMP`, `TCP`, `DNS`
	TargetList            []string              `json:"targetList"`             // Target list
	TargetFilter          *string               `json:"targetFilter,omitempty"` // Target filter
	Properties            map[string]string     `json:"properties"`             // Key/value pairs of properties which apply to all requests in the step
	Constraints           Constraints           `json:"constraints"`            // The list of constraints which apply to all requests in the step
	RequestConfigurations RequestConfigurations `json:"requestConfigurations"`  // Request configurations
}

func (Step) MarshalHCL

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

func (*Step) Schema

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

func (*Step) UnmarshalHCL

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

type Steps

type Steps []*Step

func (Steps) MarshalHCL

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

func (*Steps) Schema

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

func (*Steps) UnmarshalHCL

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

type TagSource

type TagSource string

type TagWithSourceInfo

type TagWithSourceInfo struct {
	Source  *TagSource `json:"source,omitempty"`  // The source of the tag, possible values: `AUTO`, `RULE_BASED` or `USER`
	Context *string    `json:"context,omitempty"` // The origin of the tag, such as AWS or Cloud Foundry.\n\nCustom tags use the CONTEXTLESS value
	Key     string     `json:"key"`               // The key of the tag
	Value   *string    `json:"value,omitempty"`   // The value of the tag
}

Tag with source of a Dynatrace entity

func (TagWithSourceInfo) MarshalHCL

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

func (*TagWithSourceInfo) Schema

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

func (*TagWithSourceInfo) UnmarshalHCL

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

type TagsWithSourceInfo

type TagsWithSourceInfo []*TagWithSourceInfo

func (TagsWithSourceInfo) MarshalHCL

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

func (*TagsWithSourceInfo) Schema

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

func (*TagsWithSourceInfo) UnmarshalHCL

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

type Threshold

type Threshold struct {
	Aggregation       *Aggregation `json:"aggregation,omitempty"`       // Aggregation type, possible values: `AVG`, `MAX`, `MIN`
	DealertingSamples *int32       `json:"dealertingSamples,omitempty"` // Number of most recent non-violating request executions that closes the problem
	Samples           *int32       `json:"samples,omitempty"`           // Number of request executions in analyzed sliding window (sliding window size)
	StepIndex         *int32       `json:"stepIndex,omitempty"`         // Specify the step's index to which a threshold applies
	Threshold         *int32       `json:"threshold,omitempty"`         // Notify if monitor request takes longer than X milliseconds to execute
	ViolatingSamples  *int32       `json:"violatingSamples,omitempty"`  // Number of violating request executions in analyzed sliding window
}

func (*Threshold) MarshalHCL

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

func (*Threshold) Schema

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

func (*Threshold) UnmarshalHCL

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

type Thresholds

type Thresholds []*Threshold

func (Thresholds) MarshalHCL

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

func (*Thresholds) Schema

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

func (*Thresholds) UnmarshalHCL

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL