var (
// SwaggerJSON embedded version of the swagger document used at generation time
SwaggerJSON json.RawMessage
// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
FlatSwaggerJSON json.RawMessage
)
Server for the alertmanager API
type Server struct {
EnabledListeners []string `long:"scheme" description:"the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec"`
CleanupTimeout time.Duration `long:"cleanup-timeout" description:"grace period for which to wait before killing idle connections" default:"10s"`
GracefulTimeout time.Duration `long:"graceful-timeout" description:"grace period for which to wait before shutting down the server" default:"15s"`
MaxHeaderSize flagext.ByteSize `long:"max-header-size" description:"controls the maximum number of bytes the server will read parsing the request header's keys and values, including the request line. It does not limit the size of the request body." default:"1MiB"`
SocketPath flags.Filename `long:"socket-path" description:"the unix socket to listen on" default:"/var/run/alertmanager.sock"`
Host string `long:"host" description:"the IP to listen on" default:"localhost" env:"HOST"`
Port int `long:"port" description:"the port to listen on for insecure connections, defaults to a random value" env:"PORT"`
ListenLimit int `long:"listen-limit" description:"limit the number of outstanding requests"`
KeepAlive time.Duration `long:"keep-alive" description:"sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download)" default:"3m"`
ReadTimeout time.Duration `long:"read-timeout" description:"maximum duration before timing out read of the request" default:"30s"`
WriteTimeout time.Duration `long:"write-timeout" description:"maximum duration before timing out write of the response" default:"60s"`
TLSHost string `long:"tls-host" description:"the IP to listen on for tls, when not specified it's the same as --host" env:"TLS_HOST"`
TLSPort int `long:"tls-port" description:"the port to listen on for secure connections, defaults to a random value" env:"TLS_PORT"`
TLSCertificate flags.Filename `long:"tls-certificate" description:"the certificate to use for secure connections" env:"TLS_CERTIFICATE"`
TLSCertificateKey flags.Filename `long:"tls-key" description:"the private key to use for secure connections" env:"TLS_PRIVATE_KEY"`
TLSCACertificate flags.Filename `long:"tls-ca" description:"the certificate authority file to be used with mutual tls auth" env:"TLS_CA_CERTIFICATE"`
TLSListenLimit int `long:"tls-listen-limit" description:"limit the number of outstanding requests"`
TLSKeepAlive time.Duration `long:"tls-keep-alive" description:"sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download)"`
TLSReadTimeout time.Duration `long:"tls-read-timeout" description:"maximum duration before timing out read of the request"`
TLSWriteTimeout time.Duration `long:"tls-write-timeout" description:"maximum duration before timing out write of the response"`
// contains filtered or unexported fields
}
func NewServer(api *operations.AlertmanagerAPI) *Server
NewServer creates a new api alertmanager server but does not configure it
func (s *Server) ConfigureAPI()
ConfigureAPI configures the API and handlers.
func (s *Server) ConfigureFlags()
ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse
func (s *Server) Fatalf(f string, args ...interface{})
Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing
func (s *Server) GetHandler() http.Handler
GetHandler returns a handler useful for testing
func (s *Server) HTTPListener() (net.Listener, error)
HTTPListener returns the http listener
func (s *Server) Listen() error
Listen creates the listeners for the server
func (s *Server) Logf(f string, args ...interface{})
Logf logs message either via defined user logger or via system one if no user logger is defined.
func (s *Server) Serve() (err error)
Serve the api
func (s *Server) SetAPI(api *operations.AlertmanagerAPI)
SetAPI configures the server with the specified API. Needs to be called before Serve
func (s *Server) SetHandler(handler http.Handler)
SetHandler allows for setting a http handler on this server
func (s *Server) Shutdown() error
Shutdown server and clean up resources
func (s *Server) TLSListener() (net.Listener, error)
TLSListener returns the https listener
func (s *Server) UnixListener() (net.Listener, error)
UnixListener returns the domain socket listener
| Name | Synopsis |
|---|---|
| .. | |
| operations | |
| alert | |
| alertgroup | |
| general | |
| receiver | |
| silence | |