The highest tagged major version is
Documentation
¶
Overview ¶
Get field usage stats. Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
Index ¶
- Variables
- type FieldUsageStats
- func (r *FieldUsageStats) AllowNoIndices(allownoindices bool) *FieldUsageStats
- func (r FieldUsageStats) Do(providedCtx context.Context) (*Response, error)
- func (r *FieldUsageStats) ErrorTrace(errortrace bool) *FieldUsageStats
- func (r *FieldUsageStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *FieldUsageStats
- func (r *FieldUsageStats) Fields(fields ...string) *FieldUsageStats
- func (r *FieldUsageStats) FilterPath(filterpaths ...string) *FieldUsageStats
- func (r *FieldUsageStats) Header(key, value string) *FieldUsageStats
- func (r *FieldUsageStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *FieldUsageStats) Human(human bool) *FieldUsageStats
- func (r *FieldUsageStats) IgnoreUnavailable(ignoreunavailable bool) *FieldUsageStats
- func (r FieldUsageStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r FieldUsageStats) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *FieldUsageStats) Pretty(pretty bool) *FieldUsageStats
- type NewFieldUsageStats
- type Response
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 FieldUsageStats ¶
type FieldUsageStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *FieldUsageStats
Get field usage stats. Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.
The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.
https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html
func (*FieldUsageStats) AllowNoIndices ¶
func (r *FieldUsageStats) AllowNoIndices(allownoindices bool) *FieldUsageStats
AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices
func (FieldUsageStats) Do ¶
func (r FieldUsageStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a fieldusagestats.Response
func (*FieldUsageStats) ErrorTrace ¶ added in v8.14.0
func (r *FieldUsageStats) ErrorTrace(errortrace bool) *FieldUsageStats
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*FieldUsageStats) ExpandWildcards ¶
func (r *FieldUsageStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *FieldUsageStats
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 (*FieldUsageStats) Fields ¶
func (r *FieldUsageStats) Fields(fields ...string) *FieldUsageStats
Fields Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields
func (*FieldUsageStats) FilterPath ¶ added in v8.14.0
func (r *FieldUsageStats) FilterPath(filterpaths ...string) *FieldUsageStats
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*FieldUsageStats) Header ¶
func (r *FieldUsageStats) Header(key, value string) *FieldUsageStats
Header set a key, value pair in the FieldUsageStats headers map.
func (*FieldUsageStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*FieldUsageStats) Human ¶ added in v8.14.0
func (r *FieldUsageStats) Human(human bool) *FieldUsageStats
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 (*FieldUsageStats) IgnoreUnavailable ¶
func (r *FieldUsageStats) IgnoreUnavailable(ignoreunavailable bool) *FieldUsageStats
IgnoreUnavailable If `true`, missing or closed indices are not included in the response. API name: ignore_unavailable
func (FieldUsageStats) IsSuccess ¶
func (r FieldUsageStats) 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 (FieldUsageStats) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*FieldUsageStats) Pretty ¶ added in v8.14.0
func (r *FieldUsageStats) Pretty(pretty bool) *FieldUsageStats
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewFieldUsageStats ¶
type NewFieldUsageStats func(index string) *FieldUsageStats
NewFieldUsageStats type alias for index.
func NewFieldUsageStatsFunc ¶
func NewFieldUsageStatsFunc(tp elastictransport.Interface) NewFieldUsageStats
NewFieldUsageStatsFunc returns a new instance of FieldUsageStats 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 {
FieldsUsageBody map[string]types.UsageStatsIndex `json:"-"`
Shards_ types.ShardStatistics `json:"_shards"`
}
Response holds the response body struct for the package fieldusagestats
Source Files