a2a8d54bb6
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.
245 lines
8 KiB
Go
245 lines
8 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"
|
|
)
|
|
|
|
// ClusterHealthService allows to get a very simple status on the health of the cluster.
|
|
//
|
|
// See http://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-health.html
|
|
// for details.
|
|
type ClusterHealthService struct {
|
|
client *Client
|
|
pretty bool
|
|
indices []string
|
|
level string
|
|
local *bool
|
|
masterTimeout string
|
|
timeout string
|
|
waitForActiveShards *int
|
|
waitForNodes string
|
|
waitForNoRelocatingShards *bool
|
|
waitForStatus string
|
|
}
|
|
|
|
// NewClusterHealthService creates a new ClusterHealthService.
|
|
func NewClusterHealthService(client *Client) *ClusterHealthService {
|
|
return &ClusterHealthService{
|
|
client: client,
|
|
indices: make([]string, 0),
|
|
}
|
|
}
|
|
|
|
// Index limits the information returned to specific indices.
|
|
func (s *ClusterHealthService) Index(indices ...string) *ClusterHealthService {
|
|
s.indices = append(s.indices, indices...)
|
|
return s
|
|
}
|
|
|
|
// Level specifies the level of detail for returned information.
|
|
func (s *ClusterHealthService) Level(level string) *ClusterHealthService {
|
|
s.level = level
|
|
return s
|
|
}
|
|
|
|
// Local indicates whether to return local information. If it is true,
|
|
// we do not retrieve the state from master node (default: false).
|
|
func (s *ClusterHealthService) Local(local bool) *ClusterHealthService {
|
|
s.local = &local
|
|
return s
|
|
}
|
|
|
|
// MasterTimeout specifies an explicit operation timeout for connection to master node.
|
|
func (s *ClusterHealthService) MasterTimeout(masterTimeout string) *ClusterHealthService {
|
|
s.masterTimeout = masterTimeout
|
|
return s
|
|
}
|
|
|
|
// Timeout specifies an explicit operation timeout.
|
|
func (s *ClusterHealthService) Timeout(timeout string) *ClusterHealthService {
|
|
s.timeout = timeout
|
|
return s
|
|
}
|
|
|
|
// WaitForActiveShards can be used to wait until the specified number of shards are active.
|
|
func (s *ClusterHealthService) WaitForActiveShards(waitForActiveShards int) *ClusterHealthService {
|
|
s.waitForActiveShards = &waitForActiveShards
|
|
return s
|
|
}
|
|
|
|
// WaitForNodes can be used to wait until the specified number of nodes are available.
|
|
// Example: "12" to wait for exact values, ">12" and "<12" for ranges.
|
|
func (s *ClusterHealthService) WaitForNodes(waitForNodes string) *ClusterHealthService {
|
|
s.waitForNodes = waitForNodes
|
|
return s
|
|
}
|
|
|
|
// WaitForNoRelocatingShards can be used to wait until all shard relocations are finished.
|
|
func (s *ClusterHealthService) WaitForNoRelocatingShards(waitForNoRelocatingShards bool) *ClusterHealthService {
|
|
s.waitForNoRelocatingShards = &waitForNoRelocatingShards
|
|
return s
|
|
}
|
|
|
|
// WaitForStatus can be used to wait until the cluster is in a specific state.
|
|
// Valid values are: green, yellow, or red.
|
|
func (s *ClusterHealthService) WaitForStatus(waitForStatus string) *ClusterHealthService {
|
|
s.waitForStatus = waitForStatus
|
|
return s
|
|
}
|
|
|
|
// WaitForGreenStatus will wait for the "green" state.
|
|
func (s *ClusterHealthService) WaitForGreenStatus() *ClusterHealthService {
|
|
return s.WaitForStatus("green")
|
|
}
|
|
|
|
// WaitForYellowStatus will wait for the "yellow" state.
|
|
func (s *ClusterHealthService) WaitForYellowStatus() *ClusterHealthService {
|
|
return s.WaitForStatus("yellow")
|
|
}
|
|
|
|
// Pretty indicates that the JSON response be indented and human readable.
|
|
func (s *ClusterHealthService) Pretty(pretty bool) *ClusterHealthService {
|
|
s.pretty = pretty
|
|
return s
|
|
}
|
|
|
|
// buildURL builds the URL for the operation.
|
|
func (s *ClusterHealthService) buildURL() (string, url.Values, error) {
|
|
// Build URL
|
|
var err error
|
|
var path string
|
|
if len(s.indices) > 0 {
|
|
path, err = uritemplates.Expand("/_cluster/health/{index}", map[string]string{
|
|
"index": strings.Join(s.indices, ","),
|
|
})
|
|
} else {
|
|
path = "/_cluster/health"
|
|
}
|
|
if err != nil {
|
|
return "", url.Values{}, err
|
|
}
|
|
|
|
// Add query string parameters
|
|
params := url.Values{}
|
|
if s.pretty {
|
|
params.Set("pretty", "1")
|
|
}
|
|
if s.level != "" {
|
|
params.Set("level", s.level)
|
|
}
|
|
if s.local != nil {
|
|
params.Set("local", fmt.Sprintf("%v", *s.local))
|
|
}
|
|
if s.masterTimeout != "" {
|
|
params.Set("master_timeout", s.masterTimeout)
|
|
}
|
|
if s.timeout != "" {
|
|
params.Set("timeout", s.timeout)
|
|
}
|
|
if s.waitForActiveShards != nil {
|
|
params.Set("wait_for_active_shards", fmt.Sprintf("%v", s.waitForActiveShards))
|
|
}
|
|
if s.waitForNodes != "" {
|
|
params.Set("wait_for_nodes", s.waitForNodes)
|
|
}
|
|
if s.waitForNoRelocatingShards != nil {
|
|
params.Set("wait_for_no_relocating_shards", fmt.Sprintf("%v", *s.waitForNoRelocatingShards))
|
|
}
|
|
if s.waitForStatus != "" {
|
|
params.Set("wait_for_status", s.waitForStatus)
|
|
}
|
|
return path, params, nil
|
|
}
|
|
|
|
// Validate checks if the operation is valid.
|
|
func (s *ClusterHealthService) Validate() error {
|
|
return nil
|
|
}
|
|
|
|
// Do executes the operation.
|
|
func (s *ClusterHealthService) Do(ctx context.Context) (*ClusterHealthResponse, 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, "GET", path, params, nil)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Return operation response
|
|
ret := new(ClusterHealthResponse)
|
|
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
|
|
return nil, err
|
|
}
|
|
return ret, nil
|
|
}
|
|
|
|
// ClusterHealthResponse is the response of ClusterHealthService.Do.
|
|
type ClusterHealthResponse struct {
|
|
ClusterName string `json:"cluster_name"`
|
|
Status string `json:"status"`
|
|
TimedOut bool `json:"timed_out"`
|
|
NumberOfNodes int `json:"number_of_nodes"`
|
|
NumberOfDataNodes int `json:"number_of_data_nodes"`
|
|
ActivePrimaryShards int `json:"active_primary_shards"`
|
|
ActiveShards int `json:"active_shards"`
|
|
RelocatingShards int `json:"relocating_shards"`
|
|
InitializingShards int `json:"initializing_shards"`
|
|
UnassignedShards int `json:"unassigned_shards"`
|
|
DelayedUnassignedShards int `json:"delayed_unassigned_shards"`
|
|
NumberOfPendingTasks int `json:"number_of_pending_tasks"`
|
|
NumberOfInFlightFetch int `json:"number_of_in_flight_fetch"`
|
|
TaskMaxWaitTimeInQueueInMillis int `json:"task_max_waiting_in_queue_millis"`
|
|
ActiveShardsPercentAsNumber float64 `json:"active_shards_percent_as_number"`
|
|
|
|
// Validation failures -> index name -> array of validation failures
|
|
ValidationFailures []map[string][]string `json:"validation_failures"`
|
|
|
|
// Index name -> index health
|
|
Indices map[string]*ClusterIndexHealth `json:"indices"`
|
|
}
|
|
|
|
// ClusterIndexHealth will be returned as part of ClusterHealthResponse.
|
|
type ClusterIndexHealth struct {
|
|
Status string `json:"status"`
|
|
NumberOfShards int `json:"number_of_shards"`
|
|
NumberOfReplicas int `json:"number_of_replicas"`
|
|
ActivePrimaryShards int `json:"active_primary_shards"`
|
|
ActiveShards int `json:"active_shards"`
|
|
RelocatingShards int `json:"relocating_shards"`
|
|
InitializingShards int `json:"initializing_shards"`
|
|
UnassignedShards int `json:"unassigned_shards"`
|
|
// Validation failures
|
|
ValidationFailures []string `json:"validation_failures"`
|
|
// Shards by id, e.g. "0" or "1"
|
|
Shards map[string]*ClusterShardHealth `json:"shards"`
|
|
}
|
|
|
|
// ClusterShardHealth will be returned as part of ClusterHealthResponse.
|
|
type ClusterShardHealth struct {
|
|
Status string `json:"status"`
|
|
PrimaryActive bool `json:"primary_active"`
|
|
ActiveShards int `json:"active_shards"`
|
|
RelocatingShards int `json:"relocating_shards"`
|
|
InitializingShards int `json:"initializing_shards"`
|
|
UnassignedShards int `json:"unassigned_shards"`
|
|
}
|