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

# Packages

# Functions

New creates a new Alertmanager.
NewDistributor constructs a new Distributor.
NewMultitenantAlertmanager creates a new MultitenantAlertmanager.

# Constants

RingKey is the key under which we store the alertmanager ring in the KVStore.
RingNameForServer is the name of the ring used by the alertmanager server.
RingNumTokens is a safe default instead of exposing to config option to the user in order to simplify the config.

# Variables

RingOp is the operation used for reading/writing to the alertmanagers.
SyncRingOp is the operation used for checking if a user is owned by an alertmanager.

# Structs

An Alertmanager manages the alerts for one user.
ClientConfig is the configuration struct for the alertmanager client.
Config configures an Alertmanager.
Distributor forwards requests to individual alertmanagers.
A MultitenantAlertmanager manages Alertmanager instances for multiple organizations.
MultitenantAlertmanagerConfig is the configuration for a multitenant Alertmanager.
NilPeer and NilChannel implements the Alertmanager clustering interface used by the API to expose cluster information.
RingConfig masks the ring lifecycler config which contains many options not really required by the alertmanager ring.
StatusHandler shows the status of the alertmanager.
UserConfig is used to communicate a users alertmanager configs.

# Interfaces

Client is the interface that should be implemented by any client used to read/write data to an alertmanager via GRPC.
ClientsPool is the interface used to get the client from the pool for a specified address.
Limits defines limits used by Alertmanager.
Replicator is used to exchange state with peers via the ring when sharding is enabled.
State helps with replication and synchronization of notifications and silences across several alertmanager replicas.