cacert-gosigner/pkg/health/health.go
Jan Dittberner 60be959c24 Implement health check infrastructure
This commit adds health check capabilities to the hsm.Access and health
response data to the messages returned by the health command.
2022-08-03 15:45:27 +02:00

66 lines
1.4 KiB
Go

/*
Copyright 2022 CAcert Inc.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package health implements Health checks
package health
import (
"fmt"
)
type Info struct {
Healthy bool
Source string
MoreInfo map[string]string
}
type Aware interface {
Healthy() (*Info, error)
}
type Handler struct {
version string
healthAware []Aware
}
type Result struct {
Healthy bool
Version string
Info []*Info
}
func (h *Handler) CheckHealth() (*Result, error) {
healthInfo := make([]*Info, len(h.healthAware))
healthy := true
for idx, aware := range h.healthAware {
info, err := aware.Healthy()
if err != nil {
return nil, fmt.Errorf("health check failed: %w", err)
}
healthInfo[idx] = info
healthy = healthy && info.Healthy
}
return &Result{Healthy: healthy, Version: h.version, Info: healthInfo}, nil
}
func New(version string, healthAware ...Aware) *Handler {
return &Handler{version: version, healthAware: healthAware}
}