Add `access` format support for Elasticsearch notification target (#4006)
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.
2017-03-31 23:11:27 +02:00
|
|
|
// Copyright 2012-present Oliver Eilhard. All rights reserved.
|
2016-07-24 07:51:12 +02:00
|
|
|
// 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"
|
|
|
|
|
Add `access` format support for Elasticsearch notification target (#4006)
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.
2017-03-31 23:11:27 +02:00
|
|
|
"golang.org/x/net/context"
|
|
|
|
|
|
|
|
"gopkg.in/olivere/elastic.v5/uritemplates"
|
2016-07-24 07:51:12 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
// IndicesPutMappingService allows to register specific mapping definition
|
|
|
|
// for a specific type.
|
|
|
|
//
|
Add `access` format support for Elasticsearch notification target (#4006)
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.
2017-03-31 23:11:27 +02:00
|
|
|
// See https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-put-mapping.html
|
2016-07-24 07:51:12 +02:00
|
|
|
// for details.
|
|
|
|
type IndicesPutMappingService struct {
|
|
|
|
client *Client
|
|
|
|
pretty bool
|
|
|
|
typ string
|
|
|
|
index []string
|
|
|
|
masterTimeout string
|
|
|
|
ignoreUnavailable *bool
|
|
|
|
allowNoIndices *bool
|
|
|
|
expandWildcards string
|
|
|
|
ignoreConflicts *bool
|
|
|
|
timeout string
|
|
|
|
bodyJson map[string]interface{}
|
|
|
|
bodyString string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewPutMappingService is an alias for NewIndicesPutMappingService.
|
|
|
|
// Use NewIndicesPutMappingService.
|
|
|
|
func NewPutMappingService(client *Client) *IndicesPutMappingService {
|
|
|
|
return NewIndicesPutMappingService(client)
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewIndicesPutMappingService creates a new IndicesPutMappingService.
|
|
|
|
func NewIndicesPutMappingService(client *Client) *IndicesPutMappingService {
|
|
|
|
return &IndicesPutMappingService{
|
|
|
|
client: client,
|
|
|
|
index: make([]string, 0),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Index is a list of index names the mapping should be added to
|
|
|
|
// (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
|
|
func (s *IndicesPutMappingService) Index(indices ...string) *IndicesPutMappingService {
|
|
|
|
s.index = append(s.index, indices...)
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// Type is the name of the document type.
|
|
|
|
func (s *IndicesPutMappingService) Type(typ string) *IndicesPutMappingService {
|
|
|
|
s.typ = typ
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// Timeout is an explicit operation timeout.
|
|
|
|
func (s *IndicesPutMappingService) Timeout(timeout string) *IndicesPutMappingService {
|
|
|
|
s.timeout = timeout
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// MasterTimeout specifies the timeout for connection to master.
|
|
|
|
func (s *IndicesPutMappingService) MasterTimeout(masterTimeout string) *IndicesPutMappingService {
|
|
|
|
s.masterTimeout = masterTimeout
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// IgnoreUnavailable indicates whether specified concrete indices should be
|
|
|
|
// ignored when unavailable (missing or closed).
|
|
|
|
func (s *IndicesPutMappingService) IgnoreUnavailable(ignoreUnavailable bool) *IndicesPutMappingService {
|
|
|
|
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 *IndicesPutMappingService) AllowNoIndices(allowNoIndices bool) *IndicesPutMappingService {
|
|
|
|
s.allowNoIndices = &allowNoIndices
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// ExpandWildcards indicates whether to expand wildcard expression to
|
|
|
|
// concrete indices that are open, closed or both.
|
|
|
|
func (s *IndicesPutMappingService) ExpandWildcards(expandWildcards string) *IndicesPutMappingService {
|
|
|
|
s.expandWildcards = expandWildcards
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// IgnoreConflicts specifies whether to ignore conflicts while updating
|
|
|
|
// the mapping (default: false).
|
|
|
|
func (s *IndicesPutMappingService) IgnoreConflicts(ignoreConflicts bool) *IndicesPutMappingService {
|
|
|
|
s.ignoreConflicts = &ignoreConflicts
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// Pretty indicates that the JSON response be indented and human readable.
|
|
|
|
func (s *IndicesPutMappingService) Pretty(pretty bool) *IndicesPutMappingService {
|
|
|
|
s.pretty = pretty
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// BodyJson contains the mapping definition.
|
|
|
|
func (s *IndicesPutMappingService) BodyJson(mapping map[string]interface{}) *IndicesPutMappingService {
|
|
|
|
s.bodyJson = mapping
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// BodyString is the mapping definition serialized as a string.
|
|
|
|
func (s *IndicesPutMappingService) BodyString(mapping string) *IndicesPutMappingService {
|
|
|
|
s.bodyString = mapping
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// buildURL builds the URL for the operation.
|
|
|
|
func (s *IndicesPutMappingService) buildURL() (string, url.Values, error) {
|
|
|
|
var err error
|
|
|
|
var path string
|
|
|
|
|
|
|
|
// Build URL: Typ MUST be specified and is verified in Validate.
|
|
|
|
if len(s.index) > 0 {
|
|
|
|
path, err = uritemplates.Expand("/{index}/_mapping/{type}", map[string]string{
|
|
|
|
"index": strings.Join(s.index, ","),
|
|
|
|
"type": s.typ,
|
|
|
|
})
|
|
|
|
} else {
|
|
|
|
path, err = uritemplates.Expand("/_mapping/{type}", map[string]string{
|
|
|
|
"type": s.typ,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
if err != nil {
|
|
|
|
return "", url.Values{}, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add query string parameters
|
|
|
|
params := url.Values{}
|
|
|
|
if s.pretty {
|
|
|
|
params.Set("pretty", "1")
|
|
|
|
}
|
|
|
|
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)
|
|
|
|
}
|
|
|
|
if s.ignoreConflicts != nil {
|
|
|
|
params.Set("ignore_conflicts", fmt.Sprintf("%v", *s.ignoreConflicts))
|
|
|
|
}
|
|
|
|
if s.timeout != "" {
|
|
|
|
params.Set("timeout", s.timeout)
|
|
|
|
}
|
|
|
|
if s.masterTimeout != "" {
|
|
|
|
params.Set("master_timeout", s.masterTimeout)
|
|
|
|
}
|
|
|
|
return path, params, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Validate checks if the operation is valid.
|
|
|
|
func (s *IndicesPutMappingService) Validate() error {
|
|
|
|
var invalid []string
|
|
|
|
if s.typ == "" {
|
|
|
|
invalid = append(invalid, "Type")
|
|
|
|
}
|
|
|
|
if s.bodyString == "" && s.bodyJson == nil {
|
|
|
|
invalid = append(invalid, "BodyJson")
|
|
|
|
}
|
|
|
|
if len(invalid) > 0 {
|
|
|
|
return fmt.Errorf("missing required fields: %v", invalid)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Do executes the operation.
|
Add `access` format support for Elasticsearch notification target (#4006)
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.
2017-03-31 23:11:27 +02:00
|
|
|
func (s *IndicesPutMappingService) Do(ctx context.Context) (*PutMappingResponse, error) {
|
2016-07-24 07:51:12 +02:00
|
|
|
// 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
|
|
|
|
}
|
|
|
|
|
|
|
|
// Setup HTTP request body
|
|
|
|
var body interface{}
|
|
|
|
if s.bodyJson != nil {
|
|
|
|
body = s.bodyJson
|
|
|
|
} else {
|
|
|
|
body = s.bodyString
|
|
|
|
}
|
|
|
|
|
|
|
|
// Get HTTP response
|
Add `access` format support for Elasticsearch notification target (#4006)
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.
2017-03-31 23:11:27 +02:00
|
|
|
res, err := s.client.PerformRequest(ctx, "PUT", path, params, body)
|
2016-07-24 07:51:12 +02:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return operation response
|
|
|
|
ret := new(PutMappingResponse)
|
|
|
|
if err := s.client.decoder.Decode(res.Body, ret); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return ret, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// PutMappingResponse is the response of IndicesPutMappingService.Do.
|
|
|
|
type PutMappingResponse struct {
|
|
|
|
Acknowledged bool `json:"acknowledged"`
|
|
|
|
}
|