stats

Documentation

Overview

Get index statistics. For data streams, the API retrieves statistics for the stream's backing indices.

By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards.

To get shard-level statistics, set the `level` parameter to `shards`.

NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

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) CompletionFields(fields ...string) *Stats
  • func (r Stats) Do(providedCtx context.Context) (*Response, error)
  • func (r *Stats) ErrorTrace(errortrace bool) *Stats
  • func (r *Stats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Stats
  • func (r *Stats) FielddataFields(fields ...string) *Stats
  • func (r *Stats) Fields(fields ...string) *Stats
  • func (r *Stats) FilterPath(filterpaths ...string) *Stats
  • func (r *Stats) ForbidClosedIndices(forbidclosedindices bool) *Stats
  • func (r *Stats) Groups(groups ...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) IncludeSegmentFileSizes(includesegmentfilesizes bool) *Stats
  • func (r *Stats) IncludeUnloadedSegments(includeunloadedsegments bool) *Stats
  • func (r *Stats) Index(index string) *Stats
  • func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Stats) Level(level level.Level) *Stats
  • func (r *Stats) Metric(metric string) *Stats
  • 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 {
	All_    types.IndicesStats            `json:"_all"`
	Indices map[string]types.IndicesStats `json:"indices,omitempty"`
	Shards_ types.ShardStatistics         `json:"_shards"`
}

Response holds the response body struct for the package stats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/stats/IndicesStatsResponse.ts#L24-L30

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 index statistics. For data streams, the API retrieves statistics for the stream's backing indices.

By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards.

To get shard-level statistics, set the `level` parameter to `shards`.

NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

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

func (*Stats) CompletionFields

func (r *Stats) CompletionFields(fields ...string) *Stats

CompletionFields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. API name: completion_fields

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) ExpandWildcards

func (r *Stats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Stats

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards

func (*Stats) FielddataFields

func (r *Stats) FielddataFields(fields ...string) *Stats

FielddataFields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. API name: fielddata_fields

func (*Stats) Fields

func (r *Stats) Fields(fields ...string) *Stats

Fields Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields

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) ForbidClosedIndices

func (r *Stats) ForbidClosedIndices(forbidclosedindices bool) *Stats

ForbidClosedIndices If true, statistics are not collected from closed indices. API name: forbid_closed_indices

func (*Stats) Groups

func (r *Stats) Groups(groups ...string) *Stats

Groups Comma-separated list of search groups to include in the search statistics. API name: groups

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) IncludeSegmentFileSizes

func (r *Stats) IncludeSegmentFileSizes(includesegmentfilesizes bool) *Stats

IncludeSegmentFileSizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). API name: include_segment_file_sizes

func (*Stats) IncludeUnloadedSegments

func (r *Stats) IncludeUnloadedSegments(includeunloadedsegments bool) *Stats

IncludeUnloadedSegments If true, the response includes information from segments that are not loaded into memory. API name: include_unloaded_segments

func (*Stats) Index

func (r *Stats) Index(index string) *Stats

Index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices API Name: index

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) Level

func (r *Stats) Level(level level.Level) *Stats

Level Indicates whether statistics are aggregated at the cluster, index, or shard level. API name: level

func (*Stats) Metric

func (r *Stats) Metric(metric string) *Stats

Metric Limit the information returned the specific metrics. API Name: metric

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