This change adds `access` format support for notifications to a Elasticsearch server, and it refactors `namespace` format support. In the case of `access` format, for each event in Minio, a JSON document is inserted into Elasticsearch with its timestamp set to the event's timestamp, and with the ID generated automatically by elasticsearch. No events are modified or deleted in this mode. In the case of `namespace` format, for each event in Minio, a JSON document is keyed together by the bucket and object name is updated in Elasticsearch. In the case of an object being created or over-written in Minio, a new document or an existing document is inserted into the Elasticsearch index. If an object is deleted in Minio, the corresponding document is deleted from the Elasticsearch index. Additionally, this change upgrades Elasticsearch support to the 5.x series. This is a breaking change, and users of previous elasticsearch versions should upgrade. Also updates documentation on Elasticsearch notification target usage and has a link to an elasticsearch upgrade guide. This is the last patch that finally resolves #3928.
170 lines
4.9 KiB
Go
170 lines
4.9 KiB
Go
// 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 (
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"golang.org/x/net/context"
|
|
|
|
"gopkg.in/olivere/elastic.v5/uritemplates"
|
|
)
|
|
|
|
// Flush allows to flush one or more indices. The flush process of an index
|
|
// basically frees memory from the index by flushing data to the index
|
|
// storage and clearing the internal transaction log.
|
|
//
|
|
// See https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-flush.html
|
|
// for details.
|
|
type IndicesFlushService struct {
|
|
client *Client
|
|
pretty bool
|
|
index []string
|
|
force *bool
|
|
waitIfOngoing *bool
|
|
ignoreUnavailable *bool
|
|
allowNoIndices *bool
|
|
expandWildcards string
|
|
}
|
|
|
|
// NewIndicesFlushService creates a new IndicesFlushService.
|
|
func NewIndicesFlushService(client *Client) *IndicesFlushService {
|
|
return &IndicesFlushService{
|
|
client: client,
|
|
index: make([]string, 0),
|
|
}
|
|
}
|
|
|
|
// Index is a list of index names; use `_all` or empty string for all indices.
|
|
func (s *IndicesFlushService) Index(indices ...string) *IndicesFlushService {
|
|
s.index = append(s.index, indices...)
|
|
return s
|
|
}
|
|
|
|
// Force indicates whether a flush should be forced even if it is not
|
|
// necessarily needed ie. if no changes will be committed to the index.
|
|
// This is useful if transaction log IDs should be incremented even if
|
|
// no uncommitted changes are present. (This setting can be considered as internal).
|
|
func (s *IndicesFlushService) Force(force bool) *IndicesFlushService {
|
|
s.force = &force
|
|
return s
|
|
}
|
|
|
|
// WaitIfOngoing, if set to true, indicates that the flush operation will
|
|
// block until the flush can be executed if another flush operation is
|
|
// already executing. The default is false and will cause an exception
|
|
// to be thrown on the shard level if another flush operation is already running..
|
|
func (s *IndicesFlushService) WaitIfOngoing(waitIfOngoing bool) *IndicesFlushService {
|
|
s.waitIfOngoing = &waitIfOngoing
|
|
return s
|
|
}
|
|
|
|
// IgnoreUnavailable indicates whether specified concrete indices should be
|
|
// ignored when unavailable (missing or closed).
|
|
func (s *IndicesFlushService) IgnoreUnavailable(ignoreUnavailable bool) *IndicesFlushService {
|
|
s.ignoreUnavailable = &ignoreUnavailable
|
|
return s
|
|
}
|
|
|
|
// AllowNoIndices indicates whether to ignore if a wildcard indices expression
|
|
// resolves into no concrete indices. (This includes `_all` string or when
|
|
// no indices have been specified).
|
|
func (s *IndicesFlushService) AllowNoIndices(allowNoIndices bool) *IndicesFlushService {
|
|
s.allowNoIndices = &allowNoIndices
|
|
return s
|
|
}
|
|
|
|
// ExpandWildcards specifies whether to expand wildcard expression to
|
|
// concrete indices that are open, closed or both..
|
|
func (s *IndicesFlushService) ExpandWildcards(expandWildcards string) *IndicesFlushService {
|
|
s.expandWildcards = expandWildcards
|
|
return s
|
|
}
|
|
|
|
// Pretty indicates that the JSON response be indented and human readable.
|
|
func (s *IndicesFlushService) Pretty(pretty bool) *IndicesFlushService {
|
|
s.pretty = pretty
|
|
return s
|
|
}
|
|
|
|
// buildURL builds the URL for the operation.
|
|
func (s *IndicesFlushService) buildURL() (string, url.Values, error) {
|
|
// Build URL
|
|
var err error
|
|
var path string
|
|
|
|
if len(s.index) > 0 {
|
|
path, err = uritemplates.Expand("/{index}/_flush", map[string]string{
|
|
"index": strings.Join(s.index, ","),
|
|
})
|
|
} else {
|
|
path = "/_flush"
|
|
}
|
|
if err != nil {
|
|
return "", url.Values{}, err
|
|
}
|
|
|
|
// Add query string parameters
|
|
params := url.Values{}
|
|
if s.pretty {
|
|
params.Set("pretty", "1")
|
|
}
|
|
if s.force != nil {
|
|
params.Set("force", fmt.Sprintf("%v", *s.force))
|
|
}
|
|
if s.waitIfOngoing != nil {
|
|
params.Set("wait_if_ongoing", fmt.Sprintf("%v", *s.waitIfOngoing))
|
|
}
|
|
if s.ignoreUnavailable != nil {
|
|
params.Set("ignore_unavailable", fmt.Sprintf("%v", *s.ignoreUnavailable))
|
|
}
|
|
if s.allowNoIndices != nil {
|
|
params.Set("allow_no_indices", fmt.Sprintf("%v", *s.allowNoIndices))
|
|
}
|
|
if s.expandWildcards != "" {
|
|
params.Set("expand_wildcards", s.expandWildcards)
|
|
}
|
|
return path, params, nil
|
|
}
|
|
|
|
// Validate checks if the operation is valid.
|
|
func (s *IndicesFlushService) Validate() error {
|
|
return nil
|
|
}
|
|
|
|
// Do executes the service.
|
|
func (s *IndicesFlushService) Do(ctx context.Context) (*IndicesFlushResponse, 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, "POST", path, params, nil)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Return operation response
|
|
ret := new(IndicesFlushResponse)
|
|
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
|
|
return nil, err
|
|
}
|
|
return ret, nil
|
|
}
|
|
|
|
// -- Result of a flush request.
|
|
|
|
type IndicesFlushResponse struct {
|
|
Shards shardsInfo `json:"_shards"`
|
|
}
|