546 lines
14 KiB
Go
546 lines
14 KiB
Go
//go:generate ../../../tools/readme_config_includer/generator
|
|
package elasticsearch
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"crypto/sha256"
|
|
_ "embed"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"math"
|
|
"net/http"
|
|
"net/url"
|
|
"strconv"
|
|
"strings"
|
|
"text/template"
|
|
"time"
|
|
|
|
"github.com/olivere/elastic"
|
|
|
|
"github.com/influxdata/telegraf"
|
|
"github.com/influxdata/telegraf/config"
|
|
"github.com/influxdata/telegraf/plugins/common/tls"
|
|
"github.com/influxdata/telegraf/plugins/outputs"
|
|
)
|
|
|
|
//go:embed sample.conf
|
|
var sampleConfig string
|
|
|
|
type Elasticsearch struct {
|
|
AuthBearerToken config.Secret `toml:"auth_bearer_token"`
|
|
DefaultPipeline string `toml:"default_pipeline"`
|
|
DefaultTagValue string `toml:"default_tag_value"`
|
|
EnableGzip bool `toml:"enable_gzip"`
|
|
EnableSniffer bool `toml:"enable_sniffer"`
|
|
FloatHandling string `toml:"float_handling"`
|
|
FloatReplacement float64 `toml:"float_replacement_value"`
|
|
ForceDocumentID bool `toml:"force_document_id"`
|
|
HealthCheckInterval config.Duration `toml:"health_check_interval"`
|
|
HealthCheckTimeout config.Duration `toml:"health_check_timeout"`
|
|
IndexName string `toml:"index_name"`
|
|
IndexTemplate map[string]interface{} `toml:"template_index_settings"`
|
|
ManageTemplate bool `toml:"manage_template"`
|
|
OverwriteTemplate bool `toml:"overwrite_template"`
|
|
UseOpTypeCreate bool `toml:"use_optype_create"`
|
|
Username config.Secret `toml:"username"`
|
|
Password config.Secret `toml:"password"`
|
|
TemplateName string `toml:"template_name"`
|
|
Timeout config.Duration `toml:"timeout"`
|
|
URLs []string `toml:"urls"`
|
|
UsePipeline string `toml:"use_pipeline"`
|
|
Headers map[string]string `toml:"headers"`
|
|
Log telegraf.Logger `toml:"-"`
|
|
majorReleaseNumber int
|
|
pipelineName string
|
|
pipelineTagKeys []string
|
|
tagKeys []string
|
|
tls.ClientConfig
|
|
|
|
Client *elastic.Client
|
|
}
|
|
|
|
const telegrafTemplate = `
|
|
{
|
|
{{ if (lt .Version 6) }}
|
|
"template": "{{.TemplatePattern}}",
|
|
{{ else }}
|
|
"index_patterns" : [ "{{.TemplatePattern}}" ],
|
|
{{ end }}
|
|
"settings": {
|
|
"index": {{.IndexTemplate}}
|
|
},
|
|
"mappings" : {
|
|
{{ if (lt .Version 7) }}
|
|
"metrics" : {
|
|
{{ if (lt .Version 6) }}
|
|
"_all": { "enabled": false },
|
|
{{ end }}
|
|
{{ end }}
|
|
"properties" : {
|
|
"@timestamp" : { "type" : "date" },
|
|
"measurement_name" : { "type" : "keyword" }
|
|
},
|
|
"dynamic_templates": [
|
|
{
|
|
"tags": {
|
|
"match_mapping_type": "string",
|
|
"path_match": "tag.*",
|
|
"mapping": {
|
|
"ignore_above": 512,
|
|
"type": "keyword"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"metrics_long": {
|
|
"match_mapping_type": "long",
|
|
"mapping": {
|
|
"type": "float",
|
|
"index": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"metrics_double": {
|
|
"match_mapping_type": "double",
|
|
"mapping": {
|
|
"type": "float",
|
|
"index": false
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"text_fields": {
|
|
"match": "*",
|
|
"mapping": {
|
|
"norms": false
|
|
}
|
|
}
|
|
}
|
|
]
|
|
{{ if (lt .Version 7) }}
|
|
}
|
|
{{ end }}
|
|
}
|
|
}`
|
|
|
|
const defaultTemplateIndexSettings = `
|
|
{
|
|
"refresh_interval": "10s",
|
|
"mapping.total_fields.limit": 5000,
|
|
"auto_expand_replicas": "0-1",
|
|
"codec": "best_compression"
|
|
}`
|
|
|
|
type templatePart struct {
|
|
TemplatePattern string
|
|
Version int
|
|
IndexTemplate string
|
|
}
|
|
|
|
func (*Elasticsearch) SampleConfig() string {
|
|
return sampleConfig
|
|
}
|
|
|
|
func (a *Elasticsearch) Connect() error {
|
|
if a.URLs == nil || a.IndexName == "" {
|
|
return errors.New("elasticsearch urls or index_name is not defined")
|
|
}
|
|
|
|
// Determine if we should process NaN and inf values
|
|
switch a.FloatHandling {
|
|
case "", "none":
|
|
a.FloatHandling = "none"
|
|
case "drop", "replace":
|
|
default:
|
|
return fmt.Errorf("invalid float_handling type %q", a.FloatHandling)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Duration(a.Timeout))
|
|
defer cancel()
|
|
|
|
var clientOptions []elastic.ClientOptionFunc
|
|
|
|
tlsCfg, err := a.ClientConfig.TLSConfig()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
tr := &http.Transport{
|
|
TLSClientConfig: tlsCfg,
|
|
}
|
|
|
|
httpclient := &http.Client{
|
|
Transport: tr,
|
|
Timeout: time.Duration(a.Timeout),
|
|
}
|
|
|
|
elasticURL, err := url.Parse(a.URLs[0])
|
|
if err != nil {
|
|
return fmt.Errorf("parsing URL failed: %w", err)
|
|
}
|
|
|
|
clientOptions = append(clientOptions,
|
|
elastic.SetHttpClient(httpclient),
|
|
elastic.SetSniff(a.EnableSniffer),
|
|
elastic.SetScheme(elasticURL.Scheme),
|
|
elastic.SetURL(a.URLs...),
|
|
elastic.SetHealthcheckInterval(time.Duration(a.HealthCheckInterval)),
|
|
elastic.SetHealthcheckTimeout(time.Duration(a.HealthCheckTimeout)),
|
|
elastic.SetGzip(a.EnableGzip),
|
|
)
|
|
|
|
if len(a.Headers) > 0 {
|
|
headers := http.Header{}
|
|
for k, vals := range a.Headers {
|
|
for _, v := range strings.Split(vals, ",") {
|
|
headers.Add(k, v)
|
|
}
|
|
}
|
|
clientOptions = append(clientOptions, elastic.SetHeaders(headers))
|
|
}
|
|
|
|
authOptions, err := a.getAuthOptions()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
clientOptions = append(clientOptions, authOptions...)
|
|
|
|
if time.Duration(a.HealthCheckInterval) == 0 {
|
|
clientOptions = append(clientOptions,
|
|
elastic.SetHealthcheck(false),
|
|
)
|
|
a.Log.Debugf("Disabling health check")
|
|
}
|
|
|
|
client, err := elastic.NewClient(clientOptions...)
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// check for ES version on first node
|
|
esVersion, err := client.ElasticsearchVersion(a.URLs[0])
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("elasticsearch version check failed: %w", err)
|
|
}
|
|
|
|
// quit if ES version is not supported
|
|
majorReleaseNumber, err := strconv.Atoi(strings.Split(esVersion, ".")[0])
|
|
if err != nil || majorReleaseNumber < 5 {
|
|
return fmt.Errorf("elasticsearch version not supported: %s", esVersion)
|
|
}
|
|
|
|
a.Log.Infof("Elasticsearch version: %q", esVersion)
|
|
|
|
a.Client = client
|
|
a.majorReleaseNumber = majorReleaseNumber
|
|
|
|
if a.ManageTemplate {
|
|
err := a.manageTemplate(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
a.IndexName, a.tagKeys = GetTagKeys(a.IndexName)
|
|
a.pipelineName, a.pipelineTagKeys = GetTagKeys(a.UsePipeline)
|
|
|
|
return nil
|
|
}
|
|
|
|
// GetPointID generates a unique ID for a Metric Point
|
|
func GetPointID(m telegraf.Metric) string {
|
|
var buffer bytes.Buffer
|
|
// Timestamp(ns),measurement name and Series Hash for compute the final SHA256 based hash ID
|
|
|
|
buffer.WriteString(strconv.FormatInt(m.Time().Local().UnixNano(), 10))
|
|
buffer.WriteString(m.Name())
|
|
buffer.WriteString(strconv.FormatUint(m.HashID(), 10))
|
|
|
|
return fmt.Sprintf("%x", sha256.Sum256(buffer.Bytes()))
|
|
}
|
|
|
|
func (a *Elasticsearch) Write(metrics []telegraf.Metric) error {
|
|
if len(metrics) == 0 {
|
|
return nil
|
|
}
|
|
|
|
bulkRequest := a.Client.Bulk()
|
|
|
|
for _, metric := range metrics {
|
|
var name = metric.Name()
|
|
|
|
// index name has to be re-evaluated each time for telegraf
|
|
// to send the metric to the correct time-based index
|
|
indexName := a.GetIndexName(a.IndexName, metric.Time(), a.tagKeys, metric.Tags())
|
|
|
|
// Handle NaN and inf field-values
|
|
fields := make(map[string]interface{})
|
|
for k, value := range metric.Fields() {
|
|
v, ok := value.(float64)
|
|
if !ok || a.FloatHandling == "none" || !(math.IsNaN(v) || math.IsInf(v, 0)) {
|
|
fields[k] = value
|
|
continue
|
|
}
|
|
if a.FloatHandling == "drop" {
|
|
continue
|
|
}
|
|
|
|
if math.IsNaN(v) || math.IsInf(v, 1) {
|
|
fields[k] = a.FloatReplacement
|
|
} else {
|
|
fields[k] = -a.FloatReplacement
|
|
}
|
|
}
|
|
|
|
m := make(map[string]interface{})
|
|
|
|
m["@timestamp"] = metric.Time()
|
|
m["measurement_name"] = name
|
|
m["tag"] = metric.Tags()
|
|
m[name] = fields
|
|
|
|
br := elastic.NewBulkIndexRequest().Index(indexName).Doc(m)
|
|
|
|
if a.UseOpTypeCreate {
|
|
br.OpType("create")
|
|
}
|
|
|
|
if a.ForceDocumentID {
|
|
id := GetPointID(metric)
|
|
br.Id(id)
|
|
}
|
|
|
|
if a.majorReleaseNumber <= 6 {
|
|
br.Type("metrics")
|
|
}
|
|
|
|
if a.UsePipeline != "" {
|
|
if pipelineName := a.getPipelineName(a.pipelineName, a.pipelineTagKeys, metric.Tags()); pipelineName != "" {
|
|
br.Pipeline(pipelineName)
|
|
}
|
|
}
|
|
|
|
bulkRequest.Add(br)
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Duration(a.Timeout))
|
|
defer cancel()
|
|
|
|
res, err := bulkRequest.Do(ctx)
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("error sending bulk request to Elasticsearch: %w", err)
|
|
}
|
|
|
|
if res.Errors {
|
|
for id, err := range res.Failed() {
|
|
a.Log.Errorf(
|
|
"Elasticsearch indexing failure, id: %d, status: %d, error: %s, caused by: %s, %s",
|
|
id,
|
|
err.Status,
|
|
err.Error.Reason,
|
|
err.Error.CausedBy["reason"],
|
|
err.Error.CausedBy["type"],
|
|
)
|
|
break
|
|
}
|
|
return fmt.Errorf("elasticsearch failed to index %d metrics", len(res.Failed()))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (a *Elasticsearch) manageTemplate(ctx context.Context) error {
|
|
if a.TemplateName == "" {
|
|
return errors.New("elasticsearch template_name configuration not defined")
|
|
}
|
|
|
|
templateExists, errExists := a.Client.IndexTemplateExists(a.TemplateName).Do(ctx)
|
|
|
|
if errExists != nil {
|
|
return fmt.Errorf("elasticsearch template check failed, template name: %s, error: %w", a.TemplateName, errExists)
|
|
}
|
|
|
|
templatePattern := a.IndexName
|
|
|
|
if strings.Contains(templatePattern, "%") {
|
|
templatePattern = templatePattern[0:strings.Index(templatePattern, "%")]
|
|
}
|
|
|
|
if strings.Contains(templatePattern, "{{") {
|
|
templatePattern = templatePattern[0:strings.Index(templatePattern, "{{")]
|
|
}
|
|
|
|
if templatePattern == "" {
|
|
return errors.New("template cannot be created for dynamic index names without an index prefix")
|
|
}
|
|
|
|
if (a.OverwriteTemplate) || (!templateExists) || (templatePattern != "") {
|
|
data, err := a.createNewTemplate(templatePattern)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, errCreateTemplate := a.Client.IndexPutTemplate(a.TemplateName).BodyString(data.String()).Do(ctx)
|
|
if errCreateTemplate != nil {
|
|
return fmt.Errorf("elasticsearch failed to create index template %s: %w", a.TemplateName, errCreateTemplate)
|
|
}
|
|
|
|
a.Log.Debugf("Template %s created or updated\n", a.TemplateName)
|
|
} else {
|
|
a.Log.Debug("Found existing Elasticsearch template. Skipping template management")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (a *Elasticsearch) createNewTemplate(templatePattern string) (*bytes.Buffer, error) {
|
|
var indexTemplate string
|
|
if a.IndexTemplate != nil {
|
|
data, err := json.Marshal(&a.IndexTemplate)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("elasticsearch failed to create index settings for template %s: %w", a.TemplateName, err)
|
|
}
|
|
indexTemplate = string(data)
|
|
} else {
|
|
indexTemplate = defaultTemplateIndexSettings
|
|
}
|
|
|
|
tp := templatePart{
|
|
TemplatePattern: templatePattern + "*",
|
|
Version: a.majorReleaseNumber,
|
|
IndexTemplate: indexTemplate,
|
|
}
|
|
|
|
t := template.Must(template.New("template").Parse(telegrafTemplate))
|
|
var tmpl bytes.Buffer
|
|
|
|
if err := t.Execute(&tmpl, tp); err != nil {
|
|
return nil, err
|
|
}
|
|
return &tmpl, nil
|
|
}
|
|
|
|
func GetTagKeys(indexName string) (string, []string) {
|
|
tagKeys := make([]string, 0)
|
|
startTag := strings.Index(indexName, "{{")
|
|
|
|
for startTag >= 0 {
|
|
endTag := strings.Index(indexName, "}}")
|
|
|
|
if endTag < 0 {
|
|
startTag = -1
|
|
} else {
|
|
tagName := indexName[startTag+2 : endTag]
|
|
|
|
var tagReplacer = strings.NewReplacer(
|
|
"{{"+tagName+"}}", "%s",
|
|
)
|
|
|
|
indexName = tagReplacer.Replace(indexName)
|
|
tagKeys = append(tagKeys, strings.TrimSpace(tagName))
|
|
|
|
startTag = strings.Index(indexName, "{{")
|
|
}
|
|
}
|
|
|
|
return indexName, tagKeys
|
|
}
|
|
|
|
func (a *Elasticsearch) GetIndexName(indexName string, eventTime time.Time, tagKeys []string, metricTags map[string]string) string {
|
|
if strings.Contains(indexName, "%") {
|
|
var dateReplacer = strings.NewReplacer(
|
|
"%Y", eventTime.UTC().Format("2006"),
|
|
"%y", eventTime.UTC().Format("06"),
|
|
"%m", eventTime.UTC().Format("01"),
|
|
"%d", eventTime.UTC().Format("02"),
|
|
"%H", eventTime.UTC().Format("15"),
|
|
"%V", getISOWeek(eventTime.UTC()),
|
|
)
|
|
|
|
indexName = dateReplacer.Replace(indexName)
|
|
}
|
|
|
|
tagValues := make([]interface{}, 0, len(tagKeys))
|
|
for _, key := range tagKeys {
|
|
if value, ok := metricTags[key]; ok {
|
|
tagValues = append(tagValues, value)
|
|
} else {
|
|
a.Log.Debugf("Tag %q not found, using %q on index name instead\n", key, a.DefaultTagValue)
|
|
tagValues = append(tagValues, a.DefaultTagValue)
|
|
}
|
|
}
|
|
|
|
return fmt.Sprintf(indexName, tagValues...)
|
|
}
|
|
|
|
func (a *Elasticsearch) getPipelineName(pipelineInput string, tagKeys []string, metricTags map[string]string) string {
|
|
if !strings.Contains(pipelineInput, "%") || len(tagKeys) == 0 {
|
|
return pipelineInput
|
|
}
|
|
|
|
var tagValues []interface{}
|
|
|
|
for _, key := range tagKeys {
|
|
if value, ok := metricTags[key]; ok {
|
|
tagValues = append(tagValues, value)
|
|
continue
|
|
}
|
|
a.Log.Debugf("Tag %s not found, reverting to default pipeline instead.", key)
|
|
return a.DefaultPipeline
|
|
}
|
|
return fmt.Sprintf(pipelineInput, tagValues...)
|
|
}
|
|
|
|
func getISOWeek(eventTime time.Time) string {
|
|
_, week := eventTime.ISOWeek()
|
|
return strconv.Itoa(week)
|
|
}
|
|
|
|
func (a *Elasticsearch) Close() error {
|
|
a.Client = nil
|
|
return nil
|
|
}
|
|
|
|
func (a *Elasticsearch) getAuthOptions() ([]elastic.ClientOptionFunc, error) {
|
|
var fns []elastic.ClientOptionFunc
|
|
|
|
if !a.Username.Empty() && !a.Password.Empty() {
|
|
username, err := a.Username.Get()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("getting username failed: %w", err)
|
|
}
|
|
password, err := a.Password.Get()
|
|
if err != nil {
|
|
username.Destroy()
|
|
return nil, fmt.Errorf("getting password failed: %w", err)
|
|
}
|
|
fns = append(fns, elastic.SetBasicAuth(username.String(), password.String()))
|
|
username.Destroy()
|
|
password.Destroy()
|
|
}
|
|
|
|
if !a.AuthBearerToken.Empty() {
|
|
token, err := a.AuthBearerToken.Get()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("getting token failed: %w", err)
|
|
}
|
|
auth := []string{"Bearer " + token.String()}
|
|
fns = append(fns, elastic.SetHeaders(http.Header{"Authorization": auth}))
|
|
token.Destroy()
|
|
}
|
|
return fns, nil
|
|
}
|
|
|
|
func init() {
|
|
outputs.Add("elasticsearch", func() telegraf.Output {
|
|
return &Elasticsearch{
|
|
Timeout: config.Duration(time.Second * 5),
|
|
HealthCheckInterval: config.Duration(time.Second * 10),
|
|
HealthCheckTimeout: config.Duration(time.Second * 1),
|
|
}
|
|
})
|
|
}
|