shared

Documentation

Overview

Shared definitions (constants & errors) for opni alerting

Index

• Constants
• Variables
• func AlertManagerLabelsToAnnotations(m *labels.Matcher) (map[string]string, error)
• func DefaultAlertManagerConfig(managementUrl string) (bytes.Buffer, error)
• func LabelWithAlert(label map[string]string) map[string]string
• func NewAlertingRefId(prefixes ...string) string
• func NewOpniReceiverName(id OpniReceiverId) string
• func WithFailedPreconditionError(msg string) error
• func WithFailedPreconditionErrorf(format string, args ...interface{}) error
• func WithInternalServerError(msg string) error
• func WithInternalServerErrorf(format string, args ...interface{}) error
• func WithNotFoundError(msg string) error
• func WithNotFoundErrorf(format string, args ...interface{}) error
• func WithUnimplementedError(msg string) error
• func WithUnimplementedErrorf(format string, args ...interface{}) error
• type AlertingClusterNotification
• type AlertingClusterOptions
  • func (a *AlertingClusterOptions) GetControllerEndpoint() string
  • func (a *AlertingClusterOptions) GetInternalControllerOpniEndpoint() string
  • func (a *AlertingClusterOptions) GetInternalWorkerOpniEndpoint() string
  • func (a *AlertingClusterOptions) GetWorkerEndpoint() string
• type DefaultAlertManagerInfo
• type FailedPreconditionError
  • func (e *FailedPreconditionError) Error() string
  • func (e *FailedPreconditionError) GRPCStatus() *status.Status
• type InternalServerError
  • func (e *InternalServerError) Error() string
  • func (e *InternalServerError) GRPCStatus() *status.Status
• type NotFoundError
  • func (e *NotFoundError) Error() string
  • func (e *NotFoundError) GRPCStatus() *status.Status
• type OpniReceiverId
  • func ExtractReceiverId(receiverName string) (*OpniReceiverId, error)
• type UnimplementedError
  • func (e *UnimplementedError) Error() string
  • func (e *UnimplementedError) GRPCStatus() *status.Status

Constants

const (
	AlertingV1Alpha      = "v1alpha"
	MonitoringDatasource = "monitoring"
	LoggingDatasource    = "logging"
	SystemDatasource     = "system"
)

const (
	ConfigMountPath                        = "/etc/config"
	DataMountPath                          = "/var/lib"
	AlertManagerConfigKey                  = "alertmanager.yaml"
	InternalRoutingConfigKey               = "internal-routing.yaml"
	OperatorAlertingControllerServiceName  = "opni-alerting-controller"
	OperatorAlertingClusterNodeServiceName = "opni-alerting"
	AlertingHookReceiverName               = "opni.default.hook"
	AlertingDefaultHookName                = "/opni/hook"
	AlertingDefaultHookPort                = 3000
)

const (
	// global streams
	AgentClusterHealthStatusStream        = "agent-cluster-health-status"
	AgentClusterHealthStatusSubjects      = "agent-cluster-health-status.*"
	AgentClusterHealthStatusDurableReplay = "agent-cluster-health-status-consumer"

	//streams
	AgentDisconnectStream         = "opni_alerting_agent"
	AgentDisconnectStreamSubjects = "opni_alerting_agent.*"
	AgentHealthStream             = "opni_alerting_health"
	AgentHealthStreamSubjects     = "opni_alerting_health.*"
	CortexStatusStream            = "opni_alerting_cortex_status"
	CortexStatusStreamSubjects    = "opni_alerting_cortex_status.*"
	// buckets
	AlertingConditionBucket            = "opni-alerting-condition-bucket"
	AlertingEndpointBucket             = "opni-alerting-endpoint-bucket"
	AgentDisconnectBucket              = "opni-alerting-agent-bucket"
	AgentStatusBucket                  = "opni-alerting-agent-status-bucket"
	StatusBucketPerCondition           = "opni-alerting-condition-status-bucket"
	StatusBucketPerClusterInternalType = "opni-alerting-cluster-condition-type-status-bucket"
	GeneralIncidentStorage             = "opni-alerting-general-incident-bucket"
	RouterStorage                      = "opni-alerting-router-bucket"
)

Jetstream streams

const AgentDisconnectStorageType = "agent-disconnect"

const BackendConditionClusterIdLabel = "clusterId"

const BackendConditionIdLabel = "conditionId"

const BackendConditionNameLabel = "opniname"

const BackendConditionSeverityLabel = "severity"

const BroadcastIdLabel = "broadcastId"

const CortexCompactor = "compactor"

const CortexDistributor = "distributor"

const CortexIngester = "ingester"

const CortexPurger = "purger"

const CortexQuerier = "querier"

const CortexQueryFrontend = "query-frontend"

const CortexRuler = "ruler"

const CortexStoreGateway = "store-gateway"

const InternalDiscordId = "discord"

const InternalEmailId = "email"

const InternalOpsGenieId = "opsgenie"

const InternalPagerdutyId = "pagerduty"

const InternalPushoverId = "pushover"

const InternalSNSId = "sns"

const InternalSlackId = "slack"

const InternalTelegramId = "telegram"

const InternalVictorOpsId = "victorops"

const InternalWebhookId = "webhook"

const InternalWechatId = "wechat"

const OpniAlarmNameAnnotation = "OpniAlarmName"

const OpniAlertingCortexNamespace = "opni-alerting"

const OpniBodyAnnotations = "OpniSummary"

const OpniBodyLabel = "OpniBodyLabel"

const OpniClusterAnnotation = "OpniCluster"

const OpniDatasourceLabel = "OpniDatasource"

const OpniDatasourceMetrics = "metrics"

const OpniGoldenSignalAnnotation = "OpniGoldenSignal"

const OpniHeaderAnnotations = "OpniHeader"

const OpniSeverityLabel = "OpniSeverity"

const OpniTitleLabel = "OpniTitleLabel"

labels

const OpniUnbufferedKey = "OpniGroupKey"

const SingleConfigId = "global"

Variables

var (
	PublicLabels        = map[string]string{}
	PublicServiceLabels = map[string]string{}
)

var (
	AlertingErrNotImplemented           = WithUnimplementedError("Not implemented")
	AlertingErrNotImplementedNOOP       = WithUnimplementedError("Alerting NOOP : Not implemented")
	AlertingErrParseBucket              = WithInternalServerError("Failed to parse bucket index")
	AlertingErrBucketIndexInvalid       = WithInternalServerError("Bucket index is invalid")
	AlertingErrInvalidSlackChannel      = validation.Error("Slack channel invalid : must start with '#'")
	AlertingErrK8sRuntime               = WithInternalServerError("K8s Runtime error")
	AlertingErrMismatchedImplementation = validation.Error("Alerting endpoint did not match the given implementation")
)

var ComparisonOperators = []string{"<", ">", "<=", ">=", "=", "!="}

Condition constants

var CortexComponents = []string{
	CortexDistributor,
	CortexIngester,
	CortexRuler,
	CortexPurger,
	CortexCompactor,
	CortexStoreGateway,
	CortexQueryFrontend,
	CortexQuerier,
}

var DefaultAlertManager = template.Must(template.New("DefaultManagementHook").Parse(strings.Join([]string{
	strings.TrimSpace(route),
	receivers,
	strings.TrimSpace(inihibit_rules),
}, "\n")))

var KubeStates = []string{"Pending", "Running", "Succeeded", "Failed", "Unknown"}

var OpniGroupByClause = []model.LabelName{
	"alertname",
}

var OpniMetricsSubRoutingTreeMatcher *labels.Matcher = &labels.Matcher{
	Type:  labels.MatchEqual,
	Name:  OpniDatasourceLabel,
	Value: OpniDatasourceMetrics,
}

var OpniSeverityTreeMatcher *labels.Matcher = &labels.Matcher{
	Type:  labels.MatchEqual,
	Name:  OpniSeverityLabel,
	Value: "true",
}

var OpniSubRoutingTreeMatcher *labels.Matcher = &labels.Matcher{
	Type:  labels.MatchEqual,
	Name:  OpniDatasourceLabel,
	Value: "",
}

Functions

func AlertManagerLabelsToAnnotations

func AlertManagerLabelsToAnnotations(m *labels.Matcher) (map[string]string, error)

func DefaultAlertManagerConfig

func DefaultAlertManagerConfig(managementUrl string) (bytes.Buffer, error)

func LabelWithAlert

func LabelWithAlert(label map[string]string) map[string]string

func NewAlertingRefId

func NewAlertingRefId(prefixes ...string) string

func NewOpniReceiverName

func NewOpniReceiverName(id OpniReceiverId) string

func WithFailedPreconditionError

func WithFailedPreconditionError(msg string) error

func WithFailedPreconditionErrorf

func WithFailedPreconditionErrorf(format string, args ...interface{}) error

func WithInternalServerError

func WithInternalServerError(msg string) error

func WithInternalServerErrorf

func WithInternalServerErrorf(format string, args ...interface{}) error

func WithNotFoundError

func WithNotFoundError(msg string) error

func WithNotFoundErrorf

func WithNotFoundErrorf(format string, args ...interface{}) error

func WithUnimplementedError

func WithUnimplementedError(msg string) error

func WithUnimplementedErrorf

func WithUnimplementedErrorf(format string, args ...interface{}) error

Types

type AlertingClusterNotification

type AlertingClusterNotification lo.Tuple2[bool, *AlertingClusterOptions]

type AlertingClusterOptions

type AlertingClusterOptions struct {
	Namespace             string
	WorkerNodesService    string
	WorkerNodePort        int
	WorkerStatefulSet     string
	ControllerNodeService string
	ControllerNodePort    int
	ControllerClusterPort int
	ControllerStatefulSet string
	ConfigMap             string
	ManagementHookHandler string
}

func (*AlertingClusterOptions) GetControllerEndpoint

func (a *AlertingClusterOptions) GetControllerEndpoint() string

func (*AlertingClusterOptions) GetInternalControllerOpniEndpoint

func (a *AlertingClusterOptions) GetInternalControllerOpniEndpoint() string

func (*AlertingClusterOptions) GetInternalWorkerOpniEndpoint

func (a *AlertingClusterOptions) GetInternalWorkerOpniEndpoint() string

func (*AlertingClusterOptions) GetWorkerEndpoint

func (a *AlertingClusterOptions) GetWorkerEndpoint() string

type DefaultAlertManagerInfo

type DefaultAlertManagerInfo struct {
	CortexHandlerName string
	CortexHandlerURL  string
}

type FailedPreconditionError

type FailedPreconditionError struct {
	// contains filtered or unexported fields
}

func (*FailedPreconditionError) Error

func (e *FailedPreconditionError) Error() string

func (*FailedPreconditionError) GRPCStatus

func (e *FailedPreconditionError) GRPCStatus() *status.Status

type InternalServerError

type InternalServerError struct {
	// contains filtered or unexported fields
}

func (*InternalServerError) Error

func (e *InternalServerError) Error() string

func (*InternalServerError) GRPCStatus

func (e *InternalServerError) GRPCStatus() *status.Status

type NotFoundError

type NotFoundError struct {
	// contains filtered or unexported fields
}

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

func (*NotFoundError) GRPCStatus

func (e *NotFoundError) GRPCStatus() *status.Status

type OpniReceiverId

type OpniReceiverId struct {
	Namespace  string
	ReceiverId string
}

func ExtractReceiverId

func ExtractReceiverId(receiverName string) (*OpniReceiverId, error)

type UnimplementedError

type UnimplementedError struct {
	// contains filtered or unexported fields
}

func (*UnimplementedError) Error

func (e *UnimplementedError) Error() string

func (*UnimplementedError) GRPCStatus

func (e *UnimplementedError) GRPCStatus() *status.Status