package
1.19.0
Repository: https://github.com/cortexproject/cortex.git
Documentation: pkg.go.dev

# Packages

# Functions

EngineQueryFunc returns a new engine query function validating max queryLength.
GetReplicationSetForListRule is similar to ring.GetReplicationSetForOperation but does NOT require quorum.
NewAPI returns a new API struct with the provided ruler and rule store.
NewManagerMetrics returns a ManagerMetrics struct.
NewRuler creates a new ruler from a distributor and chunk store.
NewRuleStore returns a rule store backend client based on the provided cfg.
SendAlerts implements a rules.NotifyFunc for a Notifier.

# Variables

ErrBadRuleGroup is returned when the provided rule group can not be unmarshalled.
ErrNoGroupName signals a group name url parameter was not found.
ErrNoNamespace signals that no namespace was specified in the request.
ErrNoRuleGroups signals the rule group requested does not exist.
ListRuleRingOp is the operation used for getting rule groups from rulers.
RingOp is the operation used for distributing rule groups between rulers.

# Structs

Alert has info for an alert.
AlertDiscovery has info for all active alerts.
API is used to handle HTTP requests for the ruler service.
Config is the configuration for the recording rules server.
GroupStateDesc is a proto representation of a cortex rule group.
ManagerMetrics aggregates metrics exported by the Prometheus rules package and returns them as Cortex metrics.
PusherAppendable fulfills the storage.Appendable interface for prometheus manager.
RingConfig masks the ring lifecycler config which contains many options not really required by the rulers ring.
RuleDiscovery has info for all rules.
RuleGroup has info for rules which are part of a group.
Ruler evaluates rules.
RuleStateDesc is a proto representation of a Prometheus Rule.
UnimplementedRulerServer can be embedded to have forward compatible implementations.

# Interfaces

ClientsPool is the interface used to get the client from the pool for a specified address.
MultiTenantManager is the interface of interaction with a Manager that is tenant aware.
Pusher is an ingester server that accepts pushes.
RulerClient is the client API for Ruler service.
RulerServer is the server API for Ruler service.
RulesLimits defines limits used by Ruler.
This interface mimics rules.Manager API.

# Type aliases

ManagerFactory is a function that creates new RulesManager for given user and notifier.Manager.