stats

Documentation

Overview

Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

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) IncludeRemotes(includeremotes bool) *Stats
  • func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Stats) NodeId(nodeid string) *Stats
  • func (r Stats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Stats) Pretty(pretty bool) *Stats
  • func (r *Stats) Timeout(duration string) *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 {

	// ClusterName Name of the cluster, based on the cluster name setting.
	ClusterName string `json:"cluster_name"`
	// ClusterUuid Unique identifier for the cluster.
	ClusterUuid string `json:"cluster_uuid"`
	// Indices Contains statistics about indices with shards assigned to selected nodes.
	Indices types.ClusterIndices `json:"indices"`
	// NodeStats Contains statistics about the number of nodes selected by the request’s node
	// filters.
	NodeStats *types.NodeStatistics `json:"_nodes,omitempty"`
	// Nodes Contains statistics about nodes selected by the request’s node filters.
	Nodes types.ClusterNodes `json:"nodes"`
	// Status Health status of the cluster, based on the state of its primary and replica
	// shards.
	Status healthstatus.HealthStatus `json:"status"`
	// Timestamp Unix timestamp, in milliseconds, for the last time the cluster statistics
	// were refreshed.
	Timestamp int64 `json:"timestamp"`
}

Response holds the response body struct for the package stats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/cluster/stats/ClusterStatsResponse.ts#L53-L55

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 cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.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) IncludeRemotes

func (r *Stats) IncludeRemotes(includeremotes bool) *Stats

IncludeRemotes Include remote cluster data into the response API name: include_remotes

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

func (r *Stats) NodeId(nodeid string) *Stats

NodeId Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. API Name: nodeid

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

func (*Stats) Timeout

func (r *Stats) Timeout(duration string) *Stats

Timeout Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. API name: timeout