Documentation ¶
Index ¶
- Variables
- type ConfigMetadata
- type CustomEventFilter
- func (me *CustomEventFilter) MarshalHCL(properties hcl.Properties) error
- func (me *CustomEventFilter) MarshalJSON() ([]byte, error)
- func (me *CustomEventFilter) Schema() map[string]*schema.Schema
- func (me *CustomEventFilter) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *CustomEventFilter) UnmarshalJSON(data []byte) error
- type CustomTextFilter
- func (me *CustomTextFilter) MarshalHCL(properties hcl.Properties) error
- func (me *CustomTextFilter) MarshalJSON() ([]byte, error)
- func (me *CustomTextFilter) Schema() map[string]*schema.Schema
- func (me *CustomTextFilter) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *CustomTextFilter) UnmarshalJSON(data []byte) error
- type EventType
- type EventTypeFilter
- func (me *EventTypeFilter) MarshalHCL(properties hcl.Properties) error
- func (me *EventTypeFilter) MarshalJSON() ([]byte, error)
- func (me *EventTypeFilter) Schema() map[string]*schema.Schema
- func (me *EventTypeFilter) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *EventTypeFilter) UnmarshalJSON(data []byte) error
- type IncludeMode
- type Operator
- type PredefinedEventFilter
- func (me *PredefinedEventFilter) MarshalHCL(properties hcl.Properties) error
- func (me *PredefinedEventFilter) MarshalJSON() ([]byte, error)
- func (me *PredefinedEventFilter) Schema() map[string]*schema.Schema
- func (me *PredefinedEventFilter) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *PredefinedEventFilter) UnmarshalJSON(data []byte) error
- type Profile
- func (me *Profile) Deprecated() string
- func (me *Profile) EnsurePredictableOrder()
- func (me *Profile) MarshalHCL(properties hcl.Properties) error
- func (me *Profile) MarshalJSON() ([]byte, error)
- func (me *Profile) Schema() map[string]*schema.Schema
- func (me *Profile) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *Profile) UnmarshalJSON(data []byte) error
- type ProfileSeverityRule
- func (me *ProfileSeverityRule) EnsurePredictableOrder()
- func (me *ProfileSeverityRule) MarshalHCL(properties hcl.Properties) error
- func (me *ProfileSeverityRule) MarshalJSON() ([]byte, error)
- func (me *ProfileSeverityRule) Schema() map[string]*schema.Schema
- func (me *ProfileSeverityRule) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *ProfileSeverityRule) UnmarshalJSON(data []byte) error
- type ProfileTagFilter
- func (me *ProfileTagFilter) EnsurePredictableOrder()
- func (me *ProfileTagFilter) MarshalHCL(properties hcl.Properties) error
- func (me *ProfileTagFilter) MarshalJSON() ([]byte, error)
- func (me *ProfileTagFilter) Schema() map[string]*schema.Schema
- func (me *ProfileTagFilter) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *ProfileTagFilter) UnmarshalJSON(data []byte) error
- type SeverityLevel
Constants ¶
This section is empty.
Variables ¶
var EventTypes = struct { ApplicationErrorRateIncreased EventType ApplicationSlowdown EventType ApplicationUnexpectedHighLoad EventType ApplicationUnexpectedLowLoad EventType AWSLambdaHighErrorRate EventType CustomApplicationErrorRateIncreased EventType CustomApplicationSlowdown EventType CustomApplicationUnexpectedHighLoad EventType CustomApplicationUnexpectedLowLoad EventType CustomAppCrashRateIncreased EventType DatabaseConnectionFailure EventType DataCenterServicePerformanceDegradation EventType DataCenterServiceUnavailable EventType EbsVolumeHighLatency EventType EC2HighCPU EventType ElbHighBackendErrorRate EventType EnterpriceApplicationPerformanceDegradation EventType EnterpriseApplicationUnavailable EventType ESXIGuestActiveSwapWait EventType ESXIGuestCPULimitReached EventType ESXIHostCPUSaturation EventType ESXIHostDatastoreLowDiskSpace EventType ESXIHostDiskQueueSlow EventType ESXIHostDiskSlow EventType ESXIHostMemorySaturation EventType ESXIHostNetworkProblems EventType ESXIHostOverloadedStorage EventType ESXIVMImpactHostCPUSaturation EventType ESXIVMImpactHostMemorySaturation EventType ExternalSyntheticTestOutage EventType ExternalSyntheticTestSlowdown EventType HostOfServiceUnavailable EventType HTTPCheckGlobalOutage EventType HTTPCheckLocalOutage EventType HTTPCheckTestLocationSlowdown EventType MobileApplicationErrorRateIncreased EventType MobileApplicationSlowdown EventType MobileApplicationUnexpectedHighLoad EventType MobileApplicationUnexpectedLowLoad EventType MobileAppCrashRateIncreased EventType MonitoringUnavailable EventType OsiDiskLowInodes EventType OsiGracefullyShutdown EventType OsiHighCPU EventType OsiHighMemory EventType OsiLowDiskSpace EventType OsiNicDroppedPacketsHigh EventType OsiNicErrorsHigh EventType OsiNicUtilizationHigh EventType OsiSlowDisk EventType OsiUnexpectedlyUnavailable EventType PgiOfServiceUnavailable EventType PgiUnavailable EventType PgLowInstanceCount EventType ProcessCrashed EventType ProcessHighGcActivity EventType ProcessMemoryResourceExhausted EventType ProcessNaHighConnFailRate EventType ProcessNaHighLossRate EventType ProcessThreadsResourceExhausted EventType RdsHighCPU EventType RdsHighLatency EventType RdsLowMemory EventType RdsLowStorageSpace EventType RdsOfServiceUnavailable EventType RdsRestartSequence EventType ServiceErrorRateIncreased EventType ServiceSlowdown EventType ServiceUnexpectedHighLoad EventType ServiceUnexpectedLowLoad EventType SyntheticGlobalOutage EventType SyntheticLocalOutage EventType SyntheticNodeOutage EventType SyntheticPrivateLocationOutage EventType SyntheticTestLocationSlowdown EventType }{ "APPLICATION_ERROR_RATE_INCREASED", "APPLICATION_SLOWDOWN", "APPLICATION_UNEXPECTED_HIGH_LOAD", "APPLICATION_UNEXPECTED_LOW_LOAD", "AWS_LAMBDA_HIGH_ERROR_RATE", "CUSTOM_APPLICATION_ERROR_RATE_INCREASED", "CUSTOM_APPLICATION_SLOWDOWN", "CUSTOM_APPLICATION_UNEXPECTED_HIGH_LOAD", "CUSTOM_APPLICATION_UNEXPECTED_LOW_LOAD", "CUSTOM_APP_CRASH_RATE_INCREASED", "DATABASE_CONNECTION_FAILURE", "DATA_CENTER_SERVICE_PERFORMANCE_DEGRADATION", "DATA_CENTER_SERVICE_UNAVAILABLE", "EBS_VOLUME_HIGH_LATENCY", "EC2_HIGH_CPU", "ELB_HIGH_BACKEND_ERROR_RATE", "ENTERPRICE_APPLICATION_PERFORMANCE_DEGRADATION", "ENTERPRISE_APPLICATION_UNAVAILABLE", "ESXI_GUEST_ACTIVE_SWAP_WAIT", "ESXI_GUEST_CPU_LIMIT_REACHED", "ESXI_HOST_CPU_SATURATION", "ESXI_HOST_DATASTORE_LOW_DISK_SPACE", "ESXI_HOST_DISK_QUEUE_SLOW", "ESXI_HOST_DISK_SLOW", "ESXI_HOST_MEMORY_SATURATION", "ESXI_HOST_NETWORK_PROBLEMS", "ESXI_HOST_OVERLOADED_STORAGE", "ESXI_VM_IMPACT_HOST_CPU_SATURATION", "ESXI_VM_IMPACT_HOST_MEMORY_SATURATION", "EXTERNAL_SYNTHETIC_TEST_OUTAGE", "EXTERNAL_SYNTHETIC_TEST_SLOWDOWN", "HOST_OF_SERVICE_UNAVAILABLE", "HTTP_CHECK_GLOBAL_OUTAGE", "HTTP_CHECK_LOCAL_OUTAGE", "HTTP_CHECK_TEST_LOCATION_SLOWDOWN", "MOBILE_APPLICATION_ERROR_RATE_INCREASED", "MOBILE_APPLICATION_SLOWDOWN", "MOBILE_APPLICATION_UNEXPECTED_HIGH_LOAD", "MOBILE_APPLICATION_UNEXPECTED_LOW_LOAD", "MOBILE_APP_CRASH_RATE_INCREASED", "MONITORING_UNAVAILABLE", "OSI_DISK_LOW_INODES", "OSI_GRACEFULLY_SHUTDOWN", "OSI_HIGH_CPU", "OSI_HIGH_MEMORY", "OSI_LOW_DISK_SPACE", "OSI_NIC_DROPPED_PACKETS_HIGH", "OSI_NIC_ERRORS_HIGH", "OSI_NIC_UTILIZATION_HIGH", "OSI_SLOW_DISK", "OSI_UNEXPECTEDLY_UNAVAILABLE", "PGI_OF_SERVICE_UNAVAILABLE", "PGI_UNAVAILABLE", "PG_LOW_INSTANCE_COUNT", "PROCESS_CRASHED", "PROCESS_HIGH_GC_ACTIVITY", "PROCESS_MEMORY_RESOURCE_EXHAUSTED", "PROCESS_NA_HIGH_CONN_FAIL_RATE", "PROCESS_NA_HIGH_LOSS_RATE", "PROCESS_THREADS_RESOURCE_EXHAUSTED", "RDS_HIGH_CPU", "RDS_HIGH_LATENCY", "RDS_LOW_MEMORY", "RDS_LOW_STORAGE_SPACE", "RDS_OF_SERVICE_UNAVAILABLE", "RDS_RESTART_SEQUENCE", "SERVICE_ERROR_RATE_INCREASED", "SERVICE_SLOWDOWN", "SERVICE_UNEXPECTED_HIGH_LOAD", "SERVICE_UNEXPECTED_LOW_LOAD", "SYNTHETIC_GLOBAL_OUTAGE", "SYNTHETIC_LOCAL_OUTAGE", "SYNTHETIC_NODE_OUTAGE", "SYNTHETIC_PRIVATE_LOCATION_OUTAGE", "SYNTHETIC_TEST_LOCATION_SLOWDOWN", }
EventTypes offers the known enum values
var IncludeModes = struct { IncludeAll IncludeMode IncludeAny IncludeMode None IncludeMode }{ "INCLUDE_ALL", "INCLUDE_ANY", "NONE", }
IncludeModes offers the known enum values
var Operators = struct { BeginsWith Operator Contains Operator ContainsRegex Operator EndsWith Operator Equals Operator }{ "BEGINS_WITH", "CONTAINS", "CONTAINS_REGEX", "ENDS_WITH", "EQUALS", }
Operators offers the known enum values
var SeverityLevels = struct { Availability SeverityLevel CustomAlert SeverityLevel Error SeverityLevel MonitoringUnavailable SeverityLevel Performance SeverityLevel ResourceContention SeverityLevel }{ "AVAILABILITY", "CUSTOM_ALERT", "ERROR", "MONITORING_UNAVAILABLE", "PERFORMANCE", "RESOURCE_CONTENTION", }
SeverityLevels offers the known enum values
Functions ¶
This section is empty.
Types ¶
type ConfigMetadata ¶
type ConfigMetadata struct { ClusterVersion *string `json:"clusterVersion,omitempty"` // Dynatrace server version. ConfigurationVersions []int64 `json:"configurationVersions,omitempty"` // A Sorted list of the version numbers of the configuration. CurrentConfigurationVersions []string `json:"currentConfigurationVersions,omitempty"` // A Sorted list of string version numbers of the configuration. }
ConfigMetadata Metadata useful for debugging
func (*ConfigMetadata) MarshalHCL ¶
func (me *ConfigMetadata) MarshalHCL(properties hcl.Properties) error
func (*ConfigMetadata) UnmarshalHCL ¶
func (me *ConfigMetadata) UnmarshalHCL(decoder hcl.Decoder) error
type CustomEventFilter ¶
type CustomEventFilter struct { Description *CustomTextFilter `json:"customDescriptionFilter,omitempty"` // Configuration of a matching filter. Title *CustomTextFilter `json:"customTitleFilter,omitempty"` // Configuration of a matching filter. Unknowns map[string]json.RawMessage `json:"-"` }
CustomEventFilter Configuration of a custom event filter. Filters custom events by title or description. If both specified, the AND logic applies.
func (*CustomEventFilter) MarshalHCL ¶
func (me *CustomEventFilter) MarshalHCL(properties hcl.Properties) error
func (*CustomEventFilter) MarshalJSON ¶
func (me *CustomEventFilter) MarshalJSON() ([]byte, error)
func (*CustomEventFilter) UnmarshalHCL ¶
func (me *CustomEventFilter) UnmarshalHCL(decoder hcl.Decoder) error
func (*CustomEventFilter) UnmarshalJSON ¶
func (me *CustomEventFilter) UnmarshalJSON(data []byte) error
type CustomTextFilter ¶
type CustomTextFilter struct { Enabled bool `json:"enabled"` // The filter is enabled (`true`) or disabled (`false`). Negate bool `json:"negate"` // Reverses the comparison **operator**. For example it turns the **begins with** into **does not begin with**. Operator Operator `json:"operator"` // Operator of the comparison. You can reverse it by setting **negate** to `true`. Value string `json:"value"` // The value to compare to. CaseInsensitive bool `json:"caseInsensitive"` // The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive. Unknowns map[string]json.RawMessage `json:"-"` }
CustomTextFilter Configuration of a matching filter.
func (*CustomTextFilter) MarshalHCL ¶
func (me *CustomTextFilter) MarshalHCL(properties hcl.Properties) error
func (*CustomTextFilter) MarshalJSON ¶
func (me *CustomTextFilter) MarshalJSON() ([]byte, error)
func (*CustomTextFilter) UnmarshalHCL ¶
func (me *CustomTextFilter) UnmarshalHCL(decoder hcl.Decoder) error
func (*CustomTextFilter) UnmarshalJSON ¶
func (me *CustomTextFilter) UnmarshalJSON(data []byte) error
type EventTypeFilter ¶
type EventTypeFilter struct { CustomEventFilter *CustomEventFilter `json:"customEventFilter,omitempty"` // Configuration of a custom event filter. Filters custom events by title or description. If both specified, the AND logic applies. PredefinedEventFilter *PredefinedEventFilter `json:"predefinedEventFilter,omitempty"` // Configuration of a predefined event filter. Unknowns map[string]json.RawMessage `json:"-"` }
EventTypeFilter Configuration of the event filter for the alerting profile. You have two mutually exclusive options: * Select an event type from the list of the predefined events. Specify it in the **predefinedEventFilter** field. * Set a rule for custom events. Specify it in the **customEventFilter** field.
func (*EventTypeFilter) MarshalHCL ¶
func (me *EventTypeFilter) MarshalHCL(properties hcl.Properties) error
func (*EventTypeFilter) MarshalJSON ¶
func (me *EventTypeFilter) MarshalJSON() ([]byte, error)
func (*EventTypeFilter) UnmarshalHCL ¶
func (me *EventTypeFilter) UnmarshalHCL(decoder hcl.Decoder) error
func (*EventTypeFilter) UnmarshalJSON ¶
func (me *EventTypeFilter) UnmarshalJSON(data []byte) error
type IncludeMode ¶
type IncludeMode string
IncludeMode The filtering mode: * `INCLUDE_ANY`: The rule applies to monitored entities that have at least one of the specified tags. You can specify up to 100 tags. * `INCLUDE_ALL`: The rule applies to monitored entities that have **all** of the specified tags. You can specify up to 10 tags. * `NONE`: The rule applies to all monitored entities.
type Operator ¶
type Operator string
Operator Operator of the comparison.
You can reverse it by setting **negate** to `true`.
type PredefinedEventFilter ¶
type PredefinedEventFilter struct { EventType EventType `json:"eventType"` // The type of the predefined event. Negate bool `json:"negate"` // The alert triggers when the problem of specified severity arises while the specified event **is** happening (`false`) or while the specified event is **not** happening (`true`). For example, if you chose the Slowdown (`PERFORMANCE`) severity and Unexpected high traffic (`APPLICATION_UNEXPECTED_HIGH_LOAD`) event with **negate** set to `true`, the alerting profile will trigger only when the slowdown problem is raised while there is no unexpected high traffic event. Consider the following use case as an example. The Slowdown (`PERFORMANCE`) severity rule is set. Depending on the configuration of the event filter (Unexpected high traffic (`APPLICATION_UNEXPECTED_HIGH_LOAD`) event is used as an example), the behavior of the alerting profile is one of the following:* **negate** is set to `false`: The alert triggers when the slowdown problem is raised while unexpected high traffic event is happening. * **negate** is set to `true`: The alert triggers when the slowdown problem is raised while there is no unexpected high traffic event. * no event rule is set: The alert triggers when the slowdown problem is raised, regardless of any events. Unknowns map[string]json.RawMessage `json:"-"` }
PredefinedEventFilter Configuration of a predefined event filter.
func (*PredefinedEventFilter) MarshalHCL ¶
func (me *PredefinedEventFilter) MarshalHCL(properties hcl.Properties) error
func (*PredefinedEventFilter) MarshalJSON ¶
func (me *PredefinedEventFilter) MarshalJSON() ([]byte, error)
func (*PredefinedEventFilter) Schema ¶
func (me *PredefinedEventFilter) Schema() map[string]*schema.Schema
func (*PredefinedEventFilter) UnmarshalHCL ¶
func (me *PredefinedEventFilter) UnmarshalHCL(decoder hcl.Decoder) error
func (*PredefinedEventFilter) UnmarshalJSON ¶
func (me *PredefinedEventFilter) UnmarshalJSON(data []byte) error
type Profile ¶
type Profile struct { ID *string `json:"id,omitempty"` // The ID of the alerting profile. DisplayName string `json:"displayName"` // The name of the alerting profile, displayed in the UI. MzID *string `json:"mzId,omitempty"` // The ID of the management zone to which the alerting profile applies. Rules []*ProfileSeverityRule `json:"rules,omitempty"` // A list of severity rules. The rules are evaluated from top to bottom. The first matching rule applies and further evaluation stops. If you specify both severity rule and event filter, the AND logic applies. EventTypeFilters []*EventTypeFilter `json:"eventTypeFilters,omitempty"` // The list of event filters. For all filters that are *negated* inside of these event filters, that is all "Predefined" as well as "Custom" (Title and/or Description) ones the AND logic applies. For all *non-negated* ones the OR logic applies. Between these two groups, negated and non-negated, the AND logic applies. If you specify both severity rule and event filter, the AND logic applies. Metadata *ConfigMetadata `json:"metadata,omitempty"` // Metadata useful for debugging Unknowns map[string]json.RawMessage `json:"-"` }
Profile Configuration of an alerting profile.
func (*Profile) Deprecated ¶ added in v1.36.0
func (*Profile) EnsurePredictableOrder ¶
func (me *Profile) EnsurePredictableOrder()
func (*Profile) MarshalHCL ¶
func (me *Profile) MarshalHCL(properties hcl.Properties) error
func (*Profile) MarshalJSON ¶
func (*Profile) UnmarshalJSON ¶
type ProfileSeverityRule ¶
type ProfileSeverityRule struct { TagFilter *ProfileTagFilter `json:"tagFilter"` // Configuration of the tag filtering of the alerting profile. DelayInMinutes int32 `json:"delayInMinutes"` // Send a notification if a problem remains open longer than *X* minutes. SeverityLevel SeverityLevel `json:"severityLevel"` // The severity level to trigger the alert. Unknowns map[string]json.RawMessage `json:"-"` }
ProfileSeverityRule A severity rule of the alerting profile.
A severity rule defines the level of severity that must be met before an alert is sent our for a detected problem. Additionally it restricts the alerting to certain monitored entities.
func (*ProfileSeverityRule) EnsurePredictableOrder ¶
func (me *ProfileSeverityRule) EnsurePredictableOrder()
func (*ProfileSeverityRule) MarshalHCL ¶
func (me *ProfileSeverityRule) MarshalHCL(properties hcl.Properties) error
func (*ProfileSeverityRule) MarshalJSON ¶
func (me *ProfileSeverityRule) MarshalJSON() ([]byte, error)
func (*ProfileSeverityRule) Schema ¶
func (me *ProfileSeverityRule) Schema() map[string]*schema.Schema
func (*ProfileSeverityRule) UnmarshalHCL ¶
func (me *ProfileSeverityRule) UnmarshalHCL(decoder hcl.Decoder) error
func (*ProfileSeverityRule) UnmarshalJSON ¶
func (me *ProfileSeverityRule) UnmarshalJSON(data []byte) error
type ProfileTagFilter ¶
type ProfileTagFilter struct { IncludeMode IncludeMode `json:"includeMode"` // The filtering mode: * `INCLUDE_ANY`: The rule applies to monitored entities that have at least one of the specified tags. You can specify up to 100 tags. * `INCLUDE_ALL`: The rule applies to monitored entities that have **all** of the specified tags. You can specify up to 10 tags. * `NONE`: The rule applies to all monitored entities. TagFilters []*common.TagFilter `json:"tagFilters,omitempty"` // A list of required tags. Unknowns map[string]json.RawMessage `json:"-"` }
ProfileTagFilter Configuration of the tag filtering of the alerting profile.
func (*ProfileTagFilter) EnsurePredictableOrder ¶
func (me *ProfileTagFilter) EnsurePredictableOrder()
func (*ProfileTagFilter) MarshalHCL ¶
func (me *ProfileTagFilter) MarshalHCL(properties hcl.Properties) error
func (*ProfileTagFilter) MarshalJSON ¶
func (me *ProfileTagFilter) MarshalJSON() ([]byte, error)
func (*ProfileTagFilter) UnmarshalHCL ¶
func (me *ProfileTagFilter) UnmarshalHCL(decoder hcl.Decoder) error
func (*ProfileTagFilter) UnmarshalJSON ¶
func (me *ProfileTagFilter) UnmarshalJSON(data []byte) error
type SeverityLevel ¶
type SeverityLevel string
SeverityLevel The severity level to trigger the alert.