stats

Documentation

Overview

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.

Index

• Variables
• type NewStats
  • func NewStatsFunc(tp elastictransport.Interface) NewStats
• type Response
  • func NewResponse() *Response
• type Stats
  • func New(tp elastictransport.Interface) *Stats
  • func (r Stats) Do(providedCtx context.Context) (*Response, error)
  • func (r *Stats) ErrorTrace(errortrace bool) *Stats
  • func (r *Stats) FilterPath(filterpaths ...string) *Stats
  • func (r *Stats) Header(key, value string) *Stats
  • func (r *Stats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Stats) Human(human bool) *Stats
  • func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Stats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Stats) Pretty(pretty bool) *Stats

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.

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

type Response struct {

	// CacheStats Objects containing information about the enrich cache stats on each ingest
	// node.
	CacheStats []types.CacheStats `json:"cache_stats,omitempty"`
	// CoordinatorStats Objects containing information about each coordinating ingest node for
	// configured enrich processors.
	CoordinatorStats []types.CoordinatorStats `json:"coordinator_stats"`
	// ExecutingPolicies Objects containing information about each enrich policy that is currently
	// executing.
	ExecutingPolicies []types.ExecutingPolicy `json:"executing_policies"`
}

Response holds the response body struct for the package stats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/enrich/stats/EnrichStatsResponse.ts#L22-L39

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Stats

type Stats struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Stats

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.

https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html

func (Stats) Do

func (r Stats) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a stats.Response

func (*Stats) ErrorTrace

func (r *Stats) ErrorTrace(errortrace bool) *Stats

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Stats) FilterPath

func (r *Stats) FilterPath(filterpaths ...string) *Stats

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Stats) Header

func (r *Stats) Header(key, value string) *Stats

Header set a key, value pair in the Stats headers map.

func (*Stats) HttpRequest

func (r *Stats) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Stats) Human

func (r *Stats) Human(human bool) *Stats

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (Stats) IsSuccess

func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)

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.

func (Stats) Perform

func (r Stats) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Stats) Pretty

func (r *Stats) Pretty(pretty bool) *Stats

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty