stats

Documentation

Overview

Returns high-level overview of cluster statistics.

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) FlatSettings(flatsettings 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) NodeId(nodeid string) *Stats
  • func (r Stats) Perform(providedCtx context.Context) (*http.Response, error)
  • 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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/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

Returns high-level overview of cluster statistics.

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

func (r *Stats) FlatSettings(flatsettings bool) *Stats

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

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