Documentation
¶
Overview ¶
Returns cluster nodes statistics.
Index ¶
- Variables
- type NewStats
- type Response
- type 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) FielddataFields(fields ...string) *Stats
- func (r *Stats) Fields(fields ...string) *Stats
- func (r *Stats) FilterPath(filterpaths ...string) *Stats
- func (r *Stats) Groups(groups bool) *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) IndexMetric(indexmetric string) *Stats
- func (r Stats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Stats) Level(level level.Level) *Stats
- func (r *Stats) MasterTimeout(duration string) *Stats
- func (r *Stats) Metric(metric string) *Stats
- 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
- func (r *Stats) Types(types ...string) *Stats
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 ¶ added in v8.7.0
type Response struct {
ClusterName *string `json:"cluster_name,omitempty"`
// NodeStats Contains statistics about the number of nodes selected by the request’s node
// filters.
NodeStats *types.NodeStatistics `json:"_nodes,omitempty"`
Nodes map[string]types.Stats `json:"nodes"`
}
Response holds the response body struct for the package stats
type Stats ¶
type Stats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Stats
Returns cluster nodes statistics.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
func (*Stats) CompletionFields ¶
CompletionFields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. API name: completion_fields
func (Stats) Do ¶
Do runs the request through the transport, handle the response and returns a stats.Response
func (*Stats) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Stats) FielddataFields ¶
FielddataFields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. API name: fielddata_fields
func (*Stats) Fields ¶
Fields Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields
func (*Stats) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Stats) Groups ¶
Groups Comma-separated list of search groups to include in the search statistics. API name: groups
func (*Stats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Stats) Human ¶ added in v8.14.0
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 ¶
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 ¶
IncludeUnloadedSegments If `true`, the response includes information from segments that are not loaded into memory. API name: include_unloaded_segments
func (*Stats) IndexMetric ¶
IndexMetric Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. API Name: indexmetric
func (Stats) IsSuccess ¶
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 ¶
Level Indicates whether statistics are aggregated at the cluster, index, or shard level. API name: level
func (*Stats) MasterTimeout ¶
MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout
func (*Stats) Metric ¶
Metric Limit the information returned to the specified metrics API Name: metric
func (*Stats) NodeId ¶
NodeId Comma-separated list of node IDs or names used to limit returned information. API Name: nodeid
func (Stats) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Stats) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
Source Files