probes

Documentation

Index

• Variables
• func PGWithCA(ca []byte) func(*pgxpool.Config) error
• type FailingProbe
  • func NewFailingProbe(service, name, namespace string, err error) (*FailingProbe, error)
  • func (p FailingProbe) Close() error
  • func (p FailingProbe) GetInfo() ProbeInfo
  • func (p FailingProbe) Probe(ctx context.Context) error
• type HTTP
  • func NewHTTP(url string, tlsEnabled bool, cacert *x509.Certificate, ...) *HTTP
  • func (h *HTTP) Close() error
  • func (h *HTTP) GetInfo() ProbeInfo
  • func (h *HTTP) Probe(ctx context.Context) error
• type Manager
  • func NewManager(l logr.Logger, maintenanceStatus maintenancecontroller.MaintenanceStatus) Manager
  • func (m Manager) Collector() prometheus.Collector
  • func (m Manager) StartProbe(p Prober)
  • func (m Manager) StopProbe(pi ProbeInfo)
• type MariaDB
  • func NewFailingMariaDB(service, name, namespace string) (*MariaDB, error)
  • func NewMariaDB(service, name, namespace, dsn, organization, caCRT, serviceLevel string, ...) (*MariaDB, error)
  • func (p MariaDB) Close() error
  • func (p MariaDB) GetInfo() ProbeInfo
  • func (p MariaDB) Probe(ctx context.Context) error
• type PostgreSQL
  • func NewFailingPostgreSQL(service, name, namespace string) (*PostgreSQL, error)
  • func NewPostgreSQL(service, name, namespace, dsn, organization, sla string, ha bool, ...) (*PostgreSQL, error)
  • func (p PostgreSQL) Close() error
  • func (p PostgreSQL) GetInfo() ProbeInfo
  • func (p PostgreSQL) Probe(ctx context.Context) error
• type ProbeInfo
  • func NewProbeInfo(serviceKey string, nn types.NamespacedName, o client.Object) ProbeInfo
• type Prober
• type VSHNMinio
  • func NewMinio(service, name, namespace, organization, sla, endpointURL string, ha bool, ...) (*VSHNMinio, error)
  • func (minio VSHNMinio) Close() error
  • func (minio VSHNMinio) GetInfo() ProbeInfo
  • func (minio VSHNMinio) Probe(ctx context.Context) error
• type VSHNRedis
  • func NewRedis(service, name, namespace, organization, sla string, ha bool, ...) (*VSHNRedis, error)
  • func (redis VSHNRedis) Close() error
  • func (redis VSHNRedis) GetInfo() ProbeInfo
  • func (redis VSHNRedis) Probe(ctx context.Context) error

Variables

var ErrTimeout = errors.New("probe timed out")

ErrTimeout is the error thrown when the probe can't reach the endpoint for a longer period of time.

Functions

func PGWithCA

func PGWithCA(ca []byte) func(*pgxpool.Config) error

PGWithCA adds the provided CA to the rootCAs of the pgxpool.

Types

type FailingProbe

type FailingProbe struct {
	Service   string
	Name      string
	Namespace string
	Error     error
}

FailingProbe is a prober that will always fail.

func NewFailingProbe

func NewFailingProbe(service, name, namespace string, err error) (*FailingProbe, error)

NewFailing creates a prober that will fail. Can be used if the controller can't access valid credentials.

func (FailingProbe) Close

func (p FailingProbe) Close() error

Close closes open connections.

func (FailingProbe) GetInfo

func (p FailingProbe) GetInfo() ProbeInfo

GetInfo returns the prober infos

func (FailingProbe) Probe

func (p FailingProbe) Probe(ctx context.Context) error

Will always return error, as this is a failing probe.

type HTTP

type HTTP struct {
	ProbeInfo
	// contains filtered or unexported fields
}

func NewHTTP

func NewHTTP(url string, tlsEnabled bool, cacert *x509.Certificate, service, name, namespace, organization, servicelevel string, ha bool) *HTTP

func (*HTTP) Close

func (h *HTTP) Close() error

func (*HTTP) GetInfo

func (h *HTTP) GetInfo() ProbeInfo

func (*HTTP) Probe

func (h *HTTP) Probe(ctx context.Context) error

type Manager

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

Manager manages a collection of Probers the check connectivity to AppCat services.

func NewManager

func NewManager(l logr.Logger, maintenanceStatus maintenancecontroller.MaintenanceStatus) Manager

NewManager returns a new manager.

func (Manager) Collector

func (m Manager) Collector() prometheus.Collector

Collector returns the histogram to store the probe results

func (Manager) StartProbe

func (m Manager) StartProbe(p Prober)

StartProbe will send a probe once every second using the provided prober. If a prober with the same ProbeInfo already runs, it will stop the running prober.

func (Manager) StopProbe

func (m Manager) StopProbe(pi ProbeInfo)

StopProbe will stop the prober with the provided ProbeInfo. Is a Noop if none is running.

type MariaDB

type MariaDB struct {
	Service       string
	Name          string
	Namespace     string
	Organization  string
	HighAvailable bool
	ServiceLevel  string
	// contains filtered or unexported fields
}

MariaDB is a prober to test the uptime of a MariaDB instance.

func NewFailingMariaDB

func NewFailingMariaDB(service, name, namespace string) (*MariaDB, error)

NewFailingMariaDB creates a prober that will fail. Can be used if the controller can't access valid credentials.

func NewMariaDB

func NewMariaDB(service, name, namespace, dsn, organization, caCRT, serviceLevel string, ha, TLSEnabled bool) (*MariaDB, error)

NewMariaDB connects to the provided dsn and returns a prober

func (MariaDB) Close

func (p MariaDB) Close() error

Close closes open connections to the MariaDB server.

func (MariaDB) GetInfo

func (p MariaDB) GetInfo() ProbeInfo

GetInfo returns the prober infos

func (MariaDB) Probe

func (p MariaDB) Probe(ctx context.Context) error

Probe sends a test query to the configured MariaDB server. Will return an error if the prober does not have a valid db connection.

type PostgreSQL

type PostgreSQL struct {
	Service       string
	Name          string
	Namespace     string
	Organization  string
	HighAvailable bool
	ServiceLevel  string
	// contains filtered or unexported fields
}

PostgreSQL is a prober to test the uptime of a PostgreSQL instance.

func NewFailingPostgreSQL

func NewFailingPostgreSQL(service, name, namespace string) (*PostgreSQL, error)

NewFailingPostgreSQL creates a prober that will fail. Can be used if the controller can't access valid credentials.

func NewPostgreSQL

func NewPostgreSQL(service, name, namespace, dsn, organization, sla string, ha bool, ops ...func(*pgxpool.Config) error) (*PostgreSQL, error)

NewPostgreSQL connects to the provided dsn and returns a prober

func (PostgreSQL) Close

func (p PostgreSQL) Close() error

Close closes open connections to the PostgreSQL server.

func (PostgreSQL) GetInfo

func (p PostgreSQL) GetInfo() ProbeInfo

GetInfo returns the prober infos

func (PostgreSQL) Probe

func (p PostgreSQL) Probe(ctx context.Context) error

Probe sends a test query to the configured PostgreSQL server. Will return an error if the prober does not have a valid db connection.

type ProbeInfo

type ProbeInfo struct {
	Service       string
	Name          string
	Namespace     string
	Organization  string
	HighAvailable bool
	ServiceLevel  string
}

ProbeInfo contains meta information on a prober and in turn an AppCat service

func NewProbeInfo

func NewProbeInfo(serviceKey string, nn types.NamespacedName, o client.Object) ProbeInfo

type Prober

type Prober interface {
	GetInfo() ProbeInfo
	Probe(ctx context.Context) error
	Close() error
}

Prober checks the connectivity to an AppCat service

type VSHNMinio

type VSHNMinio struct {
	Service       string
	Name          string
	Namespace     string
	HighAvailable bool
	Organization  string
	ServiceLevel  string
	// contains filtered or unexported fields
}

func NewMinio

func NewMinio(service, name, namespace, organization, sla, endpointURL string, ha bool, opts miniolib.Options) (*VSHNMinio, error)

func (VSHNMinio) Close

func (minio VSHNMinio) Close() error

func (VSHNMinio) GetInfo

func (minio VSHNMinio) GetInfo() ProbeInfo

func (VSHNMinio) Probe

func (minio VSHNMinio) Probe(ctx context.Context) error

type VSHNRedis

type VSHNRedis struct {
	Service       string
	Name          string
	Namespace     string
	HighAvailable bool
	Organization  string
	ServiceLevel  string
	// contains filtered or unexported fields
}

func NewRedis

func NewRedis(service, name, namespace, organization, sla string, ha bool, opts redis.Options) (*VSHNRedis, error)

func (VSHNRedis) Close

func (redis VSHNRedis) Close() error

func (VSHNRedis) GetInfo

func (redis VSHNRedis) GetInfo() ProbeInfo

func (VSHNRedis) Probe

func (redis VSHNRedis) Probe(ctx context.Context) error