metricevents

package
v1.23.0 Latest Latest
Warning

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

 Go to latest Published: Mar 15, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Aggregations = struct {
	Minimum    Aggregation
	Maximum    Aggregation
	Summary    Aggregation
	Count      Aggregation
	Average    Aggregation
	Value      Aggregation
	Median     Aggregation
	Percentile Aggregation
}{
	"MIN",
	"MAX",
	"SUM",
	"COUNT",
	"AVG",
	"VALUE",
	"MEDIAN",
	"PERCENTILE90",
}
View Source 
var AlertConditions = struct {
	Above   AlertCondition
	Below   AlertCondition
	Outside AlertCondition
}{
	"ABOVE",
	"BELOW",
	"OUTSIDE",
}
View Source 
var EntityFilterOperators = struct {
	ContainsInsensitive EntityFilterOperator
	ContainsSensitive   EntityFilterOperator
	Equals              EntityFilterOperator
}{
	"CONTAINS_CASE_INSENSITIVE",
	"CONTAINS_CASE_SENSITIVE",
	"EQUALS",
}
View Source 
var EntityFilterTypes = struct {
	Name             EntityFilterType
	Entity           EntityFilterType
	MgmtZone         EntityFilterType
	Tag              EntityFilterType
	Host             EntityFilterType
	HostGrpName      EntityFilterType
	ProcGrpName      EntityFilterType
	ProcGrpID        EntityFilterType
	CustomDevGrpName EntityFilterType
}{
	"NAME",
	"ENTITY_ID",
	"MANAGEMENT_ZONE",
	"TAG",
	"HOST_NAME",
	"HOST_GROUP_NAME",
	"PROCESS_GROUP_NAME",
	"PROCESS_GROUP_ID",
	"CUSTOM_DEVICE_GROUP_NAME",
}
View Source 
var EventTypeEnums = struct {
	Info              EventTypeEnum
	Error             EventTypeEnum
	Availability      EventTypeEnum
	Slowdown          EventTypeEnum
	Resource          EventTypeEnum
	CustomAlert       EventTypeEnum
	CustomAnnotation  EventTypeEnum
	CustomConfig      EventTypeEnum
	CustomDeployment  EventTypeEnum
	MaskedTermination EventTypeEnum
}{
	"INFO",
	"ERROR",
	"AVAILABILITY",
	"SLOWDOWN",
	"RESOURCE",
	"CUSTOM_ALERT",
	"CUSTOM_ANNOTATION",
	"CUSTOM_CONFIGURATION",
	"CUSTOM_DEPLOYMENT",
	"MARKED_FOR_TERMINATION",
}
View Source 
var ModelTypes = struct {
	Static       ModelType
	AutoAdaptive ModelType
	Seasonal     ModelType
}{
	"STATIC_THRESHOLD",
	"AUTO_ADAPTIVE_THRESHOLD",
	"SEASONAL_BASELINE",
}
View Source 
var Types = struct {
	MetricKey      Type
	MetricSelector Type
}{
	"METRIC_KEY",
	"METRIC_SELECTOR",
}

Functions

This section is empty.

Types

type Aggregation 

type Aggregation string

type AlertCondition 

type AlertCondition string

type DimensionFilter 

type DimensionFilter struct {
	DimensionKey   string `json:"dimensionKey"`   // The key of the dimension filter
	DimensionValue string `json:"dimensionValue"` // The value of the dimension filter
}

func (*DimensionFilter) MarshalHCL 

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

func (*DimensionFilter) Schema 

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

func (*DimensionFilter) UnmarshalHCL 

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

type DimensionFilters 

type DimensionFilters []*DimensionFilter // Dimension filter definitions

func (DimensionFilters) MarshalHCL 

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

func (*DimensionFilters) Schema 

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

func (*DimensionFilters) UnmarshalHCL 

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

type EntityFilter 

type EntityFilter struct {
	DimensionKey *string                `json:"dimensionKey,omitempty"` // Dimension key of entity type to filter
	Conditions   EntityFilterConditions `json:"conditions,omitempty"`   // Conditions of entity type to filter
}

func (*EntityFilter) MarshalHCL 

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

func (*EntityFilter) Schema 

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

func (*EntityFilter) UnmarshalHCL 

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

type EntityFilterCondition 

type EntityFilterCondition struct {
	Type     EntityFilterType     `json:"type"`
	Operator EntityFilterOperator `json:"operator"`
	Value    string               `json:"value"`
}

func (*EntityFilterCondition) MarshalHCL 

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

func (*EntityFilterCondition) Schema 

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

func (*EntityFilterCondition) UnmarshalHCL 

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

type EntityFilterConditions 

type EntityFilterConditions []*EntityFilterCondition // Entity filter conditions

func (EntityFilterConditions) MarshalHCL 

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

func (*EntityFilterConditions) Schema 

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

func (*EntityFilterConditions) UnmarshalHCL 

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

type EntityFilterOperator 

type EntityFilterOperator string

type EntityFilterType 

type EntityFilterType string

type EventTemplate 

type EventTemplate struct {
	Title       string          `json:"title"`              // The title of the event to trigger.
	Description string          `json:"description"`        // The description of the event to trigger.
	EventType   EventTypeEnum   `json:"eventType"`          // The event type to trigger.
	DavisMerge  bool            `json:"davisMerge"`         // Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created.
	Metadata    []*MetadataItem `json:"metadata,omitempty"` // Set of additional key-value properties to be attached to the triggered event.
}

func (*EventTemplate) MarshalHCL 

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

func (*EventTemplate) Schema 

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

func (*EventTemplate) UnmarshalHCL 

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

type EventTypeEnum 

type EventTypeEnum string

type MetadataItem 

type MetadataItem struct {
	MetadataKey   string `json:"metadataKey"`   // The key of the metadata item
	MetadataValue string `json:"metadataValue"` // The value of the metadata item
}

func (*MetadataItem) MarshalHCL 

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

func (*MetadataItem) Schema 

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

func (*MetadataItem) UnmarshalHCL 

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

type MetricEvents 

type MetricEvents struct {
	Enabled                 bool             `json:"enabled"`                           // Enabled toggle of metric event entry
	Summary                 string           `json:"summary"`                           // The textual summary of the metric event entry
	QueryDefinition         *QueryDefinition `json:"queryDefinition"`                   // The query definition of the metric event entry
	ModelProperties         *ModelProperties `json:"modelProperties"`                   // The model properties of the metric event entry
	EventTemplate           *EventTemplate   `json:"eventTemplate"`                     // The event template of the metric event entry
	EventEntityDimensionKey *string          `json:"eventEntityDimensionKey,omitempty"` // Controls the preferred entity type used for triggered events.
	LegacyId                *string          `json:"legacyId,omitempty"`                // The legacy id of the metric event entry
}

func (*MetricEvents) MarshalHCL 

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

func (*MetricEvents) Name 

func (me *MetricEvents) Name() string

func (*MetricEvents) Schema 

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

func (*MetricEvents) UnmarshalHCL 

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

type ModelProperties 

type ModelProperties struct {
	Type              ModelType      `json:"type"`                        // Metric-key-based query definitions only support static thresholds.
	Threshold         *float64       `json:"threshold,omitempty"`         // Raise an event if this value is violated
	AlertOnNoData     bool           `json:"alertOnNoData"`               // The ability to set an alert on missing data in a metric. When enabled, missing data samples will contribute as violating samples defined in advanced model properties. We recommend to not alert on missing data for sparse timeseries as this leads to alert spam.
	SignalFluctuation *float64       `json:"signalFluctuation,omitempty"` // Controls how many times the signal fluctuation is added to the baseline to produce the actual threshold for alerting
	Tolerance         *float64       `json:"tolerance,omitempty"`         //  Controls the width of the confidence band and larger values lead to a less sensitive model
	AlertCondition    AlertCondition `json:"alertCondition"`              // The alert condition of the model properties
	ViolatingSamples  int            `json:"violatingSamples"`            // The number of one-minute samples within the evaluation window that must violate to trigger an event.
	Samples           int            `json:"samples"`                     // The number of one-minute samples that form the sliding evaluation window.
	DealertingSamples int            `json:"dealertingSamples"`           // The number of one-minute samples within the evaluation window that must go back to normal to close the event.
}

func (*ModelProperties) MarshalHCL 

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

func (*ModelProperties) Schema 

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

func (*ModelProperties) UnmarshalHCL 

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

type ModelType 

type ModelType string

type QueryDefinition 

type QueryDefinition struct {
	Type            Type             `json:"type"`                      // The type of query definition
	MetricSelector  *string          `json:"metricSelector,omitempty"`  /// To learn more, visit [Metric Selector](https://dt-url.net/metselad)
	MetricKey       string           `json:"metricKey"`                 // The metric key of the query definition
	Aggregation     *Aggregation     `json:"aggregation,omitempty"`     // The aggregation of the query definition
	QueryOffset     *int             `json:"queryOffset,omitempty"`     // Minute offset of sliding evaluation window for metrics with latency
	EntityFilter    *EntityFilter    `json:"entityFilter,omitempty"`    // Use rule-based filters to define the scope this event monitors.
	DimensionFilter DimensionFilters `json:"dimensionFilter,omitempty"` // The dimension filters of the query definition
}

func (*QueryDefinition) MarshalHCL 

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

func (*QueryDefinition) Schema 

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

func (*QueryDefinition) UnmarshalHCL 

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

type Type 

type Type string

Source Files

View all Source files

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.