Documentation
¶
Index ¶
Constants ¶
View Source
const (
// PluginName declares public plugin name.
PluginName = "status"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Address of the http server
Address string
// Time to wait for a health check response.
CheckTimeout int `mapstructure:"check_timeout"`
UnavailableStatusCode int `mapstructure:"unavailable_status_code"`
}
Config is the configuration reference for the Status plugin
type Configurer ¶
type Health ¶
type Health struct {
// contains filtered or unexported fields
}
func NewHealthHandler ¶
type JobsChecker ¶
type JobsReport ¶ added in v5.1.0
type JobsReport struct {
Pipeline string `json:"pipeline"`
Priority uint64 `json:"priority"`
Ready bool `json:"ready"`
Queue string `json:"queue"`
Active int64 `json:"active"`
Delayed int64 `json:"delayed"`
Reserved int64 `json:"reserved"`
Driver string `json:"driver"`
ErrorMessage string `json:"error_message"`
}
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
func (*Plugin) StopHTTPServer ¶
func (c *Plugin) StopHTTPServer()
StopHTTPServer stops the http server, used only for TEST purposes
type Readiness ¶
Readiness interface used to get readiness status from the plugin that means that a worker pool inside the plugin has 1+ plugins which are ready to work at the particular moment
Click to show internal directories.
Click to hide internal directories.