1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
|
package main
import (
"errors"
"fmt"
"net"
"net/http"
"net/url"
"os"
"os/signal"
"path"
"strings"
"syscall"
"time"
"github.com/ricoberger/script_exporter/config"
"github.com/ricoberger/script_exporter/discovery"
"github.com/ricoberger/script_exporter/prober"
"github.com/goccy/go-yaml"
"github.com/prometheus/client_golang/prometheus"
versioncollector "github.com/prometheus/client_golang/prometheus/collectors/version"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/promslog"
"github.com/prometheus/common/promslog/flag"
"github.com/prometheus/common/version"
"github.com/prometheus/exporter-toolkit/web"
webflag "github.com/prometheus/exporter-toolkit/web/kingpinflag"
"gopkg.in/alecthomas/kingpin.v2"
)
var (
sc = config.NewSafeConfig(prometheus.DefaultRegisterer)
configFiles = kingpin.Flag("config.files", "Configuration files. To specify multiple configuration files glob patterns can be used.").Default("scripts.yaml").String()
configCheck = kingpin.Flag("config.check", "If true, validate the configuration files and then exit.").Default().Bool()
logEnv = kingpin.Flag("log.env", "If true, environment variables passed to a script will be logged.").Default().Bool()
scriptNoArgs = kingpin.Flag("script.no-args", "Restrict script to accept arguments.").Default().Bool()
scriptTimeoutOffset = kingpin.Flag("script.timeout-offset", "Offset to subtract from timeout in seconds.").Default("0.5").Float64()
externalURL = kingpin.Flag("web.external-url", "The URL under which Script Exporter is externally reachable (for example, if Script Exporter is served via a reverse proxy). Used for generating relative and absolute links back to Script Exporter itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by Script Exporter. If omitted, relevant URL components will be derived automatically.").PlaceHolder("<url>").String()
routePrefix = kingpin.Flag("web.route-prefix", "Prefix for the internal routes of web endpoints. Defaults to path of --web.external-url.").PlaceHolder("<path>").String()
discoveryHost = kingpin.Flag("discovery.host", "Host for service discovery.").Default("").String()
discoveryPort = kingpin.Flag("discovery.port", "Port for service discovery.").Default("").String()
discoveryScheme = kingpin.Flag("discovery.scheme", "Scheme for service discovery.").Default("").String()
toolkitFlags = webflag.AddFlags(kingpin.CommandLine, ":9469")
)
func init() {
prometheus.MustRegister(versioncollector.NewCollector("script_exporter"))
}
func run(stopCh chan bool) int {
kingpin.CommandLine.UsageWriter(os.Stdout)
promslogConfig := &promslog.Config{}
flag.AddFlags(kingpin.CommandLine, promslogConfig)
kingpin.Version(version.Print("script_exporter"))
kingpin.HelpFlag.Short('h')
kingpin.Parse()
logger := promslog.New(promslogConfig)
logger.Info("Starting script_exporter", "version", version.Info())
logger.Info(version.BuildContext())
if err := sc.ReloadConfig(*configFiles, logger); err != nil {
logger.Error("Error loading config", "err", err)
return 1
}
if *configCheck {
logger.Info("Config files are ok, exiting...")
return 0
}
logger.Info("Loaded config files")
// Infer or set Script Exporter externalURL
listenAddrs := toolkitFlags.WebListenAddresses
if *externalURL == "" && *toolkitFlags.WebSystemdSocket {
logger.Error("Cannot automatically infer external URL with systemd socket listener. Please provide --web.external-url")
return 1
} else if *externalURL == "" && len(*listenAddrs) > 1 {
logger.Info("Inferring external URL from first provided listen address")
}
beURL, err := computeExternalURL(*externalURL, (*listenAddrs)[0])
if err != nil {
logger.Error("failed to determine external URL", "err", err)
return 1
}
logger.Debug(beURL.String())
// Default -web.route-prefix to path of -web.external-url.
if *routePrefix == "" {
*routePrefix = beURL.Path
}
// routePrefix must always be at least '/'.
*routePrefix = "/" + strings.Trim(*routePrefix, "/")
// routePrefix requires path to have trailing "/" in order for browsers to
// interpret the path-relative path correctly, instead of stripping it.
if *routePrefix != "/" {
*routePrefix = *routePrefix + "/"
}
logger.Debug(*routePrefix)
hup := make(chan os.Signal, 1)
reloadCh := make(chan chan error)
signal.Notify(hup, syscall.SIGHUP)
go func() {
for {
select {
case <-hup:
if err := sc.ReloadConfig(*configFiles, logger); err != nil {
logger.Error("Error reloading config", "err", err)
continue
}
logger.Info("Reloaded config file")
case rc := <-reloadCh:
if err := sc.ReloadConfig(*configFiles, logger); err != nil {
logger.Error("Error reloading config", "err", err)
rc <- err
} else {
logger.Info("Reloaded config file")
rc <- nil
}
}
}
}()
// Match Prometheus behavior and redirect over externalURL for root path
// only if routePrefix is different than "/".
if *routePrefix != "/" {
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/" {
http.NotFound(w, r)
return
}
http.Redirect(w, r, beURL.String(), http.StatusFound)
})
}
http.HandleFunc(path.Join(*routePrefix, "/-/reload"),
func(w http.ResponseWriter, r *http.Request) {
if r.Method != "POST" {
w.WriteHeader(http.StatusMethodNotAllowed)
fmt.Fprintf(w, "This endpoint requires a POST request.\n")
return
}
rc := make(chan error)
reloadCh <- rc
if err := <-rc; err != nil {
http.Error(w, fmt.Sprintf("failed to reload config: %s", err), http.StatusInternalServerError)
}
})
http.Handle(path.Join(*routePrefix, "/metrics"), promhttp.Handler())
http.HandleFunc(path.Join(*routePrefix, "/-/healthy"), func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("Healthy"))
})
http.HandleFunc(path.Join(*routePrefix, "/probe"), func(w http.ResponseWriter, r *http.Request) {
sc.Lock()
config := sc.C
sc.Unlock()
prober.Handler(w, r, config, logger, *logEnv, *scriptTimeoutOffset, *scriptNoArgs)
})
http.HandleFunc(path.Join(*routePrefix, "/discovery"), func(w http.ResponseWriter, r *http.Request) {
sc.Lock()
config := sc.C
sc.Unlock()
discovery.Handler(w, r, config, logger, *discoveryHost, *discoveryPort, *discoveryScheme, *routePrefix)
})
http.HandleFunc(*routePrefix, func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
w.Write([]byte(`<html>
<head><title>Script Exporter</title></head>
<body>
<h1>Script Exporter</h1>
<ul>
<li><a href='/metrics'>Metrics</a></li>
<li><a href='/probe'>Probe</a></li>
<li><a href='/config'>Config</a></li>
</ul>
<ul>
<li>version: ` + version.Version + `</li>
<li>revision: ` + version.GetRevision() + `</li>
<li>branch: ` + version.Branch + `</li>
<li>buildUser: ` + version.BuildUser + `</li>
<li>buildDate: ` + version.BuildDate + `</li>
<li>goVersion: ` + version.GoVersion + `</li>
<li>platform: ` + version.GoOS + `/` + version.GoArch + `</li>
<li>tags: ` + version.GetTags() + `</li>
</ul>
</body>
</html>`))
})
http.HandleFunc(path.Join(*routePrefix, "/config"), func(w http.ResponseWriter, r *http.Request) {
sc.RLock()
c, err := yaml.Marshal(sc.C)
sc.RUnlock()
if err != nil {
logger.Warn("Error marshalling configuration", "err", err)
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "text/plain")
w.Write(c)
})
srv := &http.Server{
ReadHeaderTimeout: 10 * time.Second,
}
srvc := make(chan struct{})
term := make(chan os.Signal, 1)
signal.Notify(term, os.Interrupt, syscall.SIGTERM)
go func() {
if err := web.ListenAndServe(srv, toolkitFlags, logger); err != nil {
logger.Error("Error starting HTTP server", "err", err)
close(srvc)
}
}()
for {
select {
case <-stopCh:
logger.Info("Service received stop message...")
return 0
case <-term:
logger.Info("Received SIGTERM, exiting gracefully...")
return 0
case <-srvc:
return 1
}
}
}
func startsOrEndsWithQuote(s string) bool {
return strings.HasPrefix(s, "\"") || strings.HasPrefix(s, "'") ||
strings.HasSuffix(s, "\"") || strings.HasSuffix(s, "'")
}
// computeExternalURL computes a sanitized external URL from a raw input. It
// infers unset URL parts from the OS and the given listen address.
func computeExternalURL(u, listenAddr string) (*url.URL, error) {
if u == "" {
hostname, err := os.Hostname()
if err != nil {
return nil, err
}
_, port, err := net.SplitHostPort(listenAddr)
if err != nil {
return nil, err
}
u = fmt.Sprintf("http://%s:%s/", hostname, port)
}
if startsOrEndsWithQuote(u) {
return nil, errors.New("URL must not begin or end with quotes")
}
eu, err := url.Parse(u)
if err != nil {
return nil, err
}
ppref := strings.TrimRight(eu.Path, "/")
if ppref != "" && !strings.HasPrefix(ppref, "/") {
ppref = "/" + ppref
}
eu.Path = ppref
return eu, nil
}
|