Skip to content

Commit

Permalink
[exporter/loadbalancing] Set a placeholder endpoint (open-telemetry#3…
Browse files Browse the repository at this point in the history
…1381)

As part of
open-telemetry/opentelemetry-collector#9523, the
OTLP Exporter configuration used by the load balancing exporter is being
validates automatically. However, the endpoint is the only thing users
should NOT set, as it will be set at a later point in time by the load
balancer.

This PR sets a placeholder value for the endpoint so that the validation
passes.

Fixes open-telemetry#31371

Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>

---------

Signed-off-by: Juraci Paixão Kröhling <juraci@kroehling.de>
  • Loading branch information
jpkrohling authored and XinRanZhAWS committed Mar 13, 2024
1 parent 02f2ab6 commit 5f88275
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/lb-exporter-dummy-endpoint.yaml
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: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: loadbalancingexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Fixes a bug where the endpoint become required, despite not being used by the load balancing exporter.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [31371]

# (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: [user]
1 change: 1 addition & 0 deletions exporter/loadbalancingexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ func NewFactory() exporter.Factory {
func createDefaultConfig() component.Config {
otlpFactory := otlpexporter.NewFactory()
otlpDefaultCfg := otlpFactory.CreateDefaultConfig().(*otlpexporter.Config)
otlpDefaultCfg.Endpoint = "placeholder"

return &Config{
Protocol: Protocol{
Expand Down
12 changes: 12 additions & 0 deletions exporter/loadbalancingexporter/factory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,15 @@ func TestLogExporterGetsCreatedWithValidConfiguration(t *testing.T) {
assert.NoError(t, err)
assert.NotNil(t, exp)
}

func TestOTLPConfigIsValid(t *testing.T) {
// prepare
factory := NewFactory()
defaultCfg := factory.CreateDefaultConfig().(*Config)

// test
otlpCfg := defaultCfg.Protocol.OTLP

// verify
assert.NoError(t, otlpCfg.Validate())
}

0 comments on commit 5f88275

Please sign in to comment.