health

type AdditionalHealthData struct {
	DependencyChecks []HealthChecker
	//The custom data can override the default health detail values
	DataProvider func(*gin.Context) map[string]interface{}

	//Description is set in server.RegisterDetailedHealth function, so there is no need
	//to set this field when initializing AdditionalHealthData struct
	Description string
}

type AppInfo struct {
	Version  string
	Revision string

	AppName  string `env:"APPLICATION_NAME"`
	Hostname string `env:"HOSTNAME"`
}

type DependencyInfo struct {
	Name         string          `json:"name"`
	Type         string          `json:"type"`
	Version      string          `json:"version"`
	Revision     string          `json:"revision"`
	State        DependencyState `json:"state"`
	ResponseTime float64         `json:"responseTime"`
}

type DependencyState struct {
	Status  string `json:"status"`
	Details string `json:"details,omitempty"`
}

type Health map[string]interface{}

type HealthChecker interface {
	Check() *DependencyInfo
	GetName() string
	GetType() string
}

type ProjectInfo struct {
	Repo   string   `json:"repo"   env:"PROJECT_REPO"`
	Home   string   `json:"home"   env:"PROJECT_HOME"`
	Owners []string `json:"owners"`
	Logs   []string `json:"logs"`
	Stats  []string `json:"stats"`

	OwnersStr string `json:"-" env:"PROJECT_OWNERS"`
	LogsStr   string `json:"-" env:"PROJECT_LOG_URLS"`
	StatsStr  string `json:"-" env:"PROJECT_STATS_URLS"`
}

type SQLCheck struct {
	Name string
	Type string
	DB   interface{}
}

type WebCheck struct {
	Name string
	URL  string
	Type string
	//ExpectedStatusCode should only be set when you expect a specific response code from
	//the health check. If it is set to a code > 0, when the response code is the same,
	//the dependency state status will be OK; otherwise it will be CRIT. I.e., if
	//you set it to 404, then when the response code is 404, the status will be OK.
	//This is mainly for checking some web server that does not implement a proper
	//health endpoint and you have to compromise the approach to check it.
	ExpectedStatusCode int
}