prometheus

package

v1.17.0 Latest Latest Go to latest Published: Mar 9, 2026 License: Apache-2.0 Imports: 15 Imported by: 2

Details

Package prometheus provides a set of utilities for assisting with Prometheus data

This section is empty.

This section is empty.

func IsEnabled() bool

IsEnabled returns true if prometheus is enabled

type Option func(s *Server)

Option is an option pattern for prometheus server

func WithCertificateMonitoring(monitorCert bool) Option

WithCertificateMonitoring enables monitoring for certificate renewals

func WithCustomCA(caFile string) Option

WithCustomCA sets the CA file to use for mTLS

func WithCustomCert(certFile, keyFile string) Option

WithCustomCert sets the certificate and key to use for TLS

func WithHeaderTimeout(headerTimeout time.Duration) Option

WithHeaderTimeout sets the header timeout for the prometheus server

func WithMaxBindThreshold(maxBindThreshold time.Duration) Option

WithMaxBindThreshold sets the maximum threshold for binding retries

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

Server is a server type for exposing Prometheus metrics

func NewServer(listenOn string, options ...Option) *Server

NewServer creates a new prometheus server instance

func (s *Server) ListenAndServe(ctx context.Context, cancel context.CancelFunc)

ListenAndServe gathers the certificate and initiates the Server to begin handling incoming requests