Use upstream parameter follow_redirects

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a0bb560000f292d3532bc5fc9df4e1dfb338d625..1b6679da49c902af91eec949f76890559bee6d2f 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,11 @@
 This release is built with go 1.16.4, which contains a [bugfix](https://github.com/golang/go/issues/45712)
 that can cause an untrusted target to make Blackbox Exporter crash.
 
+In the HTTP probe, `no_follow_redirect` has been changed to `follow_redirect`.
+This release accepts both, with a precedence to the `no_follow_redirect` parameter.
+In the next release, `no_follow_redirect` will be removed.
+
+* [CHANGE] HTTP proble: no_follow_redirect has been renamed to follow_redirect.
 * [FEATURE] Add support for decompression of HTTP responses. #764
 * [FEATURE] Enable TLS and basic authentication. #784
 * [FEATURE] HTTP probe: *experimental* OAuth2 support.

diff --git a/CONFIGURATION.md b/CONFIGURATION.md
index 3928bb5f488d5789a021510fb3fbd056b54366e6..2d8358487e1b8d12bdd02fbfc20ecf4abe551984 100644 (file)
--- a/CONFIGURATION.md
+++ b/CONFIGURATION.md
@@ -62,7 +62,7 @@ The other placeholders are specified separately.
   [ compression: <string> | default = "" ]
 
   # Whether or not the probe will follow any redirects.
-  [ no_follow_redirects: <boolean> | default = false ]
+  [ follow_redirects: <boolean> | default = true ]
 
   # Probe fails if SSL is present.
   [ fail_if_ssl: <boolean> | default = false ]

diff --git a/config/config.go b/config/config.go
index 178bda2d8709058adb96075b2f8f92cac3da2898..07e84c05afc5ea07f87a692450e7cd5b6f9983ea 100644 (file)
--- a/config/config.go
+++ b/config/config.go
@@ -28,6 +28,8 @@ import (
 
        yaml "gopkg.in/yaml.v3"
 
+       "github.com/go-kit/kit/log"
+       "github.com/go-kit/kit/log/level"
        "github.com/miekg/dns"
        "github.com/prometheus/client_golang/prometheus"
        "github.com/prometheus/common/config"
@@ -57,6 +59,7 @@ var (
        // DefaultHTTPProbe set default value for HTTPProbe
        DefaultHTTPProbe = HTTPProbe{
                IPProtocolFallback: true,
+               HTTPClientConfig:   config.DefaultHTTPClientConfig,
        }
 
        // DefaultTCPProbe set default value for TCPProbe
@@ -89,7 +92,7 @@ type SafeConfig struct {
        C *Config
 }
 
-func (sc *SafeConfig) ReloadConfig(confFile string) (err error) {
+func (sc *SafeConfig) ReloadConfig(confFile string, logger log.Logger) (err error) {
        var c = &Config{}
        defer func() {
                if err != nil {
@@ -112,6 +115,17 @@ func (sc *SafeConfig) ReloadConfig(confFile string) (err error) {
                return fmt.Errorf("error parsing config file: %s", err)
        }
 
+       for name, module := range c.Modules {
+               if module.HTTP.NoFollowRedirects != nil {
+                       // Hide the old flag from the /config page.
+                       module.HTTP.NoFollowRedirects = nil
+                       c.Modules[name] = module
+                       if logger != nil {
+                               level.Warn(logger).Log("msg", "no_follow_redirects is deprecated and will be removed in the next release. It is replaced by follow_redirects.", "module", name)
+                       }
+               }
+       }
+
        sc.Lock()
        sc.C = c
        sc.Unlock()
@@ -181,7 +195,7 @@ type HTTPProbe struct {
        ValidHTTPVersions            []string                `yaml:"valid_http_versions,omitempty"`
        IPProtocol                   string                  `yaml:"preferred_ip_protocol,omitempty"`
        IPProtocolFallback           bool                    `yaml:"ip_protocol_fallback,omitempty"`
-       NoFollowRedirects            bool                    `yaml:"no_follow_redirects,omitempty"`
+       NoFollowRedirects            *bool                   `yaml:"no_follow_redirects,omitempty"`
        FailIfSSL                    bool                    `yaml:"fail_if_ssl,omitempty"`
        FailIfNotSSL                 bool                    `yaml:"fail_if_not_ssl,omitempty"`
        Method                       string                  `yaml:"method,omitempty"`
@@ -277,6 +291,10 @@ func (s *HTTPProbe) UnmarshalYAML(unmarshal func(interface{}) error) error {
                return err
        }
 
+       if s.NoFollowRedirects != nil {
+               s.HTTPClientConfig.FollowRedirects = !*s.NoFollowRedirects
+       }
+
        for key, value := range s.Headers {
                switch strings.Title(key) {
                case "Accept-Encoding":

diff --git a/config/config_test.go b/config/config_test.go
index 8a07032cc3e961696f7eaf0a2a1d2317e07befde..097acdbf2fca6bf1de0543a032c506ec8bd06f5f 100644 (file)
--- a/config/config_test.go
+++ b/config/config_test.go
@@ -25,7 +25,7 @@ func TestLoadConfig(t *testing.T) {
                C: &Config{},
        }
 
-       err := sc.ReloadConfig("testdata/blackbox-good.yml")
+       err := sc.ReloadConfig("testdata/blackbox-good.yml", nil)
        if err != nil {
                t.Errorf("Error loading config %v: %v", "blackbox.yml", err)
        }
@@ -90,7 +90,7 @@ func TestLoadBadConfigs(t *testing.T) {
        }
        for _, test := range tests {
                t.Run(test.input, func(t *testing.T) {
-                       got := sc.ReloadConfig(test.input)
+                       got := sc.ReloadConfig(test.input, nil)
                        if got == nil || got.Error() != test.want {
                                t.Fatalf("ReloadConfig(%q) = %v; want %q", test.input, got, test.want)
                        }
@@ -103,7 +103,7 @@ func TestHideConfigSecrets(t *testing.T) {
                C: &Config{},
        }
 
-       err := sc.ReloadConfig("testdata/blackbox-good.yml")
+       err := sc.ReloadConfig("testdata/blackbox-good.yml", nil)
        if err != nil {
                t.Errorf("Error loading config %v: %v", "testdata/blackbox-good.yml", err)
        }

diff --git a/main.go b/main.go
index f2294d752ad9468c184a67efbb676a8de95150af..d0a746fadd0ab799608787962d99d4b37b849c22 100644 (file)
--- a/main.go
+++ b/main.go
@@ -224,7 +224,7 @@ func run() int {
        level.Info(logger).Log("msg", "Starting blackbox_exporter", "version", version.Info())
        level.Info(logger).Log("build_context", version.BuildContext())
 
-       if err := sc.ReloadConfig(*configFile); err != nil {
+       if err := sc.ReloadConfig(*configFile, logger); err != nil {
                level.Error(logger).Log("msg", "Error loading config", "err", err)
                return 1
        }
@@ -265,13 +265,13 @@ func run() int {
                for {
                        select {
                        case <-hup:
-                               if err := sc.ReloadConfig(*configFile); err != nil {
+                               if err := sc.ReloadConfig(*configFile, logger); err != nil {
                                        level.Error(logger).Log("msg", "Error reloading config", "err", err)
                                        continue
                                }
                                level.Info(logger).Log("msg", "Reloaded config file")
                        case rc := <-reloadCh:
-                               if err := sc.ReloadConfig(*configFile); err != nil {
+                               if err := sc.ReloadConfig(*configFile, logger); err != nil {
                                        level.Error(logger).Log("msg", "Error reloading config", "err", err)
                                        rc <- err
                                } else {

diff --git a/prober/http.go b/prober/http.go
index 39bb4d5b3fe104aab20dc764c2372673cc375fd3..95c5353537c0cfc06ad2fd6cdd1ed724d183e800 100644 (file)
--- a/prober/http.go
+++ b/prober/http.go
@@ -373,7 +373,7 @@ func ProbeHTTP(ctx context.Context, target string, module config.Module, registr
        client.CheckRedirect = func(r *http.Request, via []*http.Request) error {
                level.Info(logger).Log("msg", "Received redirect", "location", r.Response.Header.Get("Location"))
                redirects = len(via)
-               if redirects > 10 || httpConfig.NoFollowRedirects {
+               if redirects > 10 || !httpConfig.HTTPClientConfig.FollowRedirects {
                        level.Info(logger).Log("msg", "Not following redirect")
                        return errors.New("don't follow redirects")
                }

diff --git a/prober/http_test.go b/prober/http_test.go
index be380389385e968bc7ef17d75cc5aaadf6b407df..6679b3c02df7b8b64a84a4cc8cd32807b84384bf 100644 (file)
--- a/prober/http_test.go
+++ b/prober/http_test.go
@@ -526,7 +526,7 @@ func TestRedirectFollowed(t *testing.T) {
        registry := prometheus.NewRegistry()
        testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        defer cancel()
-       result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true}}, registry, log.NewNopLogger())
+       result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
        body := recorder.Body.String()
        if !result {
                t.Fatalf("Redirect test failed unexpectedly, got %s", body)
@@ -554,7 +554,7 @@ func TestRedirectNotFollowed(t *testing.T) {
        testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        defer cancel()
        result := ProbeHTTP(testCTX, ts.URL,
-               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, NoFollowRedirects: true, ValidStatusCodes: []int{302}}}, registry, log.NewNopLogger())
+               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.HTTPClientConfig{FollowRedirects: false}, ValidStatusCodes: []int{302}}}, registry, log.NewNopLogger())
        body := recorder.Body.String()
        if !result {
                t.Fatalf("Redirect test failed unexpectedly, got %s", body)
@@ -601,7 +601,7 @@ func TestRedirectionLimit(t *testing.T) {
        result := ProbeHTTP(
                testCTX,
                ts.URL,
-               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true}},
+               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}},
                registry,
                log.NewNopLogger())
        if result {
@@ -1136,7 +1136,7 @@ func TestRedirectToTLSHostWorks(t *testing.T) {
        testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        defer cancel()
        result := ProbeHTTP(testCTX, ts.URL,
-               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true}}, registry, log.NewNopLogger())
+               config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
        if !result {
                t.Fatalf("Redirect test failed unexpectedly")
        }
@@ -1209,7 +1209,7 @@ func TestCookieJar(t *testing.T) {
        registry := prometheus.NewRegistry()
        testCTX, cancel := context.WithTimeout(context.Background(), 10*time.Second)
        defer cancel()
-       result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true}}, registry, log.NewNopLogger())
+       result := ProbeHTTP(testCTX, ts.URL, config.Module{Timeout: time.Second, HTTP: config.HTTPProbe{IPProtocolFallback: true, HTTPClientConfig: pconfig.DefaultHTTPClientConfig}}, registry, log.NewNopLogger())
        body := recorder.Body.String()
        if !result {
                t.Fatalf("Redirect test failed unexpectedly, got %s", body)