metricevents

Documentation

Index

• Variables
• type AggregationType
  • func (me AggregationType) Ref() *AggregationType
• type DisabledReason
  • func (me DisabledReason) Ref() *DisabledReason
• type MetricEvent
  • func (me *MetricEvent) MarshalHCL(properties hcl.Properties) error
  • func (me *MetricEvent) MarshalJSON() ([]byte, error)
  • func (me *MetricEvent) Schema() map[string]*schema.Schema
  • func (me *MetricEvent) UnmarshalHCL(decoder hcl.Decoder) error
  • func (me *MetricEvent) UnmarshalJSON(data []byte) error
• type Severity
  • func (me Severity) Ref() *Severity
• type WarningReason
  • func (me WarningReason) Ref() *WarningReason

Variables

var AggregationTypes = struct {
	Avg    AggregationType
	Count  AggregationType
	Max    AggregationType
	Median AggregationType
	Min    AggregationType
	P90    AggregationType
	Sum    AggregationType
	Value  AggregationType
}{
	"AVG",
	"COUNT",
	"MAX",
	"MEDIAN",
	"MIN",
	"P90",
	"SUM",
	"VALUE",
}

AggregationTypes offers the known enum values

var DisabledReasons = struct {
	MetricDefinitionInconsistency DisabledReason
	None                          DisabledReason
	TooManyDims                   DisabledReason
	TopxForciblyDeactivated       DisabledReason
}{
	"METRIC_DEFINITION_INCONSISTENCY",
	"NONE",
	"TOO_MANY_DIMS",
	"TOPX_FORCIBLY_DEACTIVATED",
}

DisabledReasons offers the known enum values

var Severitys = struct {
	Availability       Severity
	CustomAlert        Severity
	Error              Severity
	Info               Severity
	Performance        Severity
	ResourceContention Severity
}{
	"AVAILABILITY",
	"CUSTOM_ALERT",
	"ERROR",
	"INFO",
	"PERFORMANCE",
	"RESOURCE_CONTENTION",
}

Severitys offers the known enum values

var WarningReasons = struct {
	None        WarningReason
	TooManyDims WarningReason
}{
	"NONE",
	"TOO_MANY_DIMS",
}

WarningReasons offers the known enum values

Types

type AggregationType

type AggregationType string

AggregationType How the metric data points are aggregated for the evaluation.

The timeseries must support this aggregation.

func (AggregationType) Ref

func (me AggregationType) Ref() *AggregationType

type DisabledReason

type DisabledReason string

DisabledReason The reason of automatic disabling. The `NONE` means config was not disabled automatically.

func (DisabledReason) Ref

func (me DisabledReason) Ref() *DisabledReason

type MetricEvent

type MetricEvent struct {
	MetricID            *string                     `json:"metricId"`                      // The ID of the metric evaluated by the metric event.
	AggregationType     *AggregationType            `json:"aggregationType,omitempty"`     // How the metric data points are aggregated for the evaluation.   The timeseries must support this aggregation.
	Description         string                      `json:"description"`                   // The description of the metric event.
	Name                string                      `json:"name"`                          // The name of the metric event displayed in the UI.
	WarningReason       *WarningReason              `json:"warningReason,omitempty"`       // The reason of a warning set on the config.  The `NONE` means config has no warnings.
	MetricDimensions    dimensions.Dimensions       `json:"metricDimensions,omitempty"`    // Defines the dimensions of the metric to alert on. The filters are combined by conjunction.
	DisabledReason      *DisabledReason             `json:"disabledReason,omitempty"`      // The reason of automatic disabling.  The `NONE` means config was not disabled automatically.
	Enabled             bool                        `json:"enabled"`                       // The metric event is enabled (`true`) or disabled (`false`).
	AlertingScope       scope.AlertingScopes        `json:"alertingScope,omitempty"`       // Defines the scope of the metric event. Only one filter is allowed per filter type, except for tags, where up to 3 are allowed. The filters are combined by conjunction.
	MonitoringStrategy  strategy.MonitoringStrategy `json:"monitoringStrategy"`            // A monitoring strategy for a metric event config. This is the base version of the monitoring strategy, depending on the type,  the actual JSON may contain additional fields.
	PrimaryDimensionKey *string                     `json:"primaryDimensionKey,omitempty"` // Defines which dimension key should be used for the **alertingScope**.
	Severity            *Severity                   `json:"severity,omitempty"`            // The type of the event to trigger on the threshold violation.  The `CUSTOM_ALERT` type is not correlated with other alerts. The `INFO` type does not open a problem.
	MetricSelector      *string                     `json:"metricSelector,omitempty"`      // The metric selector that should be executed
	Unknowns            map[string]json.RawMessage  `json:"-"`
}

MetricEvent The configuration of the metric event.

func (*MetricEvent) MarshalHCL

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

func (*MetricEvent) MarshalJSON

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

func (*MetricEvent) Schema

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

func (*MetricEvent) UnmarshalHCL

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

func (*MetricEvent) UnmarshalJSON

func (me *MetricEvent) UnmarshalJSON(data []byte) error

type Severity

type Severity string

Severity The type of the event to trigger on the threshold violation. The `CUSTOM_ALERT` type is not correlated with other alerts. The `INFO` type does not open a problem.

func (Severity) Ref

func (me Severity) Ref() *Severity

type WarningReason

type WarningReason string

WarningReason The reason of a warning set on the config. The `NONE` means config has no warnings.

func (WarningReason) Ref

func (me WarningReason) Ref() *WarningReason