followstats

Documentation

Overview

Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

Index

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

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 FollowStats

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

func New

func New(tp elastictransport.Interface) *FollowStats

Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html

func (FollowStats) Do

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

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

func (*FollowStats) ErrorTrace

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

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

func (*FollowStats) FilterPath

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

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

func (*FollowStats) Header

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

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

func (*FollowStats) HttpRequest

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

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

func (*FollowStats) Human

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

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 (FollowStats) IsSuccess

func (r FollowStats) 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 (FollowStats) Perform

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

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

func (*FollowStats) Pretty

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

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

type NewFollowStats

type NewFollowStats func(index string) *FollowStats

NewFollowStats type alias for index.

func NewFollowStatsFunc

func NewFollowStatsFunc(tp elastictransport.Interface) NewFollowStats

NewFollowStatsFunc returns a new instance of FollowStats 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 {
	Indices []types.FollowIndexStats `json:"indices"`
}

Response holds the response body struct for the package followstats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response