Add the Elastic product origin header when talking to Elasticsearch o…

…r Kibana. (elastic#29966)

Set the beats product origin header by default when communicating with Elasticsearch or Kibana.

libbeat/common/productorigin/productorigin.go

@@ -0,0 +1,29 @@
+// 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 productorigin defines the Elastic product origin header.
+package productorigin
+
+const (
+	// Identifies a request as originating from an Elastic product. Has the side effect of
+	// suppressing Elasticsearch API deprecation warnings in Kibana when set.
+	Header = "X-Elastic-Product-Origin"
+
+	// Applicable values from https://github.com/elastic/kibana/blob/main/x-pack/plugins/upgrade_assistant/common/constants.ts#L50
+	Observability = "observability"
+	Beats         = "beats"
+)

libbeat/esleg/eslegclient/connection.go

@@ -30,6 +30,7 @@ import (
 	"go.elastic.co/apm/module/apmelasticsearch"
 
 	"github.com/elastic/beats/v7/libbeat/common"
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 	"github.com/elastic/beats/v7/libbeat/common/transport"
 	"github.com/elastic/beats/v7/libbeat/common/transport/httpcommon"
 	"github.com/elastic/beats/v7/libbeat/common/transport/kerberos"
@@ -84,7 +85,9 @@ type ConnectionSettings struct {
 func NewConnection(s ConnectionSettings) (*Connection, error) {
 	logger := logp.NewLogger("esclientleg")
 
-	s = settingsWithDefaults(s)
+	if s.IdleConnTimeout == 0 {
+		s.IdleConnTimeout = 1 * time.Minute
+	}
 
 	u, err := url.Parse(s.URL)
 	if err != nil {
@@ -117,6 +120,14 @@ func NewConnection(s ConnectionSettings) (*Connection, error) {
 	}
 	userAgent := useragent.UserAgent(s.Beatname)
 
+	// Default the product origin header to beats if it wasn't already set.
+	if _, ok := s.Headers[productorigin.Header]; !ok {
+		if s.Headers == nil {
+			s.Headers = make(map[string]string)
+		}
+		s.Headers[productorigin.Header] = productorigin.Beats
+	}
+
 	httpClient, err := s.Transport.Client(
 		httpcommon.WithLogger(logger),
 		httpcommon.WithIOStats(s.Observer),
@@ -155,15 +166,6 @@ func NewConnection(s ConnectionSettings) (*Connection, error) {
 	return &conn, nil
 }
 
-func settingsWithDefaults(s ConnectionSettings) ConnectionSettings {
-	settings := s
-	if settings.IdleConnTimeout == 0 {
-		settings.IdleConnTimeout = 1 * time.Minute
-	}
-
-	return settings
-}
-
 // NewClients returns a list of Elasticsearch clients based on the given
 // configuration. It accepts the same configuration parameters as the Elasticsearch
 // output, except for the output specific configuration options.  If multiple hosts

libbeat/esleg/eslegclient/connection_test.go

@@ -25,6 +25,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
+
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 )
 
 func TestAPIKeyEncoding(t *testing.T) {
@@ -71,18 +73,21 @@ func TestHeaders(t *testing.T) {
 		expected map[string][]string
 	}{
 		{input: map[string]string{
-			"Accept":       "application/vnd.elasticsearch+json;compatible-with=7",
-			"Content-Type": "application/vnd.elasticsearch+json;compatible-with=7",
-			"X-My-Header":  "true"},
+			"Accept":             "application/vnd.elasticsearch+json;compatible-with=7",
+			"Content-Type":       "application/vnd.elasticsearch+json;compatible-with=7",
+			productorigin.Header: "elastic-product",
+			"X-My-Header":        "true"},
 			expected: map[string][]string{
-				"Accept":       {"application/vnd.elasticsearch+json;compatible-with=7"},
-				"Content-Type": {"application/vnd.elasticsearch+json;compatible-with=7"},
-				"X-My-Header":  {"true"}}},
+				"Accept":             {"application/vnd.elasticsearch+json;compatible-with=7"},
+				"Content-Type":       {"application/vnd.elasticsearch+json;compatible-with=7"},
+				productorigin.Header: {"elastic-product"},
+				"X-My-Header":        {"true"}}},
 		{input: map[string]string{
 			"X-My-Header": "true"},
 			expected: map[string][]string{
-				"Accept":      {"application/json"},
-				"X-My-Header": {"true"}}},
+				"Accept":             {"application/json"},
+				productorigin.Header: {productorigin.Beats},
+				"X-My-Header":        {"true"}}},
 	} {
 		conn, err := NewConnection(ConnectionSettings{
 			Headers: td.input,

metricbeat/module/elasticsearch/metricset.go

@@ -23,6 +23,7 @@ import (
 
 	"github.com/pkg/errors"
 
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 	"github.com/elastic/beats/v7/metricbeat/helper"
 	"github.com/elastic/beats/v7/metricbeat/mb"
 	"github.com/elastic/beats/v7/metricbeat/mb/parse"
@@ -90,6 +91,8 @@ func NewMetricSet(base mb.BaseMetricSet, servicePath string) (*MetricSet, error)
 		return nil, err
 	}
 
+	http.SetHeaderDefault(productorigin.Header, productorigin.Beats)
+
 	config := struct {
 		Scope        Scope `config:"scope"`
 		XPackEnabled bool  `config:"xpack.enabled"`

metricbeat/module/kibana/settings/settings.go

@@ -20,6 +20,7 @@ package settings
 import (
 	"fmt"
 
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 	"github.com/elastic/beats/v7/metricbeat/helper"
 	"github.com/elastic/beats/v7/metricbeat/mb"
 	"github.com/elastic/beats/v7/metricbeat/mb/parse"
@@ -77,6 +78,8 @@ func (m *MetricSet) init() (err error) {
 		return err
 	}
 
+	httpHelper.SetHeaderDefault(productorigin.Header, productorigin.Beats)
+
 	kibanaVersion, err := kibana.GetVersion(httpHelper, kibana.SettingsPath)
 	if err != nil {
 		return err

metricbeat/module/kibana/stats/stats.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/pkg/errors"
 
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 	"github.com/elastic/beats/v7/metricbeat/helper"
 	"github.com/elastic/beats/v7/metricbeat/mb"
 	"github.com/elastic/beats/v7/metricbeat/mb/parse"
@@ -84,6 +85,8 @@ func (m *MetricSet) init() error {
 		return err
 	}
 
+	statsHTTP.SetHeaderDefault(productorigin.Header, productorigin.Beats)
+
 	kibanaVersion, err := kibana.GetVersion(statsHTTP, kibana.StatsPath)
 	if err != nil {
 		return err

metricbeat/module/kibana/status/status.go

@@ -18,6 +18,7 @@
 package status
 
 import (
+	"github.com/elastic/beats/v7/libbeat/common/productorigin"
 	"github.com/elastic/beats/v7/metricbeat/helper"
 	"github.com/elastic/beats/v7/metricbeat/mb"
 	"github.com/elastic/beats/v7/metricbeat/mb/parse"
@@ -59,6 +60,8 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
 		return nil, err
 	}
 
+	http.SetHeaderDefault(productorigin.Header, productorigin.Beats)
+
 	return &MetricSet{
 		ms,
 		http,