Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct the comment for the priority of options and environments on otlptracehttp #5584

Merged
merged 6 commits into from
Jul 9, 2024
Merged

Correct the comment for the priority of options and environments on otlptracehttp #5584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
decc7c8
Correct the comment for the priority of options and environments on o…
XSAM Jul 8, 2024
1fe1233
Add more tests
XSAM Jul 8, 2024
13f3b2f
Update CHANGELOG
XSAM Jul 8, 2024
21ec75d
Merge branch 'main' into priority-of-option-and-env-for-otlptracehttp
XSAM Jul 8, 2024
5ea7fa6
Merge branch 'main' into priority-of-option-and-env-for-otlptracehttp
XSAM Jul 8, 2024
90595ea
Merge branch 'main' into priority-of-option-and-env-for-otlptracehttp
XSAM Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased]

### Fixed

- Correct comments for the priority of the `WithEndpoint` and `WithEndpointURL` options and their corresponding environment variables in `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`. (#5584)

<!-- Released section -->
<!-- Don't change this section unless doing release -->

Expand Down
38 changes: 37 additions & 1 deletion exporters/otlp/otlptrace/otlptracegrpc/internal/otlpconfig/options_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,26 @@ func TestConfigs(t *testing.T) {
assert.Equal(t, "/v1/traces", c.Traces.URLPath)
},
},
{
name: "Test With Endpoint last used",
opts: []GenericOption{
WithEndpointURL("https://someendpoint/somepath"),
WithEndpoint("someendpoint2"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint2", c.Traces.Endpoint)
},
},
{
name: "Test With WithEndpointURL last used",
opts: []GenericOption{
WithEndpoint("someendpoint2"),
WithEndpointURL("https://someendpoint/somepath"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint",
env: map[string]string{
Expand Down Expand Up @@ -159,15 +179,31 @@ func TestConfigs(t *testing.T) {
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpointURL("https://traces_endpoint2/somepath"),
WithEndpoint("traces_endpoint"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint", c.Traces.Endpoint)
},
},
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpoint("traces_endpoint"),
WithEndpointURL("https://traces_endpoint2/somepath"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint2", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint with HTTP scheme",
env: map[string]string{
Expand Down
38 changes: 37 additions & 1 deletion exporters/otlp/otlptrace/otlptracehttp/internal/otlpconfig/options_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,26 @@ func TestConfigs(t *testing.T) {
assert.Equal(t, "/v1/traces", c.Traces.URLPath)
},
},
{
name: "Test With Endpoint last used",
opts: []GenericOption{
WithEndpointURL("https://someendpoint/somepath"),
WithEndpoint("someendpoint2"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint2", c.Traces.Endpoint)
},
},
{
name: "Test With WithEndpointURL last used",
opts: []GenericOption{
WithEndpoint("someendpoint2"),
WithEndpointURL("https://someendpoint/somepath"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint",
env: map[string]string{
Expand Down Expand Up @@ -159,15 +179,31 @@ func TestConfigs(t *testing.T) {
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpointURL("https://traces_endpoint2/somepath"),
WithEndpoint("traces_endpoint"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint", c.Traces.Endpoint)
},
},
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpoint("traces_endpoint"),
WithEndpointURL("https://traces_endpoint2/somepath"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint2", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint with HTTP scheme",
env: map[string]string{
Expand Down
11 changes: 7 additions & 4 deletions exporters/otlp/otlptrace/otlptracehttp/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,10 @@ func (w wrappedOption) applyHTTPOption(cfg otlpconfig.Config) otlpconfig.Config
//
// If the OTEL_EXPORTER_OTLP_ENDPOINT or OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
// environment variable is set, and this option is not passed, that variable
// value will be used. If both are set, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
// will take precedence. Note, both environment variables include the full
// value will be used. If both environment variables are set,
// OTEL_EXPORTER_OTLP_TRACES_ENDPOINT will take precedence. If an environment
// variable is set, and this option is passed, this option will take precedence.
// Note, both environment variables include the full
// scheme and path, while WithEndpoint sets only the host and port.
//
// If both this option and WithEndpointURL are used, the last used option will
Expand All @@ -82,8 +84,9 @@ func WithEndpoint(endpoint string) Option {
//
// If the OTEL_EXPORTER_OTLP_ENDPOINT or OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
// environment variable is set, and this option is not passed, that variable
// value will be used. If both are set, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
// will take precedence.
// value will be used. If both environment variables are set,
// OTEL_EXPORTER_OTLP_TRACES_ENDPOINT will take precedence. If an environment
// variable is set, and this option is passed, this option will take precedence.
//
// If both this option and WithEndpoint are used, the last used option will
// take precedence.
Expand Down
38 changes: 37 additions & 1 deletion internal/shared/otlp/otlptrace/otlpconfig/options_test.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,26 @@ func TestConfigs(t *testing.T) {
assert.Equal(t, "/v1/traces", c.Traces.URLPath)
},
},
{
name: "Test With Endpoint last used",
opts: []GenericOption{
WithEndpointURL("https://someendpoint/somepath"),
WithEndpoint("someendpoint2"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint2", c.Traces.Endpoint)
},
},
{
name: "Test With WithEndpointURL last used",
opts: []GenericOption{
WithEndpoint("someendpoint2"),
WithEndpointURL("https://someendpoint/somepath"),
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "someendpoint", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint",
env: map[string]string{
Expand Down Expand Up @@ -159,15 +179,31 @@ func TestConfigs(t *testing.T) {
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpointURL("https://traces_endpoint2/somepath"),
WithEndpoint("traces_endpoint"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint", c.Traces.Endpoint)
},
},
{
name: "Test Mixed Environment and With Endpoint",
opts: []GenericOption{
WithEndpoint("traces_endpoint"),
WithEndpointURL("https://traces_endpoint2/somepath"),
},
env: map[string]string{
"OTEL_EXPORTER_OTLP_ENDPOINT": "env_endpoint",
"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": "env_endpoint2",
},
asserts: func(t *testing.T, c *Config, grpcOption bool) {
assert.Equal(t, "traces_endpoint2", c.Traces.Endpoint)
},
},
{
name: "Test Environment Endpoint with HTTP scheme",
env: map[string]string{
Expand Down