Categorygithub.com/cloudtrust/common-healthcheck
modulepackage
0.0.0
Repository: https://github.com/cloudtrust/common-healthcheck.git
Documentation: pkg.go.dev

# README

common-healthcheck Build Status Coverage Status GoDoc Go Report Card

All Cloudtrust microservices send metrics to InfluxDB, traces to Jaeger, technical logs to Redis, and errors to Sentry. The health of all those components is monitored with health checks. Because they are used in every microservice, this library with all the common health checks was created.

# Packages

Package mock is a generated GoMock package.

# Functions

MakeHealthCheckerLoggingMW makes a logging middleware for the health check modules.
MakeValidationMiddleware makes a middleware that validate the health check name comming from the HTTP route.
NewCockroachModule returns the cockroach health module.
NewFlakiModule returns the Flaki health module.
NewInfluxModule returns the influx health module.
NewJaegerModule returns the jaeger health module.
NewRedisModule returns the redis health module.
NewSentryModule returns the sentry health module.

# Constants

Deactivated is the status for a service that is deactivated, e.g.
KO is the status for an unsuccessful health check.
OK is the status for a successful health check.

# Structs

CockroachModule is the health check module for cockroach.
ErrInvalidHCName is the error returned when there is a health request for an unknown healthcheck name.
FlakiModule is the health check module for Flaki.
InfluxModule is the health check module for influx.
JaegerModule is the health check module for jaeger.
RedisModule is the health check module for redis.
SentryModule is the health check module for sentry.

# Interfaces

CockroachClient is the interface of the cockroach client.
FlakiClient is the interface of the Flaki client.
HealthChecker is the interface of the health check modules.
HTTPClient is the interface of the http client used to get health check status.
InfluxClient is the interface of the influx client.
RedisClient is the interface of the redis client.
SentryClient is the interface of the sentry client.

# Type aliases

Status is the status of the health check.go:generate stringer -type=Status.