Add docs for http+unix in Metricbeat (#22891) (#22953)

(cherry picked from commit c2272c1)

metricbeat/docs/metricbeat-options.asciidoc

@@ -242,6 +242,13 @@ clusters with the same `service.type`.
 [[module-http-config-options]]
 === Standard HTTP config options
 
+Modules and metricsets that define the host as an HTTP URL can use the standard
+schemes for HTTP (`http://` and `https://`) and the following schemes to connect
+to local pipes:
+
+* `http+unix://` to connect to UNIX sockets.
+* `http+npipe://` to connect to Windows named pipes.
+
 The following options are available for modules and metricsets that define the
 host as an HTTP URL:
 
@@ -316,4 +323,4 @@ query:
 :modulename!:
 
 // Add Javascript and CSS for tabbed panels
-include::{libbeat-dir}/tab-widgets/code.asciidoc[]
+include::{libbeat-dir}/tab-widgets/code.asciidoc[]

metricbeat/docs/modules/appsearch.asciidoc

@@ -30,6 +30,9 @@ metricbeat.modules:
   #password: "changeme"
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/consul.asciidoc

@@ -40,6 +40,9 @@ metricbeat.modules:
 
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/couchdb.asciidoc

@@ -41,6 +41,9 @@ metricbeat.modules:
   hosts: ["localhost:5984"]
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/docker.asciidoc

@@ -61,6 +61,8 @@ metricbeat.modules:
     #key:                   "/etc/pki/client/cert.key"
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/envoyproxy.asciidoc

@@ -30,6 +30,9 @@ metricbeat.modules:
   hosts: ["localhost:9901"]
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/ibmmq.asciidoc

@@ -57,6 +57,7 @@ metricbeat.modules:
   metrics_path: /metrics
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
 It also supports the options described in <<module-http-config-options>>.
 
 [float]

metricbeat/docs/modules/istio.asciidoc

@@ -102,6 +102,9 @@ metricbeat.modules:
   hosts: ['localhost:15090']
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/nats.asciidoc

@@ -51,6 +51,9 @@ metricbeat.modules:
   #route.metrics_path: "/routez"
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/stan.asciidoc

@@ -40,6 +40,9 @@ metricbeat.modules:
   #subscriptions.metrics_path: "/streaming/channelsz" # we retrieve streaming subscriptions with a detailed query param to the channelsz endpoint
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/docs/modules/traefik.asciidoc

@@ -29,6 +29,9 @@ metricbeat.modules:
   hosts: ["localhost:8080"]
 ----
 
+This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
+It also supports the options described in <<module-http-config-options>>.
+
 [float]
 === Metricsets
 

metricbeat/helper/http_test.go

@@ -33,6 +33,7 @@ import (
 
 	"github.com/elastic/beats/v7/metricbeat/helper/dialer"
 	"github.com/elastic/beats/v7/metricbeat/mb"
+	"github.com/elastic/beats/v7/metricbeat/mb/parse"
 )
 
 func TestGetAuthHeaderFromToken(t *testing.T) {
@@ -196,80 +197,76 @@ func TestOverUnixSocket(t *testing.T) {
 		return
 	}
 
-	t.Run("at root", func(t *testing.T) {
-		tmpDir, err := ioutil.TempDir("", "testsocket")
-		require.NoError(t, err)
-		defer os.RemoveAll(tmpDir)
-
-		sockFile := tmpDir + "/test.sock"
+	cases := map[string]struct {
+		hostDataBuilder func(sockFile string) (mb.HostData, error)
+	}{
+		"at root": {
+			hostDataBuilder: func(sockFile string) (mb.HostData, error) {
+				return mb.HostData{
+					Transport:    dialer.NewUnixDialerBuilder(sockFile),
+					URI:          "http://unix/",
+					SanitizedURI: "http://unix",
+				}, nil
+			},
+		},
+		"at specific path": {
+			hostDataBuilder: func(sockFile string) (mb.HostData, error) {
+				uri := "http://unix/ok"
+				return mb.HostData{
+					Transport:    dialer.NewUnixDialerBuilder(sockFile),
+					URI:          uri,
+					SanitizedURI: uri,
+				}, nil
+			},
+		},
+		"with parser builder": {
+			hostDataBuilder: func(sockFile string) (mb.HostData, error) {
+				parser := parse.URLHostParserBuilder{}.Build()
+				return parser(&dummyModule{}, "http+unix://"+sockFile)
+			},
+		},
+	}
 
-		l, err := net.Listen("unix", sockFile)
+	serveOnUnixSocket := func(t *testing.T, path string) net.Listener {
+		l, err := net.Listen("unix", path)
 		require.NoError(t, err)
 
-		defer l.Close()
-
 		mux := http.NewServeMux()
 		mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
 			fmt.Fprintf(w, "ehlo!")
 		})
 
 		go http.Serve(l, mux)
 
-		cfg := defaultConfig()
-		hostData := mb.HostData{
-			Transport:    dialer.NewUnixDialerBuilder(sockFile),
-			URI:          "http://unix/",
-			SanitizedURI: "http://unix",
-		}
-
-		h, err := newHTTPFromConfig(cfg, "test", hostData)
-		require.NoError(t, err)
+		return l
+	}
 
-		r, err := h.FetchResponse()
-		require.NoError(t, err)
-		defer r.Body.Close()
-		content, err := ioutil.ReadAll(r.Body)
-		require.NoError(t, err)
-		assert.Equal(t, []byte("ehlo!"), content)
-	})
+	for title, c := range cases {
+		t.Run(title, func(t *testing.T) {
+			tmpDir, err := ioutil.TempDir("", "testsocket")
+			require.NoError(t, err)
+			defer os.RemoveAll(tmpDir)
 
-	t.Run("at specific path", func(t *testing.T) {
-		tmpDir, err := ioutil.TempDir("", "testsocket")
-		require.NoError(t, err)
-		defer os.RemoveAll(tmpDir)
+			sockFile := tmpDir + "/test.sock"
+			l := serveOnUnixSocket(t, sockFile)
+			defer l.Close()
 
-		sockFile := tmpDir + "/test.sock"
-		uri := "http://unix/ok"
+			cfg := defaultConfig()
 
-		l, err := net.Listen("unix", sockFile)
-		require.NoError(t, err)
+			hostData, err := c.hostDataBuilder(sockFile)
+			require.NoError(t, err)
 
-		defer l.Close()
+			h, err := newHTTPFromConfig(cfg, "test", hostData)
+			require.NoError(t, err)
 
-		mux := http.NewServeMux()
-		mux.HandleFunc("/ok", func(w http.ResponseWriter, r *http.Request) {
-			fmt.Fprintf(w, "ehlo!")
+			r, err := h.FetchResponse()
+			require.NoError(t, err)
+			defer r.Body.Close()
+			content, err := ioutil.ReadAll(r.Body)
+			require.NoError(t, err)
+			assert.Equal(t, []byte("ehlo!"), content)
 		})
-
-		go http.Serve(l, mux)
-
-		cfg := defaultConfig()
-		hostData := mb.HostData{
-			Transport:    dialer.NewUnixDialerBuilder(sockFile),
-			URI:          uri,
-			SanitizedURI: uri,
-		}
-
-		h, err := newHTTPFromConfig(cfg, "test", hostData)
-		require.NoError(t, err)
-
-		r, err := h.FetchResponse()
-		require.NoError(t, err)
-		defer r.Body.Close()
-		content, err := ioutil.ReadAll(r.Body)
-		require.NoError(t, err)
-		assert.Equal(t, []byte("ehlo!"), content)
-	})
+	}
 }
 
 func checkTimeout(t *testing.T, h *HTTP) {
@@ -291,3 +288,17 @@ func checkTimeout(t *testing.T, h *HTTP) {
 		t.Fatal("timeout should have happened time ago")
 	}
 }
+
+type dummyModule struct{}
+
+func (*dummyModule) Name() string {
+	return "dummy"
+}
+
+func (*dummyModule) Config() mb.ModuleConfig {
+	return mb.ModuleConfig{}
+}
+
+func (*dummyModule) UnpackConfig(interface{}) error {
+	return nil
+}

metricbeat/module/consul/_meta/fields.yml

@@ -3,6 +3,7 @@
   description: >
     Consul module
   release: beta
+  settings: ["ssl", "http"]
   fields:
     - name: consul
       type: group

metricbeat/module/couchdb/_meta/fields.yml

@@ -3,6 +3,7 @@
   description: >
     couchdb module
   release: ga
+  settings: ["ssl", "http"]
   fields:
     - name: couchdb
       type: group

metricbeat/module/docker/_meta/fields.yml

@@ -3,6 +3,7 @@
   description: >
     Docker stats collected from Docker.
   release: ga
+  settings: ["ssl"]
   short_config: false
   fields:
     - name: docker

metricbeat/module/envoyproxy/_meta/fields.yml

@@ -3,6 +3,7 @@
   description: >
     envoyproxy module
   release: ga
+  settings: ["ssl", "http"]
   fields:
     - name: envoyproxy
       type: group