From c45acaec46fb6f7b3beabb0a9b193c0f9f9ead04 Mon Sep 17 00:00:00 2001 From: Andrew Cholakian Date: Tue, 18 Dec 2018 16:28:02 -0600 Subject: [PATCH] [heartbeat] Remove script / make task for generating monitors This was rarely used, and already out of date. We've discussed this in https://github.com/elastic/beats/issues/9132 and decided it's not worth maintaining. Fixes #9132 --- CHANGELOG.asciidoc | 2 + heartbeat/Makefile | 5 - heartbeat/scripts/generate_monitor/main.go | 201 --------------------- 3 files changed, 2 insertions(+), 206 deletions(-) delete mode 100644 heartbeat/scripts/generate_monitor/main.go diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index 696b0f2debc..9aaa5d61092 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -28,6 +28,8 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha1...master[Check the HEAD d *Heartbeat* +- Remove monitor generator script that was rarely used. {pull}9648[9648] + *Journalbeat* *Metricbeat* diff --git a/heartbeat/Makefile b/heartbeat/Makefile index 98615cfe6f9..dde71c06312 100644 --- a/heartbeat/Makefile +++ b/heartbeat/Makefile @@ -16,11 +16,6 @@ imports: python-env @mkdir -p include @${PYTHON_ENV}/bin/python ${ES_BEATS}/script/generate_imports.py --out monitors/defaults/default.go ${BEAT_PATH} -# Create a new monitor. Requires the parameter MONITOR -.PHONY: create-monitor -create-monitor: - go run scripts/generate_monitor/main.go -monitor=${MONITOR} - # Collects all module dashboards .PHONY: kibana kibana: diff --git a/heartbeat/scripts/generate_monitor/main.go b/heartbeat/scripts/generate_monitor/main.go deleted file mode 100644 index 0fa3109faae..00000000000 --- a/heartbeat/scripts/generate_monitor/main.go +++ /dev/null @@ -1,201 +0,0 @@ -// Licensed to Elasticsearch B.V. under one or more contributor -// license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright -// ownership. Elasticsearch B.V. licenses this file to you under -// the Apache License, Version 2.0 (the "License"); you may -// not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -package main - -import ( - "bytes" - "flag" - "fmt" - "io" - "os" - "path/filepath" - "reflect" - "strings" - "text/template" -) - -func main() { - var ( - monitor string - generatorHome string - path string - ) - flag.StringVar(&monitor, "monitor", "", "Monitor name") - flag.StringVar(&generatorHome, "home", "./scripts/generator/{{monitor}}", "Generator home path") - flag.StringVar(&path, "path", "./monitors/active", "monitor output directory") - flag.Parse() - - if monitor == "" { - if err := prompt("Monitor name [example]: ", &monitor); err != nil { - fatal(err) - } - - if monitor == "" { - monitor = "example" - } - } - - env := map[string]interface{}{ - // variables - "monitor": noDot(monitor), - - // functions - "upper": strings.ToUpper, - "lower": strings.ToLower, - "title": strings.Title, - } - if err := generate(generatorHome, filepath.Join(path, monitor), env); err != nil { - fatal(err) - } -} - -func prompt(msg string, to interface{}) error { - fmt.Print(msg) - _, err := fmt.Scanln(to) - return err -} - -// create a template function, such that the variable can be accessed without -// the leading `.`. -func noDot(v string) interface{} { - return func() string { return v } -} - -func fatal(err error) { - fmt.Fprintln(os.Stderr, err) - os.Exit(1) -} - -func generate(generatorPath string, outPath string, env map[string]interface{}) error { - root, err := filepath.Abs(generatorPath) - if err != nil { - return err - } - - outPath, err = filepath.Abs(outPath) - if err != nil { - return err - } - - if err := os.MkdirAll(outPath, os.ModeDir|os.ModePerm); err != nil { - return err - } - - const tmplExt = ".tmpl" - - return filepath.Walk(root, func(path string, info os.FileInfo, err error) error { - if err != nil { - return err - } - if path == root { - return nil - } - - name, err := execNameTemplate(path[len(root)+1:], env) - if err != nil { - return err - } - - if info.IsDir() { - dir := filepath.Join(outPath, name) - return os.MkdirAll(dir, os.ModeDir|os.ModePerm) - } - - if filepath.Ext(name) != tmplExt { - return copyFile(filepath.Join(outPath, name), path) - } - - // template file. - name = name[:len(name)-len(tmplExt)] - return copyTemplate(filepath.Join(outPath, name), path, env) - }) -} - -func execNameTemplate(in string, env map[string]interface{}) (string, error) { - var err error - tmpl := withFunc(template.New("name"), env) - tmpl, err = tmpl.Parse(in) - if err != nil { - return "", err - } - - var buf bytes.Buffer - err = tmpl.Execute(&buf, withEnv(env)) - return buf.String(), err -} - -func copyTemplate(to, tmplPath string, env map[string]interface{}) error { - var err error - tmpl := withFunc(template.New(filepath.Base(tmplPath)), env) - tmpl, err = tmpl.ParseFiles(tmplPath) - if err != nil { - return err - } - - out, err := os.Create(to) - if err != nil { - return err - } - defer out.Close() - - tmpl = tmpl.Funcs(env) - return tmpl.Execute(out, env) -} - -func copyFile(to, from string) error { - in, err := os.Open(from) - if err != nil { - return err - } - defer in.Close() - - out, err := os.Create(to) - if err != nil { - return err - } - defer out.Close() - - _, err = io.Copy(out, in) - return err -} - -func withFunc(tmpl *template.Template, env map[string]interface{}) *template.Template { - return tmpl.Funcs(filterEnv(func(v interface{}) bool { - return reflect.TypeOf(v).Kind() == reflect.Func - }, env)) -} - -func withEnv(env map[string]interface{}) map[string]interface{} { - return filterEnv(func(v interface{}) bool { - return reflect.TypeOf(v).Kind() != reflect.Func - }, env) -} - -func filterEnv(pred func(interface{}) bool, env map[string]interface{}) map[string]interface{} { - tmp := map[string]interface{}{} - for k, v := range env { - if pred(v) { - tmp[k] = v - } - } - - if len(tmp) == 0 { - return nil - } - return tmp -}