1
1
mirror of https://github.com/go-gitea/gitea synced 2024-11-01 15:54:25 +00:00
gitea/vendor/github.com/olivere/elastic/v7/indices_stats.go

531 lines
21 KiB
Go
Raw Normal View History

// Copyright 2012-present Oliver Eilhard. All rights reserved.
// Use of this source code is governed by a MIT-license.
// See http://olivere.mit-license.org/license.txt for details.
package elastic
import (
"context"
"fmt"
"net/http"
"net/url"
"strings"
"github.com/olivere/elastic/v7/uritemplates"
)
// IndicesStatsService provides stats on various metrics of one or more
// indices. See https://www.elastic.co/guide/en/elasticsearch/reference/7.0/indices-stats.html.
type IndicesStatsService struct {
client *Client
pretty *bool // pretty format the returned JSON response
human *bool // return human readable values for statistics
errorTrace *bool // include the stack trace of returned errors
filterPath []string // list of filters used to reduce the response
headers http.Header // custom request-level HTTP headers
metric []string
index []string
level string
types []string
completionFields []string
fielddataFields []string
fields []string
groups []string
}
// NewIndicesStatsService creates a new IndicesStatsService.
func NewIndicesStatsService(client *Client) *IndicesStatsService {
return &IndicesStatsService{
client: client,
index: make([]string, 0),
metric: make([]string, 0),
completionFields: make([]string, 0),
fielddataFields: make([]string, 0),
fields: make([]string, 0),
groups: make([]string, 0),
types: make([]string, 0),
}
}
// Pretty tells Elasticsearch whether to return a formatted JSON response.
func (s *IndicesStatsService) Pretty(pretty bool) *IndicesStatsService {
s.pretty = &pretty
return s
}
// Human specifies whether human readable values should be returned in
// the JSON response, e.g. "7.5mb".
func (s *IndicesStatsService) Human(human bool) *IndicesStatsService {
s.human = &human
return s
}
// ErrorTrace specifies whether to include the stack trace of returned errors.
func (s *IndicesStatsService) ErrorTrace(errorTrace bool) *IndicesStatsService {
s.errorTrace = &errorTrace
return s
}
// FilterPath specifies a list of filters used to reduce the response.
func (s *IndicesStatsService) FilterPath(filterPath ...string) *IndicesStatsService {
s.filterPath = filterPath
return s
}
// Header adds a header to the request.
func (s *IndicesStatsService) Header(name string, value string) *IndicesStatsService {
if s.headers == nil {
s.headers = http.Header{}
}
s.headers.Add(name, value)
return s
}
// Headers specifies the headers of the request.
func (s *IndicesStatsService) Headers(headers http.Header) *IndicesStatsService {
s.headers = headers
return s
}
// Metric limits the information returned the specific metrics. Options are:
// docs, store, indexing, get, search, completion, fielddata, flush, merge,
// query_cache, refresh, suggest, and warmer.
func (s *IndicesStatsService) Metric(metric ...string) *IndicesStatsService {
s.metric = append(s.metric, metric...)
return s
}
// Index is the list of index names; use `_all` or empty string to perform
// the operation on all indices.
func (s *IndicesStatsService) Index(indices ...string) *IndicesStatsService {
s.index = append(s.index, indices...)
return s
}
// Type is a list of document types for the `indexing` index metric.
func (s *IndicesStatsService) Type(types ...string) *IndicesStatsService {
s.types = append(s.types, types...)
return s
}
// Level returns stats aggregated at cluster, index or shard level.
func (s *IndicesStatsService) Level(level string) *IndicesStatsService {
s.level = level
return s
}
// CompletionFields is a list of fields for `fielddata` and `suggest`
// index metric (supports wildcards).
func (s *IndicesStatsService) CompletionFields(completionFields ...string) *IndicesStatsService {
s.completionFields = append(s.completionFields, completionFields...)
return s
}
// FielddataFields is a list of fields for `fielddata` index metric (supports wildcards).
func (s *IndicesStatsService) FielddataFields(fielddataFields ...string) *IndicesStatsService {
s.fielddataFields = append(s.fielddataFields, fielddataFields...)
return s
}
// Fields is a list of fields for `fielddata` and `completion` index metric
// (supports wildcards).
func (s *IndicesStatsService) Fields(fields ...string) *IndicesStatsService {
s.fields = append(s.fields, fields...)
return s
}
// Groups is a list of search groups for `search` index metric.
func (s *IndicesStatsService) Groups(groups ...string) *IndicesStatsService {
s.groups = append(s.groups, groups...)
return s
}
// buildURL builds the URL for the operation.
func (s *IndicesStatsService) buildURL() (string, url.Values, error) {
var err error
var path string
if len(s.index) > 0 && len(s.metric) > 0 {
path, err = uritemplates.Expand("/{index}/_stats/{metric}", map[string]string{
"index": strings.Join(s.index, ","),
"metric": strings.Join(s.metric, ","),
})
} else if len(s.index) > 0 {
path, err = uritemplates.Expand("/{index}/_stats", map[string]string{
"index": strings.Join(s.index, ","),
})
} else if len(s.metric) > 0 {
path, err = uritemplates.Expand("/_stats/{metric}", map[string]string{
"metric": strings.Join(s.metric, ","),
})
} else {
path = "/_stats"
}
if err != nil {
return "", url.Values{}, err
}
// Add query string parameters
params := url.Values{}
if v := s.pretty; v != nil {
params.Set("pretty", fmt.Sprint(*v))
}
if v := s.human; v != nil {
params.Set("human", fmt.Sprint(*v))
}
if v := s.errorTrace; v != nil {
params.Set("error_trace", fmt.Sprint(*v))
}
if len(s.filterPath) > 0 {
params.Set("filter_path", strings.Join(s.filterPath, ","))
}
if len(s.groups) > 0 {
params.Set("groups", strings.Join(s.groups, ","))
}
if s.level != "" {
params.Set("level", s.level)
}
if len(s.types) > 0 {
params.Set("types", strings.Join(s.types, ","))
}
if len(s.completionFields) > 0 {
params.Set("completion_fields", strings.Join(s.completionFields, ","))
}
if len(s.fielddataFields) > 0 {
params.Set("fielddata_fields", strings.Join(s.fielddataFields, ","))
}
if len(s.fields) > 0 {
params.Set("fields", strings.Join(s.fields, ","))
}
return path, params, nil
}
// Validate checks if the operation is valid.
func (s *IndicesStatsService) Validate() error {
return nil
}
// Do executes the operation.
func (s *IndicesStatsService) Do(ctx context.Context) (*IndicesStatsResponse, error) {
// Check pre-conditions
if err := s.Validate(); err != nil {
return nil, err
}
// Get URL for request
path, params, err := s.buildURL()
if err != nil {
return nil, err
}
// Get HTTP response
res, err := s.client.PerformRequest(ctx, PerformRequestOptions{
Method: "GET",
Path: path,
Params: params,
Headers: s.headers,
})
if err != nil {
return nil, err
}
// Return operation response
ret := new(IndicesStatsResponse)
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
return nil, err
}
return ret, nil
}
// IndicesStatsResponse is the response of IndicesStatsService.Do.
type IndicesStatsResponse struct {
// Shards provides information returned from shards.
Shards *ShardsInfo `json:"_shards"`
// All provides summary stats about all indices.
All *IndexStats `json:"_all,omitempty"`
// Indices provides a map into the stats of an index. The key of the
// map is the index name.
Indices map[string]*IndexStats `json:"indices,omitempty"`
}
// IndexStats is index stats for a specific index.
type IndexStats struct {
UUID string `json:"uuid,omitempty"`
Primaries *IndexStatsDetails `json:"primaries,omitempty"`
Total *IndexStatsDetails `json:"total,omitempty"`
Shards map[string][]*IndexStatsDetails `json:"shards,omitempty"`
}
type IndexStatsDetails struct {
Routing *IndexStatsRouting `json:"routing,omitempty"`
Docs *IndexStatsDocs `json:"docs,omitempty"`
Store *IndexStatsStore `json:"store,omitempty"`
Indexing *IndexStatsIndexing `json:"indexing,omitempty"`
Get *IndexStatsGet `json:"get,omitempty"`
Search *IndexStatsSearch `json:"search,omitempty"`
Merges *IndexStatsMerges `json:"merges,omitempty"`
Refresh *IndexStatsRefresh `json:"refresh,omitempty"`
Recovery *IndexStatsRecovery `json:"recovery,omitempty"`
Flush *IndexStatsFlush `json:"flush,omitempty"`
Warmer *IndexStatsWarmer `json:"warmer,omitempty"`
FilterCache *IndexStatsFilterCache `json:"filter_cache,omitempty"`
IdCache *IndexStatsIdCache `json:"id_cache,omitempty"`
Fielddata *IndexStatsFielddata `json:"fielddata,omitempty"`
Percolate *IndexStatsPercolate `json:"percolate,omitempty"`
Completion *IndexStatsCompletion `json:"completion,omitempty"`
Segments *IndexStatsSegments `json:"segments,omitempty"`
Translog *IndexStatsTranslog `json:"translog,omitempty"`
Suggest *IndexStatsSuggest `json:"suggest,omitempty"`
QueryCache *IndexStatsQueryCache `json:"query_cache,omitempty"`
RequestCache *IndexStatsRequestCache `json:"request_cache,omitempty"`
Commit *IndexStatsCommit `json:"commit,omitempty"`
SeqNo *IndexStatsSeqNo `json:"seq_no,omitempty"`
RetentionLeases *IndexStatsRetentionLeases `json:"retention_leases,omitempty"`
ShardPath *IndexStatsShardPath `json:"shard_path,omitempty"`
}
type IndexStatsRouting struct {
State string `json:"state"` // e.g. "STARTED"
Primary bool `json:"primary"`
Node string `json:"node"` // e.g. "-aXnGv4oTW6bIIl0db3eCg"
RelocatingNode *string `json:"relocating_node"`
}
type IndexStatsShardPath struct {
StatePath string `json:"state_path"` // e.g. "/usr/share/elasticsearch/data/nodes/0"
DataPath string `json:"data_path"` // e.g. "/usr/share/elasticsearch/data/nodes/0"
IsCustomDataPath bool `json:"is_custom_data_path"`
}
type IndexStatsDocs struct {
Count int64 `json:"count,omitempty"`
Deleted int64 `json:"deleted,omitempty"`
}
type IndexStatsStore struct {
Size string `json:"size,omitempty"` // human size, e.g. 119.3mb
SizeInBytes int64 `json:"size_in_bytes,omitempty"`
}
type IndexStatsIndexing struct {
IndexTotal int64 `json:"index_total,omitempty"`
IndexTime string `json:"index_time,omitempty"`
IndexTimeInMillis int64 `json:"index_time_in_millis,omitempty"`
IndexCurrent int64 `json:"index_current,omitempty"`
IndexFailed int64 `json:"index_failed,omitempty"`
DeleteTotal int64 `json:"delete_total,omitempty"`
DeleteTime string `json:"delete_time,omitempty"`
DeleteTimeInMillis int64 `json:"delete_time_in_millis,omitempty"`
DeleteCurrent int64 `json:"delete_current,omitempty"`
NoopUpdateTotal int64 `json:"noop_update_total,omitempty"`
IsThrottled bool `json:"is_throttled,omitempty"`
ThrottleTime string `json:"throttle_time,omitempty"`
ThrottleTimeInMillis int64 `json:"throttle_time_in_millis,omitempty"`
}
type IndexStatsGet struct {
Total int64 `json:"total,omitempty"`
GetTime string `json:"getTime,omitempty"` // 7.4.0 uses "getTime", earlier versions used "get_time"
TimeInMillis int64 `json:"time_in_millis,omitempty"`
ExistsTotal int64 `json:"exists_total,omitempty"`
ExistsTime string `json:"exists_time,omitempty"`
ExistsTimeInMillis int64 `json:"exists_time_in_millis,omitempty"`
MissingTotal int64 `json:"missing_total,omitempty"`
MissingTime string `json:"missing_time,omitempty"`
MissingTimeInMillis int64 `json:"missing_time_in_millis,omitempty"`
Current int64 `json:"current,omitempty"`
}
type IndexStatsSearch struct {
OpenContexts int64 `json:"open_contexts,omitempty"`
QueryTotal int64 `json:"query_total,omitempty"`
QueryTime string `json:"query_time,omitempty"`
QueryTimeInMillis int64 `json:"query_time_in_millis,omitempty"`
QueryCurrent int64 `json:"query_current,omitempty"`
FetchTotal int64 `json:"fetch_total,omitempty"`
FetchTime string `json:"fetch_time,omitempty"`
FetchTimeInMillis int64 `json:"fetch_time_in_millis,omitempty"`
FetchCurrent int64 `json:"fetch_current,omitempty"`
ScrollTotal int64 `json:"scroll_total,omitempty"`
ScrollTime string `json:"scroll_time,omitempty"`
ScrollTimeInMillis int64 `json:"scroll_time_in_millis,omitempty"`
ScrollCurrent int64 `json:"scroll_current,omitempty"`
SuggestTotal int64 `json:"suggest_total,omitempty"`
SuggestTime string `json:"suggest_time,omitempty"`
SuggestTimeInMillis int64 `json:"suggest_time_in_millis,omitempty"`
SuggestCurrent int64 `json:"suggest_current,omitempty"`
}
type IndexStatsMerges struct {
Current int64 `json:"current,omitempty"`
CurrentDocs int64 `json:"current_docs,omitempty"`
CurrentSize string `json:"current_size,omitempty"`
CurrentSizeInBytes int64 `json:"current_size_in_bytes,omitempty"`
Total int64 `json:"total,omitempty"`
TotalTime string `json:"total_time,omitempty"`
TotalTimeInMillis int64 `json:"total_time_in_millis,omitempty"`
TotalDocs int64 `json:"total_docs,omitempty"`
TotalSize string `json:"total_size,omitempty"`
TotalSizeInBytes int64 `json:"total_size_in_bytes,omitempty"`
TotalStoppedTime string `json:"total_stopped_time,omitempty"`
TotalStoppedTimeInMillis int64 `json:"total_stopped_time_in_millis,omitempty"`
TotalThrottledTime string `json:"total_throttled_time,omitempty"`
TotalThrottledTimeInMillis int64 `json:"total_throttled_time_in_millis,omitempty"`
TotalAutoThrottle string `json:"total_auto_throttle,omitempty"`
TotalAutoThrottleInBytes int64 `json:"total_auto_throttle_in_bytes,omitempty"`
}
type IndexStatsRefresh struct {
Total int64 `json:"total,omitempty"`
TotalTime string `json:"total_time,omitempty"`
TotalTimeInMillis int64 `json:"total_time_in_millis,omitempty"`
ExternalTotal int64 `json:"external_total,omitempty"`
ExternalTotalTime string `json:"external_total_time,omitempty"`
ExternalTotalTimeInMillis int64 `json:"external_total_time_in_millis,omitempty"`
Listeners int64 `json:"listeners,omitempty"`
}
type IndexStatsRecovery struct {
CurrentAsSource int64 `json:"current_as_source,omitempty"`
CurrentAsTarget int64 `json:"current_as_target,omitempty"`
ThrottleTime string `json:"throttle_time,omitempty"`
ThrottleTimeInMillis int64 `json:"throttle_time_in_millis,omitempty"`
}
type IndexStatsFlush struct {
Total int64 `json:"total,omitempty"`
TotalTime string `json:"total_time,omitempty"`
TotalTimeInMillis int64 `json:"total_time_in_millis,omitempty"`
Periodic int64 `json:"periodic,omitempty"`
}
type IndexStatsWarmer struct {
Current int64 `json:"current,omitempty"`
Total int64 `json:"total,omitempty"`
TotalTime string `json:"total_time,omitempty"`
TotalTimeInMillis int64 `json:"total_time_in_millis,omitempty"`
}
type IndexStatsRequestCache struct {
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
Evictions int64 `json:"evictions,omitempty"`
HitCount int64 `json:"hit_count,omitempty"`
MissCount int64 `json:"miss_count,omitempty"`
}
type IndexStatsCommit struct {
ID string `json:"id,omitempty"` // lucene commit ID in base64, e.g. "m2tDMYHzSpSV6zJH0lIAnA=="
Generation int64 `json:"generation,omitempty"`
UserData map[string]string `json:"user_data,omitempty"`
NumDocs int64 `json:"num_docs,omitempty"`
}
type IndexStatsFilterCache struct {
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
Evictions int64 `json:"evictions,omitempty"`
}
type IndexStatsIdCache struct {
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
}
type IndexStatsFielddata struct {
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
Evictions int64 `json:"evictions,omitempty"`
}
type IndexStatsPercolate struct {
Total int64 `json:"total,omitempty"`
GetTime string `json:"get_time,omitempty"`
TimeInMillis int64 `json:"time_in_millis,omitempty"`
Current int64 `json:"current,omitempty"`
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
Queries int64 `json:"queries,omitempty"`
}
type IndexStatsCompletion struct {
Size string `json:"size,omitempty"`
SizeInBytes int64 `json:"size_in_bytes,omitempty"`
}
type IndexStatsSegments struct {
Count int64 `json:"count"`
Memory string `json:"memory"` // e.g. "61.3kb"
MemoryInBytes int64 `json:"memory_in_bytes"`
TermsMemory string `json:"terms_memory"` // e.g. "61.3kb"
TermsMemoryInBytes int64 `json:"terms_memory_in_bytes"`
StoredFieldsMemory string `json:"stored_fields_memory"` // e.g. "61.3kb"
StoredFieldsMemoryInBytes int64 `json:"stored_fields_memory_in_bytes"`
TermVectorsMemory string `json:"term_vectors_memory"` // e.g. "61.3kb"
TermVectorsMemoryInBytes int64 `json:"term_vectors_memory_in_bytes"`
NormsMemory string `json:"norms_memory"` // e.g. "61.3kb"
NormsMemoryInBytes int64 `json:"norms_memory_in_bytes"`
PointsMemory string `json:"points_memory"` // e.g. "61.3kb"
PointsMemoryInBytes int64 `json:"points_memory_in_bytes"`
DocValuesMemory string `json:"doc_values_memory"` // e.g. "61.3kb"
DocValuesMemoryInBytes int64 `json:"doc_values_memory_in_bytes"`
IndexWriterMemory string `json:"index_writer_memory"` // e.g. "61.3kb"
IndexWriterMemoryInBytes int64 `json:"index_writer_memory_in_bytes"`
VersionMapMemory string `json:"version_map_memory"` // e.g. "61.3kb"
VersionMapMemoryInBytes int64 `json:"version_map_memory_in_bytes"`
FixedBitSet string `json:"fixed_bit_set"` // e.g. "61.3kb"
FixedBitSetInBytes int64 `json:"fixed_bit_set_memory_in_bytes"`
MaxUnsafeAutoIDTimestamp int64 `json:"max_unsafe_auto_id_timestamp"`
FileSizes map[string]*ClusterStatsIndicesSegmentsFile `json:"file_sizes"`
}
type IndexStatsTranslog struct {
Operations int64 `json:"operations,omitempty"`
Size string `json:"size,omitempty"`
SizeInBytes int64 `json:"size_in_bytes,omitempty"`
UncommittedOperations int64 `json:"uncommitted_operations,omitempty"`
UncommittedSize string `json:"uncommitted_size,omitempty"`
UncommittedSizeInBytes int64 `json:"uncommitted_size_in_bytes,omitempty"`
EarliestLastModifiedAge int64 `json:"earliest_last_modified_age,omitempty"`
}
type IndexStatsSuggest struct {
Total int64 `json:"total,omitempty"`
Time string `json:"time,omitempty"`
TimeInMillis int64 `json:"time_in_millis,omitempty"`
Current int64 `json:"current,omitempty"`
}
type IndexStatsQueryCache struct {
MemorySize string `json:"memory_size,omitempty"`
MemorySizeInBytes int64 `json:"memory_size_in_bytes,omitempty"`
TotalCount int64 `json:"total_count,omitempty"`
HitCount int64 `json:"hit_count,omitempty"`
MissCount int64 `json:"miss_count,omitempty"`
CacheSize int64 `json:"cache_size,omitempty"`
CacheCount int64 `json:"cache_count,omitempty"`
Evictions int64 `json:"evictions,omitempty"`
}
type IndexStatsSeqNo struct {
MaxSeqNo int64 `json:"max_seq_no,omitempty"`
LocalCheckpoint int64 `json:"local_checkpoint,omitempty"`
GlobalCheckpoint int64 `json:"global_checkpoint,omitempty"`
}
type IndexStatsRetentionLeases struct {
PrimaryTerm int64 `json:"primary_term,omitempty"`
Version int64 `json:"version,omitempty"`
Leases []*IndexStatsRetentionLease `json:"leases,omitempty"`
}
type IndexStatsRetentionLease struct {
Id string `json:"id,omitempty"`
RetainingSeqNo int64 `json:"retaining_seq_no,omitempty"`
Timestamp int64 `json:"timestamp,omitempty"`
Source string `json:"source,omitempty"`
}