sender

package
v0.0.0-...-56fe054 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 12, 2026 License: AGPL-3.0 Imports: 47 Imported by: 0

Documentation

Overview

nolint

Index

Constants

View Source
const (
	// DefaultMaxBatchSize is the default maximum number of alerts to send in a single request to the alertmanager.
	DefaultMaxBatchSize = 256
)

Variables

This section is empty.

Functions

func AlertmanagerFromGroup

func AlertmanagerFromGroup(tg *targetgroup.Group, cfg *config.AlertmanagerConfig) ([]alertmanager, []alertmanager, error)

AlertmanagerFromGroup extracts a list of alertmanagers from a target group and an associated AlertmanagerConfig.

Types

type Alert

type Alert struct {
	// Label value pairs for purpose of aggregation, matching, and disposition
	// dispatching. This must minimally include an "alertname" label.
	Labels labels.Labels `json:"labels"`

	// Extra key/value information which does not define alert identity.
	Annotations labels.Labels `json:"annotations"`

	// The known time range for this alert. Both ends are optional.
	StartsAt     time.Time `json:"startsAt,omitempty"`
	EndsAt       time.Time `json:"endsAt,omitempty"`
	GeneratorURL string    `json:"generatorURL,omitempty"`
}

Alert is a generic representation of an alert in the Prometheus eco-system.

func (*Alert) Hash

func (a *Alert) Hash() uint64

Hash returns a hash over the alert. It is equivalent to the alert labels hash.

func (*Alert) Name

func (a *Alert) Name() string

Name returns the name of the alert. It is equivalent to the "alertname" label.

func (*Alert) Resolved

func (a *Alert) Resolved() bool

Resolved returns true iff the activity interval ended in the past.

func (*Alert) ResolvedAt

func (a *Alert) ResolvedAt(ts time.Time) bool

ResolvedAt returns true iff the activity interval ended before the given timestamp.

func (*Alert) String

func (a *Alert) String() string

type AlertsRouter

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

AlertsRouter handles alerts generated during alert rule evaluation. Based on rule's orgID and the configuration for that organization, it determines whether an alert needs to be sent to an external Alertmanager and\or internal notifier.Alertmanager

After creating a AlertsRouter, you must call Run to keep the AlertsRouter's state synchronized with the alerting configuration.

func NewAlertsRouter

func NewAlertsRouter(multiOrgNotifier *notifier.MultiOrgAlertmanager, store store.AdminConfigurationStore,
	clk clock.Clock, appURL *url.URL, disabledOrgs map[int64]struct{}, configPollInterval time.Duration,
	datasourceService datasources.DataSourceService, secretService secrets.Service, featureManager featuremgmt.FeatureToggles) *AlertsRouter

func (*AlertsRouter) AlertmanagersFor

func (d *AlertsRouter) AlertmanagersFor(orgID int64) []*url.URL

AlertmanagersFor returns all the discovered Alertmanager(s) for a particular organization.

func (*AlertsRouter) DroppedAlertmanagersFor

func (d *AlertsRouter) DroppedAlertmanagersFor(orgID int64) []*url.URL

DroppedAlertmanagersFor returns all the dropped Alertmanager(s) for a particular organization.

func (*AlertsRouter) Run

func (d *AlertsRouter) Run(ctx context.Context) error

Run starts regular updates of the configuration.

func (*AlertsRouter) Send

func (*AlertsRouter) SyncAndApplyConfigFromDatabase

func (d *AlertsRouter) SyncAndApplyConfigFromDatabase(ctx context.Context) error

SyncAndApplyConfigFromDatabase looks for the admin configuration in the database and adjusts the sender(s) and alert handling mechanism accordingly.

type ExternalAMOptions

type ExternalAMOptions struct {
	Options
	// contains filtered or unexported fields
}

type ExternalAMcfg

type ExternalAMcfg struct {
	URL     string
	Headers http.Header
	Timeout time.Duration
}

func (*ExternalAMcfg) SHA256

func (cfg *ExternalAMcfg) SHA256() string

type ExternalAlertmanager

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

ExternalAlertmanager is responsible for dispatching alert notifications to an external Alertmanager service.

func NewExternalAlertmanagerSender

func NewExternalAlertmanagerSender(l log.Logger, reg prometheus.Registerer, opts ...Option) (*ExternalAlertmanager, error)

func (*ExternalAlertmanager) Alertmanagers

func (s *ExternalAlertmanager) Alertmanagers() []*url.URL

Alertmanagers returns a list of the discovered Alertmanager(s).

func (*ExternalAlertmanager) ApplyConfig

func (s *ExternalAlertmanager) ApplyConfig(orgId, id int64, alertmanagers []ExternalAMcfg) error

ApplyConfig syncs a configuration with the sender.

func (*ExternalAlertmanager) DroppedAlertmanagers

func (s *ExternalAlertmanager) DroppedAlertmanagers() []*url.URL

DroppedAlertmanagers returns a list of Alertmanager(s) we no longer send alerts to.

func (*ExternalAlertmanager) Run

func (s *ExternalAlertmanager) Run()

func (*ExternalAlertmanager) SendAlerts

func (s *ExternalAlertmanager) SendAlerts(alerts apimodels.PostableAlerts)

SendAlerts sends a set of alerts to the configured Alertmanager(s).

func (*ExternalAlertmanager) Stop

func (s *ExternalAlertmanager) Stop()

Stop shuts down the sender.

type FakeExternalAlertmanager

type FakeExternalAlertmanager struct {
	Server *httptest.Server
	// contains filtered or unexported fields
}

func NewFakeExternalAlertmanager

func NewFakeExternalAlertmanager(t *testing.T) *FakeExternalAlertmanager

func (*FakeExternalAlertmanager) AlertNamesCompare

func (am *FakeExternalAlertmanager) AlertNamesCompare(expected []string) bool

func (*FakeExternalAlertmanager) Alerts

func (*FakeExternalAlertmanager) AlertsCount

func (am *FakeExternalAlertmanager) AlertsCount() int

func (*FakeExternalAlertmanager) Close

func (am *FakeExternalAlertmanager) Close()

func (*FakeExternalAlertmanager) Handler

func (am *FakeExternalAlertmanager) Handler() func(w http.ResponseWriter, r *http.Request)

func (*FakeExternalAlertmanager) URL

func (am *FakeExternalAlertmanager) URL() string

type InfraLoggerHandler

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

InfraLoggerHandler adapts infra's log.Logger to an slog.Handler

func (*InfraLoggerHandler) Enabled

func (h *InfraLoggerHandler) Enabled(_ context.Context, level slog.Level) bool

Enabled determines if the log level is enabled

func (*InfraLoggerHandler) Handle

func (h *InfraLoggerHandler) Handle(_ context.Context, record slog.Record) error

Handle processes a log record and routes it to infra's log.Logger

func (*InfraLoggerHandler) WithAttrs

func (h *InfraLoggerHandler) WithAttrs(attrs []slog.Attr) slog.Handler

WithAttrs adds attributes to the logger context

func (*InfraLoggerHandler) WithGroup

func (h *InfraLoggerHandler) WithGroup(name string) slog.Handler

WithGroup groups log records; not used here

type Manager

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

Manager is responsible for dispatching alert notifications to an alert manager service.

func NewManager

func NewManager(o *Options, logger *slog.Logger) *Manager

NewManager is the manager constructor.

func (*Manager) Alertmanagers

func (n *Manager) Alertmanagers() []*url.URL

Alertmanagers returns a slice of Alertmanager URLs.

func (*Manager) ApplyConfig

func (n *Manager) ApplyConfig(conf *config.Config, headers map[string]http.Header) error

ApplyConfig updates the status state as the new config requires. Extension: add new parameter headers.

func (*Manager) DroppedAlertmanagers

func (n *Manager) DroppedAlertmanagers() []*url.URL

DroppedAlertmanagers returns a slice of Alertmanager URLs.

func (*Manager) Run

func (n *Manager) Run(tsets <-chan map[string][]*targetgroup.Group)

Run dispatches notifications continuously, returning once Stop has been called and all pending notifications have been drained from the queue (if draining is enabled).

Dispatching of notifications occurs in parallel to processing target updates to avoid one starving the other. Refer to https://github.com/prometheus/prometheus/issues/13676 for more details.

func (*Manager) Send

func (n *Manager) Send(alerts ...*Alert)

Send queues the given notification requests for processing. Panics if called on a handler that is not running.

func (*Manager) Stop

func (n *Manager) Stop()

Stop signals the notification manager to shut down and immediately returns.

Run will return once the notification manager has successfully shut down.

The manager will optionally drain any queued notifications before shutting down.

Stop is safe to call multiple times.

type Option

type Option func(*ExternalAMOptions)

func WithDoFunc

func WithDoFunc(doFunc doFunc) Option

WithDoFunc receives a function to use when making HTTP requests from the Manager.

func WithMaxBatchSize

func WithMaxBatchSize(size int) Option

WithMaxBatchSize sets the maximum batch size for sending alerts to the external Alertmanager(s).

func WithMaxQueueCapacity

func WithMaxQueueCapacity(capacity int) Option

WithMaxQueueCapacity sets the maximum capacity of the queue used by the sender.

func WithUTF8Labels

func WithUTF8Labels() Option

WithUTF8Labels skips sanitizing labels and annotations before sending alerts to the external Alertmanager(s). It assumes UTF-8 label names are supported by the Alertmanager(s).

type Options

type Options struct {
	QueueCapacity   int
	DrainOnShutdown bool
	ExternalLabels  labels.Labels
	RelabelConfigs  []*relabel.Config
	// Used for sending HTTP requests to the Alertmanager.
	Do func(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)

	Registerer prometheus.Registerer

	// MaxBatchSize determines the maximum number of alerts to send in a single request to the alertmanager.
	MaxBatchSize int
}

Options are the configurable parameters of a Handler.

type SlogAdapter

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

func (*SlogAdapter) Log

func (s *SlogAdapter) Log(keyvals ...interface{}) error

Log implements the Log method to satisfy the log.Logger interface.

Jump to

Keyboard shortcuts

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