README
Documentation
¶
Index ¶
Constants ¶
View Source
const ( PrometheusNamespace = "microendpoint" PrometheusSubsystem = "vaulthealthz" )
View Source
const ( // Description describes which functionality this health check implements. Description = "Ensure Vault API availability." // Name is the identifier of the health check. This can be used for emitting // metrics. Name = "vault" // SuccessMessage is the message returned in case the health check did not // fail. SuccessMessage = "all good" // Timeout is the time being waited until timing out health check, which // renders its result unsuccessful. Timeout = 5 * time.Second )
View Source
const ( // ExpireTimeKey is the data key provided by the secret when looking up the // used Vault token. This key is specific to Vault as they define it. ExpireTimeKey = "expire_time" // ExpireTimeLayout is the layout used for time parsing when inspecting the // expiration date of the used Vault token. This layout is specific to Vault // as they define it. ExpireTimeLayout = "2006-01-02T15:04:05" )
Variables ¶
This section is empty.
Functions ¶
func IsExecutionFailed ¶
IsExecutionFailed asserts executionFailedError.
func IsInvalidConfig ¶
IsInvalidConfig asserts invalidConfigError.
Types ¶
type Config ¶
type Config struct {
// Dependencies.
Logger micrologger.Logger
VaultClient *vaultapi.Client
// Settings.
Timeout time.Duration
}
Config represents the configuration used to create a healthz service.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig provides a default configuration to create a new healthz service by best effort.
Source Files
Click to show internal directories.
Click to hide internal directories.