httpprovider for Collector: load configuration from config files in HTTP servers

CHANGELOG.md

@@ -51,6 +51,7 @@
 - Remove unnecessary limitation on `pcommon.Value.Equal` that slices have only primitive values. (#5865)
 - Add support to handle 404, 405 http error code as permanent errors in OTLP exporter (#5827)
 - Enforce scheme name restrictions to all `confmap.Provider` implementations. (#5861)
+- Add httpprovider to allow loading config files stored in HTTP (#5810)
 
 ### 🧰 Bug fixes 🧰
 

confmap/provider/httpprovider/README.md

@@ -0,0 +1,13 @@
+What is this new component httpprovider?
+- An implementation of ConfigMapProvider for HTTP (httpprovider) allows OTEL Collector the ability to load configuration for itself by fetching and reading config files stored in HTTP servers.
+
+How this new component httpprovider works?
+- It will be called by ConfigMapResolver to load configurations for OTEL Collector.
+- By giving a config URI starting with prefix 'http://', this httpprovider will be used to download config files from given HTTP URIs, and then used the downloaded config files to deploy the OTEL Collector.
+- In our code, we check the validity scheme and string pattern of HTTP URIs. And also check if there are any problems on config downloading and config deserialization.
+
+Expected URI format:
+- http://...
+
+Prerequistes:
+- Need to setup a HTTP server ahead, which returns with a config files according to the given URI

confmap/provider/httpprovider/provider.go

@@ -0,0 +1,84 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed 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 httpprovider // import "go.opentelemetry.io/collector/confmap/provider/httpprovider"
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"strings"
+
+	"go.opentelemetry.io/collector/confmap"
+	"go.opentelemetry.io/collector/confmap/provider/internal"
+)
+
+const (
+	schemeName = "http"
+)
+
+type httpClient interface {
+	Get(url string) (resp *http.Response, err error)
+}
+
+type provider struct {
+	client httpClient
+}
+
+// New returns a new confmap.Provider that reads the configuration from a file.
+//
+// This Provider supports "http" scheme, and can be called with a "uri" that follows:
+//
+// One example for http-uri be like: http://localhost:3333/getConfig
+//
+// Examples:
+// `http://localhost:3333/getConfig` - (unix, windows)
+func New() confmap.Provider {
+	return &provider{client: &http.Client{}}
+}
+
+func (fmp *provider) Retrieve(_ context.Context, uri string, _ confmap.WatcherFunc) (*confmap.Retrieved, error) {
+	if !strings.HasPrefix(uri, schemeName+"://") {
+		return nil, fmt.Errorf("%q uri is not supported by %q provider", uri, schemeName)
+	}
+
+	// send a HTTP GET request
+	resp, err := fmp.client.Get(uri)
+	if err != nil {
+		return nil, fmt.Errorf("unable to download the file via HTTP GET for uri %q, with err: %w ", uri, err)
+	}
+	defer resp.Body.Close()
+
+	// check the HTTP status code
+	if resp.StatusCode != 200 {
+		return nil, fmt.Errorf("404: resource didn't exist, fail to read the response body from uri %q", uri)
+	}
+
+	// read the response body
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		return nil, fmt.Errorf("fail to read the response body from uri %q, with err: %w ", uri, err)
+	}
+
+	return internal.NewRetrievedFromYAML(body)
+}
+
+func (*provider) Scheme() string {
+	return schemeName
+}
+
+func (*provider) Shutdown(context.Context) error {
+	return nil
+}

confmap/provider/httpprovider/provider_test.go

@@ -0,0 +1,119 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed 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 httpprovider
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"go.opentelemetry.io/collector/confmap"
+)
+
+// A HTTP client mocking httpmapprovider works in normal cases
+type testClient struct{}
+
+// Implement Get() for testClient in normal cases
+func (client *testClient) Get(url string) (resp *http.Response, err error) {
+	f, err := ioutil.ReadFile("./testdata/otel-config.yaml")
+	if err != nil {
+		return &http.Response{StatusCode: 404, Body: io.NopCloser(strings.NewReader("Cannot find the config file"))}, nil
+	}
+	return &http.Response{StatusCode: 200, Body: io.NopCloser(bytes.NewReader(f))}, nil
+}
+
+// Create a provider mocking httpmapprovider works in normal cases
+func NewTestProvider() confmap.Provider {
+	return &provider{client: &testClient{}}
+}
+
+// A HTTP client mocking httpmapprovider works when the returned config file is invalid
+type testInvalidClient struct{}
+
+// Implement Get() for testInvalidClient when the returned config file is invalid
+func (client *testInvalidClient) Get(url string) (resp *http.Response, err error) {
+	return &http.Response{}, fmt.Errorf("the downloaded config file is invalid")
+}
+
+// Create a provider mocking httpmapprovider works when the returned config file is invalid
+func NewTestInvalidProvider() confmap.Provider {
+	return &provider{client: &testInvalidClient{}}
+}
+
+// A HTTP client mocking httpmapprovider works when there is no corresponding config file according to the given http-uri
+type testNonExistClient struct{}
+
+// Implement Get() for testNonExistClient when there is no corresponding config file according to the given http-uri
+func (client *testNonExistClient) Get(url string) (resp *http.Response, err error) {
+	f, err := ioutil.ReadFile("./testdata/nonexist-otel-config.yaml")
+	if err != nil {
+		return &http.Response{StatusCode: 404, Body: io.NopCloser(strings.NewReader("Cannot find the config file"))}, nil
+	}
+	return &http.Response{StatusCode: 200, Body: io.NopCloser(bytes.NewReader(f))}, nil
+}
+
+// Create a provider mocking httpmapprovider works when there is no corresponding config file according to the given http-uri
+func NewTestNonExistProvider() confmap.Provider {
+	return &provider{client: &testNonExistClient{}}
+}
+
+func TestFunctionalityDownloadFileHTTP(t *testing.T) {
+	fp := NewTestProvider()
+	_, err := fp.Retrieve(context.Background(), "http://...", nil)
+	assert.NoError(t, err)
+	assert.NoError(t, fp.Shutdown(context.Background()))
+}
+
+func TestUnsupportedScheme(t *testing.T) {
+	fp := NewTestProvider()
+	_, err := fp.Retrieve(context.Background(), "https://google.com", nil)
+	assert.Error(t, err)
+	assert.NoError(t, fp.Shutdown(context.Background()))
+}
+
+func TestEmptyURI(t *testing.T) {
+	fp := NewTestProvider()
+	_, err := fp.Retrieve(context.Background(), "", nil)
+	require.Error(t, err)
+	require.NoError(t, fp.Shutdown(context.Background()))
+}
+
+func TestNonExistent(t *testing.T) {
+	fp := NewTestNonExistProvider()
+	_, err := fp.Retrieve(context.Background(), "http://non-exist-domain/...", nil)
+	assert.Error(t, err)
+	require.NoError(t, fp.Shutdown(context.Background()))
+}
+
+func TestInvalidYAML(t *testing.T) {
+	fp := NewTestInvalidProvider()
+	_, err := fp.Retrieve(context.Background(), "http://.../invalidConfig", nil)
+	assert.Error(t, err)
+	require.NoError(t, fp.Shutdown(context.Background()))
+}
+
+func TestScheme(t *testing.T) {
+	fp := NewTestProvider()
+	assert.Equal(t, "http", fp.Scheme())
+	require.NoError(t, fp.Shutdown(context.Background()))
+}

confmap/provider/httpprovider/testdata/otel-config.yaml

@@ -0,0 +1,37 @@
+extensions:
+  memory_ballast:
+    size_mib: 512
+  zpages:
+    endpoint: 0.0.0.0:55679
+
+receivers:
+  otlp:
+    protocols:
+      grpc:
+      http:
+
+processors:
+  batch:
+  memory_limiter:
+    # 75% of maximum memory up to 4G
+    limit_mib: 1536
+    # 25% of limit up to 2G
+    spike_limit_mib: 512
+    check_interval: 5s
+
+exporters:
+  logging:
+    loglevel: debug
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [memory_limiter, batch]
+      exporters: [logging]
+    metrics:
+      receivers: [otlp]
+      processors: [memory_limiter, batch]
+      exporters: [logging]
+
+  extensions: [memory_ballast, zpages]

service/config_provider.go

@@ -23,6 +23,7 @@ import (
 	"go.opentelemetry.io/collector/confmap/converter/expandconverter"
 	"go.opentelemetry.io/collector/confmap/provider/envprovider"
 	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
+	"go.opentelemetry.io/collector/confmap/provider/httpprovider"
 	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
 	"go.opentelemetry.io/collector/service/internal/configunmarshaler"
 )
@@ -84,7 +85,7 @@ func newDefaultConfigProviderSettings(uris []string) ConfigProviderSettings {
 	return ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:       uris,
-			Providers:  makeMapProvidersMap(fileprovider.New(), envprovider.New(), yamlprovider.New()),
+			Providers:  makeMapProvidersMap(fileprovider.New(), envprovider.New(), yamlprovider.New(), httpprovider.New()),
 			Converters: []confmap.Converter{expandconverter.New()},
 		},
 	}