Documentation
¶
Overview ¶
Retrieves the current Watcher metrics.
Index ¶
- Variables
- type NewStats
- type Response
- type Stats
- func (r Stats) Do(providedCtx context.Context) (*Response, error)
- func (r *Stats) EmitStacktraces(emitstacktraces bool) *Stats
- func (r *Stats) Header(key, value string) *Stats
- func (r *Stats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Stats) Metric(metrics ...string) *Stats
- func (r Stats) Perform(providedCtx context.Context) (*http.Response, error)
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type NewStats ¶
type NewStats func() *Stats
NewStats type alias for index.
func NewStatsFunc ¶
func NewStatsFunc(tp elastictransport.Interface) NewStats
NewStatsFunc returns a new instance of Stats with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
ClusterName string `json:"cluster_name"`
ManuallyStopped bool `json:"manually_stopped"`
NodeStats types.NodeStatistics `json:"_nodes"`
Stats []types.WatcherNodeStats `json:"stats"`
}
Response holds the response body struct for the package stats
type Stats ¶
type Stats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Stats
Retrieves the current Watcher metrics.
https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html
func (Stats) Do ¶
Do runs the request through the transport, handle the response and returns a stats.Response
func (*Stats) EmitStacktraces ¶
EmitStacktraces Defines whether stack traces are generated for each watch that is running. API name: emit_stacktraces
func (*Stats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Stats) IsSuccess ¶
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
Source Files