Documentation
¶
Overview ¶
Provides statistics on operations happening in an index.
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) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Stats
- func (r *Stats) FielddataFields(fields ...string) *Stats
- func (r *Stats) Fields(fields ...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) 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)
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 {
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
type Stats ¶
type Stats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Stats
Provides statistics on operations happening in an index.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-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) 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 ¶
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) ForbidClosedIndices ¶
ForbidClosedIndices If true, statistics are not collected from closed indices. API name: forbid_closed_indices
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) 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) Index ¶
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 ¶
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
Source Files