sumologic

package

v1.2.0 Latest Latest Go to latest Published: May 18, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/OpenSLO/slogen

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func FillBurnRateAlert(c oslo.AlertConditionSpec, m *SLOMonitor) error
func FillSLIAlert(c oslo.AlertConditionSpec, m *SLOMonitor) error
func GenSLOMonitorsFromAPNames(apMap map[string]oslo.AlertPolicy, ...) (string, error)
func GiveMonitorTerraform(mons []SLOMonitor) (string, error)
func GiveSLOMonitorTerraform(apMap map[string]oslo.AlertPolicy, ...) (string, error)
func GiveSLOTerraform(s specs.OpenSLOSpec) (string, error)
func GiveTerraform(apMap map[string]oslo.AlertPolicy, ...) (string, string, error)
func IsSource(slo specs.OpenSLOSpec) bool
type NotifyConnection
type NotifyEmail
type SLO
- func ConvertToSumoSLO(slo specs.OpenSLOSpec) (*SLO, error)
- func (s SLO) TFResourceName() string
type SLOFolder
type SLOMonitor
- func ConvertToSumoMonitor(ap oslo.AlertPolicy, slo *SLO, ...) ([]SLOMonitor, error)
- func MergeMonitors(mons []SLOMonitor) []SLOMonitor
- func (s SLOMonitor) TFResourceName() string

Constants ¶

View Source

const (
	MonitorKindBurnRate    = "BurnRate"
	MonitorKindSLI         = "SLI"
	ComplianceTypeCalendar = "Calendar"
	ComplianceTypeRolling  = "Rolling"
)

View Source

const (
	AnnotationMonitorFolderID           = "sumologic/monitor-folder-id"
	AnnotationSLOFolderID               = "sumologic/slo-folder-id"
	AnnotationTFResourceName            = "sumologic/tf-resource-name"
	AnnotationSignalType                = "sumologic/signal-type"
	AnnotationEmailRecipients           = "recipients"
	AnnotationEmailSubject              = "subject"
	AnnotationEmailBody                 = "message_body"
	AnnotationEmailTimeZone             = "timezone"
	AnnotationRunForTriggers            = "run_for_triggers"
	AnnotationConnectionID              = "connection_id"
	AnnotationConnectionType            = "connection_type"
	AnnotationPayloadOverride           = "payload_override"
	AnnotationResolutionPayloadOverride = "resolution_payload_override"
	AlertConditionTypeBurnRate          = "burnrate"
	AlertConditionTypeSLI               = "sli"
)

View Source

const (
	SourceTypeLogs    = "sumologic-logs"
	SourceTypeMetrics = "sumologic-metrics"
)

View Source

const (
	SLOTmplName        = "slo.tf.gotf"
	SLOFolderTmplName  = "slo-folders.tf.gotf"
	SLOMonitorTmplName = "slo-monitors.tf.gotf"
)

Variables ¶

This section is empty.

Functions ¶

func FillBurnRateAlert ¶

func FillBurnRateAlert(c oslo.AlertConditionSpec, m *SLOMonitor) error

func FillSLIAlert ¶

func FillSLIAlert(c oslo.AlertConditionSpec, m *SLOMonitor) error

func GenSLOMonitorsFromAPNames ¶

func GenSLOMonitorsFromAPNames(apMap map[string]oslo.AlertPolicy, ntMap map[string]oslo.AlertNotificationTarget,
	sumoSLO *SLO, slo oslo.SLO) (string, error)

func GiveMonitorTerraform ¶

func GiveMonitorTerraform(mons []SLOMonitor) (string, error)

func GiveSLOMonitorTerraform ¶ added in v1.0.2

func GiveSLOMonitorTerraform(apMap map[string]oslo.AlertPolicy, ntMap map[string]oslo.AlertNotificationTarget,
	slo specs.OpenSLOSpec) (string, error)

func GiveSLOTerraform ¶

func GiveSLOTerraform(s specs.OpenSLOSpec) (string, error)

func GiveTerraform ¶ added in v1.0.2

func GiveTerraform(apMap map[string]oslo.AlertPolicy, ntMap map[string]oslo.AlertNotificationTarget,
	slo specs.OpenSLOSpec) (string, string, error)

func IsSource ¶ added in v1.0.2

func IsSource(slo specs.OpenSLOSpec) bool

Types ¶

type NotifyConnection ¶

type NotifyConnection struct {
	ID                        string
	Type                      string
	RunForTriggers            []string
	PayloadOverride           string
	ResolutionPayloadOverride string
}

type NotifyEmail ¶

type NotifyEmail struct {
	Recipients     []string
	Subject        string
	Body           string
	TimeZone       string
	RunForTriggers []string
}

type SLO ¶

type SLO struct {
	*sumotf.SLOLibrarySLO
}

func ConvertToSumoSLO ¶

func ConvertToSumoSLO(slo specs.OpenSLOSpec) (*SLO, error)

func (SLO) TFResourceName ¶

func (s SLO) TFResourceName() string

type SLOFolder ¶

type SLOFolder struct {
	*sumotf.SLOLibraryFolder
}

type SLOMonitor ¶

type SLOMonitor struct {
	Service                   string
	SLOName                   string
	FolderID                  string
	SloID                     string
	ParentID                  string
	MonitorName               string
	EvaluationDelay           string
	TriggerType               string
	SliThresholdWarning       float64
	SliThresholdCritical      float64
	TimeRangeWarning          string
	TimeRangeCritical         string
	BurnRateThresholdWarning  float64
	BurnRateThresholdCritical float64
	NotifyEmails              []NotifyEmail
	NotifyConnections         []NotifyConnection
}

func ConvertToSumoMonitor ¶

func ConvertToSumoMonitor(ap oslo.AlertPolicy, slo *SLO, notifyMap map[string]oslo.AlertNotificationTarget) ([]SLOMonitor, error)

func MergeMonitors ¶

func MergeMonitors(mons []SLOMonitor) []SLOMonitor

MergeMonitors merges multiple OpenSLO monitors critical & warning into one sumo monitor based on the name of the monitor.

func (SLOMonitor) TFResourceName ¶

func (s SLOMonitor) TFResourceName() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
sumotf

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