Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: Do not write index template if nothing changed. #36665

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Enhancement: Do not write index template if nothing changed. #36665

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40e40b0
update template
nutmos Sep 23, 2023
5cbf1e9
update func name
nutmos Sep 23, 2023
cc419a8
Apply suggestions from code review
nutmos Sep 26, 2023
7b79e3e
add err catching
nutmos Sep 26, 2023
dc0310c
update info msg
nutmos Sep 26, 2023
55c982c
update some logs
nutmos Sep 29, 2023
c8ddd0a
Merge branch 'main' into feat/check-template-bf-apply
nutmos Sep 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions libbeat/template/load.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"io/ioutil"
"net/http"
"os"
"reflect"

"github.com/elastic/beats/v7/libbeat/beat"
"github.com/elastic/elastic-agent-libs/logp"
Expand Down Expand Up @@ -156,6 +157,15 @@ func (l *ESLoader) Load(config TemplateConfig, info beat.Info, fields []byte, mi
// template if it exists. If you wish to not overwrite an existing template
// then use CheckTemplate prior to calling this method.
func (l *ESLoader) loadTemplate(templateName string, template map[string]interface{}) error {
sameTemplate, sameTemplateErr := l.sameAsExistingTemplate(templateName, template)
if sameTemplateErr != nil {
l.log.Warnf("Get template %s from Elasticsearch failed. Template check will be ignored: %v", templateName, sameTemplateErr)
} else {
if sameTemplate {
l.log.Infof("Template %s is already present in Elasticsearch, skipping...", templateName)
return nil
}
}
l.log.Infof("Try loading template %s to Elasticsearch", templateName)
path := "/_index_template/" + templateName
status, body, err := l.client.Request("PUT", path, "", nil, template)
Expand Down Expand Up @@ -207,6 +217,29 @@ func (l *ESLoader) checkExistsTemplate(name string) (bool, error) {
return true, nil
}

func (l *ESLoader) sameAsExistingTemplate(name string, newTemplate map[string]interface{}) (bool, error) {
path := "/_index_template/" + name
status, body, err := l.client.Request("GET", path, "", nil, nil)
if err != nil {
return false, fmt.Errorf("failed to get template %s: %w", name, err)
}
if status > http.StatusMultipleChoices {
return false, fmt.Errorf("unexpected status code %d when getting template %s: %s", status, name, string(body))
}
getJson := make(map[string]interface{})
if err := json.Unmarshal(body, &getJson); err != nil {
return false, fmt.Errorf("failed to read JSON response when getting template %s: %w", name, err)
}
oldTemplate := getJson["index_templates"].([]interface{})
if len(oldTemplate) != 1 {
return false, fmt.Errorf("more than one template with name %s found", name)
}
if reflect.DeepEqual(oldTemplate[0].(map[string]interface{}), newTemplate) {
return true, nil
}
return false, nil
}

// Load reads the template from the config, creates the template body and prints it to the configured file.
func (l *FileLoader) Load(config TemplateConfig, info beat.Info, fields []byte, migration bool) error {
//build template from config
Expand Down
Loading