-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[extension/httpforwarder] rename httpforwarder to httpforwarderextens…
…ion (#30981) **Description:** Deprecate the httpforwarder extension Introduce the httpforwarderextension extension. **Link to tracking Issue:** Relates to #24171
- Loading branch information
Showing
30 changed files
with
1,003 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: breaking | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
| component: httpforwarderextension | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Rename the extension httpforwarder to httpforwarderextension | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [24171] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | ||
|
|
||
| # If your change doesn't affect end users or the exported elements of any package, | ||
| # you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
| # Optional: The change log or logs in which this entry should be included. | ||
| # e.g. '[user]' or '[user, api]' | ||
| # Include 'user' if the change is relevant to end users. | ||
| # Include 'api' if there is a change to a library API. | ||
| # Default: '[user]' | ||
| change_logs: [api] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| include ../../Makefile.Common |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # HTTP Forwarder Extension | ||
| <!-- status autogenerated section --> | ||
| | Status | | | ||
| | ------------- |-----------| | ||
| | Stability | [beta] | | ||
| | Distributions | [] | | ||
| | Issues | [](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aextension%2Fhttpforwarder) [](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aextension%2Fhttpforwarder) | | ||
| | [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@atoulme](https://www.github.com/atoulme), [@rmfitzpatrick](https://www.github.com/rmfitzpatrick) | | ||
|
|
||
| [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta | ||
| <!-- end autogenerated section --> | ||
|
|
||
| This extension accepts HTTP requests, optionally adds headers to them and forwards them. | ||
| The RequestURIs of the original requests are preserved by the extension. | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following settings are required: | ||
|
|
||
| - `egress`: HTTP config settings to use for forwarding requests. | ||
| - `endpoint` (no default): The target to which requests should be forwarded to. | ||
|
|
||
| The following settings can be optionally configured: | ||
|
|
||
| - `ingress`: HTTP config settings for HTTP server listening to requests. | ||
| - `endpoint` (default = `0.0.0.0:6060`): The host to which requests should be forwarded to. | ||
| - `egress`: HTTP config settings to use for forwarding requests. | ||
| - `headers` (default = `nil`): Additional headers to be added to all requests passing through the extension. | ||
| - `timeout` (default = `10s`): How long to wait for each request to complete. | ||
|
|
||
| ### Example | ||
|
|
||
| ```yaml | ||
| http_forwarder: | ||
| ingress: | ||
| endpoint: localhost:7070 | ||
| egress: | ||
| endpoint: http://target/ | ||
| headers: | ||
| otel_http_forwarder: dev | ||
| timeout: 5s | ||
| ``` | ||
| The full list of settings exposed for this exporter are documented [here](config.go) | ||
| with detailed sample configurations [here](testdata/config.yaml). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package httpforwarderextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarderextension" | ||
|
|
||
| import ( | ||
| "go.opentelemetry.io/collector/config/confighttp" | ||
| ) | ||
|
|
||
| // Config defines configuration for http forwarder extension. | ||
| type Config struct { | ||
|
|
||
| // Ingress holds config settings for HTTP server listening for requests. | ||
| Ingress confighttp.ServerConfig `mapstructure:"ingress"` | ||
|
|
||
| // Egress holds config settings to use for forwarded requests. | ||
| Egress confighttp.ClientConfig `mapstructure:"egress"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package httpforwarderextension | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/collector/component" | ||
| "go.opentelemetry.io/collector/config/confighttp" | ||
| "go.opentelemetry.io/collector/config/configopaque" | ||
| "go.opentelemetry.io/collector/confmap/confmaptest" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarderextension/internal/metadata" | ||
| ) | ||
|
|
||
| func TestLoadConfig(t *testing.T) { | ||
| t.Parallel() | ||
| maxIdleConns := 42 | ||
| idleConnTimeout := 80 * time.Second | ||
|
|
||
| tests := []struct { | ||
| id component.ID | ||
| expected component.Config | ||
| }{ | ||
| { | ||
| id: component.NewID(metadata.Type), | ||
| expected: NewFactory().CreateDefaultConfig(), | ||
| }, | ||
| { | ||
| id: component.NewIDWithName(metadata.Type, "1"), | ||
| expected: &Config{ | ||
| Ingress: confighttp.ServerConfig{ | ||
| Endpoint: "http://localhost:7070", | ||
| }, | ||
| Egress: confighttp.ClientConfig{ | ||
| Endpoint: "http://target/", | ||
| Headers: map[string]configopaque.String{ | ||
| "otel_http_forwarder": "dev", | ||
| }, | ||
| MaxIdleConns: &maxIdleConns, | ||
| IdleConnTimeout: &idleConnTimeout, | ||
| Timeout: 5 * time.Second, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.id.String(), func(t *testing.T) { | ||
| cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml")) | ||
| require.NoError(t, err) | ||
| factory := NewFactory() | ||
| cfg := factory.CreateDefaultConfig() | ||
| sub, err := cm.Sub(tt.id.String()) | ||
| require.NoError(t, err) | ||
| require.NoError(t, component.UnmarshalConfig(sub, cfg)) | ||
| assert.NoError(t, component.ValidateConfig(cfg)) | ||
| assert.Equal(t, tt.expected, cfg) | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //go:generate mdatagen metadata.yaml | ||
|
|
||
| // Package httpforwarderextension accepts HTTP requests, optionally adds headers to them and forwards them. | ||
| package httpforwarderextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/httpforwarderextension" |
Oops, something went wrong.