monitors

package
v1.56.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var LoadActionKPMs = struct {
	VisuallyComplete   LoadActionKPM
	SpeedIndex         LoadActionKPM
	UserActionDuration LoadActionKPM
	TimeToFirstByte    LoadActionKPM
	HTMLDownloaded     LoadActionKPM
	DOMInteractive     LoadActionKPM
	LoadEventStart     LoadActionKPM
	LoadEventEnd       LoadActionKPM
}{
	"VISUALLY_COMPLETE",
	"SPEED_INDEX",
	"USER_ACTION_DURATION",
	"TIME_TO_FIRST_BYTE",
	"HTML_DOWNLOADED",
	"DOM_INTERACTIVE",
	"LOAD_EVENT_START",
	"LOAD_EVENT_END",
}

LoadActionKPMs offers the known enum values

View Source 
var LoadingTimeThresholdTypes = struct {
	Action LoadingTimeThresholdType
	Total  LoadingTimeThresholdType
}{
	"ACTION",
	"TOTAL",
}

LoadingTimeThresholdTypes offers the known enum values

View Source 
var TagContexts = struct {
	AWS          TagContext
	AWSGeneric   TagContext
	Azure        TagContext
	CloudFoundry TagContext
	ContextLess  TagContext
	Environment  TagContext
	GoogleCloud  TagContext
	Kubernetes   TagContext
}{
	"AWS",
	"AWS_GENERIC",
	"AZURE",
	"CLOUD_FOUNDRY",
	"CONTEXTLESS",
	"ENVIRONMENT",
	"GOOGLE_CLOUD",
	"KUBERNETES",
}

TagContexts offers the known enum values

View Source 
var TagSources = struct {
	Auto      TagSource
	RuleBased TagSource
	User      TagSource
}{
	"AUTO",
	"RULE_BASED",
	"USER",
}

TagSources offers the known enum values

View Source 
var Types = struct {
	Browser Type
	HTTP    Type
}{
	"BROWSER",
	"HTTP",
}

Types offers the known enum values

View Source 
var XHRActionKPMs = struct {
	VisuallyComplete   XHRActionKPM
	UserActionDuration XHRActionKPM
	TimeToFirstByte    XHRActionKPM
	ResponseEnd        XHRActionKPM
}{
	"VISUALLY_COMPLETE",
	"USER_ACTION_DURATION",
	"TIME_TO_FIRST_BYTE",
	"RESPONSE_END",
}

LoadActionKPMs offers the known enum values

Functions

This section is empty.

Types

type AnomalyDetection 

type AnomalyDetection struct {
	OutageHandling        *OutageHandlingPolicy        `json:"outageHandling,omitempty"`
	LoadingTimeThresholds *LoadingTimeThresholdsPolicy `json:"loadingTimeThresholds,omitempty"`
}

AnomalyDetection The anomaly detection configuration

func (*AnomalyDetection) MarshalHCL 

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

func (*AnomalyDetection) Schema 

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

func (*AnomalyDetection) UnmarshalHCL 

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

type GlobalOutagePolicy 

type GlobalOutagePolicy struct {
	ConsecutiveRuns *int32 `json:"consecutiveRuns"` // The number of consecutive fails to trigger an alert
}

GlobalOutagePolicy Global outage handling configuration. \n\n Alert if **consecutiveRuns** times consecutively

func (*GlobalOutagePolicy) MarshalHCL 

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

func (*GlobalOutagePolicy) Schema 

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

func (*GlobalOutagePolicy) UnmarshalHCL 

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

type KeyPerformanceMetrics 

type KeyPerformanceMetrics struct {
	LoadActionKPM LoadActionKPM `json:"loadActionKpm"` // Defines the key performance metric for load actions
	XHRActionKPM  XHRActionKPM  `json:"xhrActionKpm"`  // Defines the key performance metric for XHR actions
}

KeyPerformanceMetrics The key performance metrics configuration

func (*KeyPerformanceMetrics) MarshalHCL 

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

func (*KeyPerformanceMetrics) Schema 

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

func (*KeyPerformanceMetrics) UnmarshalHCL 

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

type LoadActionKPM 

type LoadActionKPM string

LoadActionKPM Defines the key performance metric for load actions

type LoadingTimeThreshold 

type LoadingTimeThreshold struct {
	Type         LoadingTimeThresholdType `json:"type"`         // The type of the threshold: total loading time or action loading time
	ValueMs      int32                    `json:"valueMs"`      // Notify if monitor takes longer than *X* milliseconds to load
	RequestIndex *int32                   `json:"requestIndex"` // Specify the request to which an ACTION threshold applies
	EventIndex   *int32                   `json:"eventIndex"`   // Specify the event to which an ACTION threshold applies
}

LoadingTimeThreshold The performance threshold rule

func (*LoadingTimeThreshold) MarshalHCL 

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

func (*LoadingTimeThreshold) Schema 

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

func (*LoadingTimeThreshold) UnmarshalHCL 

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

type LoadingTimeThresholdType 

type LoadingTimeThresholdType string

LoadingTimeThresholdType The type of the threshold: total loading time or action loading time

type LoadingTimeThresholds 

type LoadingTimeThresholds []*LoadingTimeThreshold

func (LoadingTimeThresholds) MarshalHCL 

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

func (*LoadingTimeThresholds) Schema 

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

func (*LoadingTimeThresholds) UnmarshalHCL 

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

type LoadingTimeThresholdsPolicy 

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

func (*LoadingTimeThresholdsPolicy) EnsurePredictableOrder added in v1.35.0 

func (me *LoadingTimeThresholdsPolicy) EnsurePredictableOrder()

func (*LoadingTimeThresholdsPolicy) MarshalHCL 

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

func (*LoadingTimeThresholdsPolicy) Schema 

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

func (*LoadingTimeThresholdsPolicy) UnmarshalHCL 

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

type LocalOutagePolicy 

type LocalOutagePolicy struct {
	AffectedLocations *int32 `json:"affectedLocations"` // The number of affected locations to trigger an alert
	ConsecutiveRuns   *int32 `json:"consecutiveRuns"`   // The number of consecutive fails to trigger an alert
}

LocalOutagePolicy Local outage handling configuration. \n\n Alert if **affectedLocations** of locations are unable to access the web application **consecutiveRuns** times consecutively

func (*LocalOutagePolicy) MarshalHCL 

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

func (*LocalOutagePolicy) Schema 

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

func (*LocalOutagePolicy) UnmarshalHCL 

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

type MonitorCollectionElement 

type MonitorCollectionElement struct {
	// "required" : [ "enabled", "entityId", "name", "type" ],
	Name     string `json:"name"`     // The name of a synthetic object
	EntityID string `json:"entityId"` // The ID of a synthetic object
	Type     Type   `json:"type"`     // The type of a synthetic monitor
	Enabled  bool   `json:"enabled"`  // The state of a synthetic monitor
}

MonitorCollectionElement is the short representation of a synthetic monitor

type Monitors 

type Monitors struct {
	Monitors []*MonitorCollectionElement `json:"monitors"` // The list of synthetic monitors
}

func (*Monitors) ToStubs 

func (me *Monitors) ToStubs() api.Stubs

type OutageHandlingPolicy 

type OutageHandlingPolicy struct {
	GlobalOutage       bool                `json:"globalOutage"`       // (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable at all configured locations
	GlobalOutagePolicy *GlobalOutagePolicy `json:"globalOutagePolicy"` // (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Global outage handling configuration. \n\n Alert if **consecutiveRuns** times consecutively
	LocalOutage        bool                `json:"localOutage"`        // (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) When enabled (`true`), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location
	LocalOutagePolicy  *LocalOutagePolicy  `json:"localOutagePolicy"`  // (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Local outage handling configuration. \n\n Alert if **affectedLocations** of locations are unable to access the web application **consecutiveRuns** times consecutively
	RetryOnError       bool                `json:"retryOnError"`       // (Field has overlap with `dynatrace_browser_monitor_outage` and `dynatrace_http_monitor_outage`) Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored
}

OutageHandlingPolicy Outage handling configuration

func (*OutageHandlingPolicy) MarshalHCL 

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

func (*OutageHandlingPolicy) MarshalJSON 

func (me *OutageHandlingPolicy) MarshalJSON() ([]byte, error)

func (*OutageHandlingPolicy) Schema 

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

func (*OutageHandlingPolicy) UnmarshalHCL 

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

type SyntheticMonitor 

type SyntheticMonitor struct {
	// ID                   *string            `json:"entityId,omitempty"`         // The ID of the monitor
	Name                 string             `json:"name"`                       // The name of the monitor
	Type                 Type               `json:"type"`                       // Defines the actual set of fields depending on the value. See one of the following objects: \n\n* `BROWSER` -> BrowserSyntheticMonitorUpdate \n* `HTTP` -> HttpSyntheticMonitorUpdate
	FrequencyMin         int32              `json:"frequencyMin"`               // The frequency of the monitor, in minutes. \n\n You can use one of the following values: `5`, `10`, `15`, `30`, and `60`
	Enabled              bool               `json:"enabled"`                    // The monitor is enabled (`true`) or disabled (`false`)
	AnomalyDetection     *AnomalyDetection  `json:"anomalyDetection,omitempty"` // Configuration for Anomaly Detection
	Locations            []string           `json:"locations"`                  // A list of locations from which the monitor is executed. \n\n To specify a location, use its entity ID
	Tags                 TagsWithSourceInfo `json:"tags"`                       // A set of tags assigned to the monitor. \n\n You 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 TagWithSourceDto model
	ManuallyAssignedApps []string           `json:"manuallyAssignedApps"`       // A set of manually assigned applications
}

func (*SyntheticMonitor) GetTags 

func (me *SyntheticMonitor) GetTags() TagsWithSourceInfo

type TagContext 

type TagContext string

TagContext The origin of the tag, such as AWS or Cloud Foundry. \n\n Custom tags use the `CONTEXTLESS` value

type TagSource 

type TagSource string

TagSource The source of the tag, such as USER, RULE_BASED or AUTO

type TagWithSourceInfo 

type TagWithSourceInfo struct {
	Source  *TagSource `json:"source,omitempty"` // The source of the tag, such as USER, RULE_BASED or AUTO
	Context TagContext `json:"context"`          // The origin of the tag, such as AWS or Cloud Foundry. \n\n Custom tags use the `CONTEXTLESS` value
	Key     string     `json:"key"`              // The key of the tag. \n\n Custom tags have the tag value here
	Value   *string    `json:"value"`            // The value of the tag. \n\n Not applicable to custom tags
}

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 Type 

type Type string

Type The type of a synthetic monitor BROWSER: A Browser Monitor HTTP: A HTTP Monitor

type XHRActionKPM 

type XHRActionKPM string

XHRActionKPM Defines the key performance metric for XHR actions

Source Files

View all Source files

Directories

Path Synopsis
settings
settings/auth
settings/event
script
script/settings
settings
settings/validation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.