Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterCondition(typeName string, factory ConditionFactory)
- func RegisterNotifier(plugin *NotifierPlugin)
- type AlertEngine
- type AlertTestCommand
- type Condition
- type ConditionFactory
- type ConditionResult
- type DashAlertExtractor
- type DatasourceAlertUsage
- type DefaultEvalHandler
- type ElementType
- type EvalContext
- func (c *EvalContext) GetDashboardUID() (*models.DashboardRef, error)
- func (c *EvalContext) GetDurationMs() float64
- func (c *EvalContext) GetNewState() models.AlertStateType
- func (c *EvalContext) GetNotificationTitle() string
- func (c *EvalContext) GetRuleURL() (string, error)
- func (c *EvalContext) GetStateModel() *StateDescription
- type EvalMatch
- type InputType
- type Job
- type NotificationTestCommand
- type Notifier
- type NotifierFactory
- type NotifierOption
- type NotifierPlugin
- type ResultLogEntry
- type Rule
- type SelectOption
- type ShowWhen
- type StateDescription
- type Ticker
- type UsageStats
- type UsageStatsQuerier
- type ValidationError
Constants ¶
const ( // InputTypeText will render a text field in the frontend InputTypeText = "text" // InputTypePassword will render a text field in the frontend InputTypePassword = "password" )
const ( // ElementTypeInput will render an input ElementTypeInput = "input" // ElementTypeSelect will render a select ElementTypeSelect = "select" // ElementTypeCheckbox will render a checkbox ElementTypeCheckbox = "checkbox" // ElementTypeTextArea will render a textarea ElementTypeTextArea = "textarea" )
Variables ¶
var ( // ErrFrequencyCannotBeZeroOrLess frequency cannot be below zero ErrFrequencyCannotBeZeroOrLess = errors.New(`"evaluate every" cannot be zero or below`) // ErrFrequencyCouldNotBeParsed frequency cannot be parsed ErrFrequencyCouldNotBeParsed = errors.New(`"evaluate every" field could not be parsed`) )
Functions ¶
func RegisterCondition ¶
func RegisterCondition(typeName string, factory ConditionFactory)
RegisterCondition adds support for alerting conditions.
func RegisterNotifier ¶
func RegisterNotifier(plugin *NotifierPlugin)
RegisterNotifier register an notifier
Types ¶
type AlertEngine ¶
type AlertEngine struct {
RenderService rendering.Service `inject:""`
Bus bus.Bus `inject:""`
RequestValidator models.PluginRequestValidator `inject:""`
// contains filtered or unexported fields
}
AlertEngine is the background process that schedules alert evaluations and makes sure notifications are sent.
func (*AlertEngine) IsDisabled ¶
func (e *AlertEngine) IsDisabled() bool
IsDisabled returns true if the alerting service is disable for this instance.
func (*AlertEngine) QueryUsageStats ¶
func (e *AlertEngine) QueryUsageStats() (*UsageStats, error)
QueryUsageStats returns usage stats about alert rules configured in Grafarg.
type AlertTestCommand ¶
type AlertTestCommand struct {
Dashboard *simplejson.Json
PanelID int64
OrgID int64
User *models.SignedInUser
Result *EvalContext
}
AlertTestCommand initiates an test evaluation of an alert rule.
type Condition ¶
type Condition interface {
Eval(result *EvalContext) (*ConditionResult, error)
}
Condition is responsible for evaluating an alert condition.
type ConditionFactory ¶
type ConditionFactory func(model *simplejson.Json, index int) (Condition, error)
ConditionFactory is the function signature for creating `Conditions`.
type ConditionResult ¶
type ConditionResult struct {
Firing bool
NoDataFound bool
Operator string
EvalMatches []*EvalMatch
}
ConditionResult is the result of a condition evaluation.
type DashAlertExtractor ¶
type DashAlertExtractor struct {
User *models.SignedInUser
Dash *models.Dashboard
OrgID int64
// contains filtered or unexported fields
}
DashAlertExtractor extracts alerts from the dashboard json.
func NewDashAlertExtractor ¶
func NewDashAlertExtractor(dash *models.Dashboard, orgID int64, user *models.SignedInUser) *DashAlertExtractor
NewDashAlertExtractor returns a new DashAlertExtractor.
func (*DashAlertExtractor) GetAlerts ¶
func (e *DashAlertExtractor) GetAlerts() ([]*models.Alert, error)
GetAlerts extracts alerts from the dashboard json and does full validation on the alert json data.
func (*DashAlertExtractor) ValidateAlerts ¶
func (e *DashAlertExtractor) ValidateAlerts() error
ValidateAlerts validates alerts in the dashboard json but does not require a valid dashboard id in the first validation pass.
type DatasourceAlertUsage ¶
DatasourceAlertUsage is a hash where the key represents the Datasource type and the value represents how many alerts that use the datasources.
type DefaultEvalHandler ¶
type DefaultEvalHandler struct {
// contains filtered or unexported fields
}
DefaultEvalHandler is responsible for evaluating the alert rule.
func NewEvalHandler ¶
func NewEvalHandler() *DefaultEvalHandler
NewEvalHandler is the `DefaultEvalHandler` constructor.
func (*DefaultEvalHandler) Eval ¶
func (e *DefaultEvalHandler) Eval(context *EvalContext)
Eval evaluated the alert rule.
type ElementType ¶
type ElementType string
ElementType is the type of element that can be rendered in the frontend.
type EvalContext ¶
type EvalContext struct {
Firing bool
IsTestRun bool
IsDebug bool
EvalMatches []*EvalMatch
Logs []*ResultLogEntry
Error error
ConditionEvals string
StartTime time.Time
EndTime time.Time
Rule *Rule
ImagePublicURL string
ImageOnDiskPath string
NoDataFound bool
PrevAlertState models.AlertStateType
RequestValidator models.PluginRequestValidator
Ctx context.Context
// contains filtered or unexported fields
}
EvalContext is the context object for an alert evaluation.
func NewEvalContext ¶
func NewEvalContext(alertCtx context.Context, rule *Rule, requestValidator models.PluginRequestValidator) *EvalContext
NewEvalContext is the EvalContext constructor.
func (*EvalContext) GetDashboardUID ¶
func (c *EvalContext) GetDashboardUID() (*models.DashboardRef, error)
GetDashboardUID returns the dashboard uid for the alert rule.
func (*EvalContext) GetDurationMs ¶
func (c *EvalContext) GetDurationMs() float64
GetDurationMs returns the duration of the alert evaluation.
func (*EvalContext) GetNewState ¶
func (c *EvalContext) GetNewState() models.AlertStateType
GetNewState returns the new state from the alert rule evaluation.
func (*EvalContext) GetNotificationTitle ¶
func (c *EvalContext) GetNotificationTitle() string
GetNotificationTitle returns the title of the alert rule including alert state.
func (*EvalContext) GetRuleURL ¶
func (c *EvalContext) GetRuleURL() (string, error)
GetRuleURL returns the url to the dashboard containing the alert.
func (*EvalContext) GetStateModel ¶
func (c *EvalContext) GetStateModel() *StateDescription
GetStateModel returns the `StateDescription` based on current state.
type EvalMatch ¶
type EvalMatch struct {
Value null.Float `json:"value"`
Metric string `json:"metric"`
Tags map[string]string `json:"tags"`
}
EvalMatch represents the series violating the threshold.
type InputType ¶
type InputType string
InputType is the type of input that can be rendered in the frontend.
type Job ¶
type Job struct {
Offset int64
OffsetWait bool
Delay bool
Rule *Rule
// contains filtered or unexported fields
}
Job holds state about when the alert rule should be evaluated.
func (*Job) GetRunning ¶
GetRunning returns true if the job is running. A lock is taken and released on the Job to ensure atomicity.
func (*Job) SetRunning ¶
SetRunning sets the running property on the Job. A lock is taken and released on the Job to ensure atomicity.
type NotificationTestCommand ¶
type NotificationTestCommand struct {
OrgID int64
ID int64
State models.AlertStateType
Name string
Type string
Settings *simplejson.Json
SecureSettings map[string]string
}
NotificationTestCommand initiates an test execution of an alert notification.
type Notifier ¶
type Notifier interface {
Notify(evalContext *EvalContext) error
GetType() string
NeedsImage() bool
// ShouldNotify checks this evaluation should send an alert notification
ShouldNotify(ctx context.Context, evalContext *EvalContext, notificationState *models.AlertNotificationState) bool
GetNotifierUID() string
GetIsDefault() bool
GetSendReminder() bool
GetDisableResolveMessage() bool
GetFrequency() time.Duration
}
Notifier is responsible for sending alert notifications.
func InitNotifier ¶
func InitNotifier(model *models.AlertNotification) (Notifier, error)
InitNotifier instantiate a new notifier based on the model.
type NotifierFactory ¶
type NotifierFactory func(notification *models.AlertNotification) (Notifier, error)
NotifierFactory is a signature for creating notifiers.
type NotifierOption ¶
type NotifierOption struct {
Element ElementType `json:"element"`
InputType InputType `json:"inputType"`
Label string `json:"label"`
Description string `json:"description"`
Placeholder string `json:"placeholder"`
PropertyName string `json:"propertyName"`
SelectOptions []SelectOption `json:"selectOptions"`
ShowWhen ShowWhen `json:"showWhen"`
Required bool `json:"required"`
ValidationRule string `json:"validationRule"`
Secure bool `json:"secure"`
}
NotifierOption holds information about options specific for the NotifierPlugin.
type NotifierPlugin ¶
type NotifierPlugin struct {
Type string `json:"type"`
Name string `json:"name"`
Heading string `json:"heading"`
Description string `json:"description"`
Info string `json:"info"`
Factory NotifierFactory `json:"-"`
Options []NotifierOption `json:"options"`
}
NotifierPlugin holds meta information about a notifier.
func GetNotifiers ¶
func GetNotifiers() []*NotifierPlugin
GetNotifiers returns a list of metadata about available notifiers.
type ResultLogEntry ¶
type ResultLogEntry struct {
Message string
Data interface{}
}
ResultLogEntry represents log data for the alert evaluation.
type Rule ¶
type Rule struct {
ID int64
OrgID int64
DashboardID int64
PanelID int64
Frequency int64
Name string
Message string
LastStateChange time.Time
For time.Duration
NoDataState models.NoDataOption
ExecutionErrorState models.ExecutionErrorOption
State models.AlertStateType
Conditions []Condition
Notifications []string
AlertRuleTags []*models.Tag
StateChanges int64
}
Rule is the in-memory version of an alert rule.
type SelectOption ¶
SelectOption is a simple type for Options that have dropdown options. Should be used when Element is ElementTypeSelect.
type StateDescription ¶
StateDescription contains visual information about the alert state.
type Ticker ¶
Ticker is a ticker to power the alerting scheduler. it's like a time.Ticker, except:
- it doesn't drop ticks for slow receivers, rather, it queues up. so that callers are in control to instrument what's going on.
- it automatically ticks every second, which is the right thing in our current design
- it ticks on intervalSec marks or very shortly after. this provides a predictable load pattern (this shouldn't cause too much load contention issues because the next steps in the pipeline just process at their own pace)
- the timestamps are used to mark "last datapoint to query for" and as such, are a configurable amount of seconds in the past
- because we want to allow:
- a clean "resume where we left off" and "don't yield ticks we already did"
- adjusting offset over time to compensate for storage backing up or getting fast and providing lower latency you specify a lastProcessed timestamp as well as an offset at creation, or runtime
func NewTicker ¶
func NewTicker(last time.Time, initialOffset time.Duration, c clock.Clock, intervalSec int64) *Ticker
NewTicker returns a ticker that ticks on intervalSec marks or very shortly after, and never drops ticks
func (*Ticker) Pause ¶
func (t *Ticker) Pause()
Pause unpauses the ticker and no ticks will be sent.
func (*Ticker) ResetOffset ¶
ResetOffset resets the offset.
type UsageStats ¶
type UsageStats struct {
DatasourceUsage DatasourceAlertUsage
}
UsageStats contains stats about alert rules configured in Grafarg.
type UsageStatsQuerier ¶
type UsageStatsQuerier interface {
QueryUsageStats() (*UsageStats, error)
}
UsageStatsQuerier returns usage stats about alert rules configured in Grafarg.