[exporter/googlecloud] OpAMP extension panics if googlecloud exporter is configured

[BinaryFissionGames]

Component(s)

exporter/googlecloud

What happened?

Description

If the google cloud exporter is configured, the OpAMP extension may panic when it tries to compose the effective config.

panic: cannot marshal type: func() []option.ClientOption [recovered]
	panic: cannot marshal type: func() []option.ClientOption

The issue is that the functional options in the config struct cannot be marshalled, so the yaml marshal panics. To fix this, we'll need to put mapstructure:"-" tags on the functional arguments in the googlecloud exporter config structs.

I also think the opamp extension could probably handle this situation more gracefully, by at the very least catching the panic.

Collector version

v0.106.1

Environment information

No response

OpenTelemetry Collector configuration

No response

Log output

No response

Additional context

No response

[github-actions]

Pinging code owners:

• exporter/googlecloud: @aabmass @dashpole @jsuereth @punya @damemi @psx95

See Adding Labels via Comments if you do not have permissions to add labels yourself.

[JaredTan95]

Can you post a yaml configuration with minimal produce this issue?

[dashpole]

I'll make sure the tags are added in the next release! I opened GoogleCloudPlatform/opentelemetry-operations-go#879

[BinaryFissionGames]

Thanks @dashpole! I think it's not just this option, but basically anything that can't be marshalled by the yaml package that will end up causing problems.

For reference, here's a small config that exhibits the issue (you do not need an OpAMP server running to reproduce):

receivers:
  hostmetrics:
    collection_interval: 15s
    scrapers:
      load:

exporters:
  googlecloud:
    project: "${GCP_PROJECT}"

extensions:
  opamp:
    capabilities:
      reports_effective_config: true
    server:
      ws:
        endpoint: "ws://localhost:1111/v1/opamp"
        tls:
          insecure: true

service:
  extensions: [opamp]
  pipelines:
    metrics:
      receivers: [hostmetrics]
      exporters: [googlecloud]

[dashpole]

@BinaryFissionGames adding the mapstructure tag didn't seem to fix it: GoogleCloudPlatform/opentelemetry-operations-go#880. Is the test case I added correct?

[BinaryFissionGames]

@BinaryFissionGames adding the mapstructure tag didn't seem to fix it: GoogleCloudPlatform/opentelemetry-operations-go#880. Is the test case I added correct?

There's a step before the marshal that adds it to a confmap. I think this is what the test should be:

func TestMarshal(t *testing.T) {
	config := DefaultConfig()

	cm := confmap.New()
	err := cm.Marshal(config)
	if err != nil {
		t.Fatal(err)
	}

	_, err = yaml.Marshal(cm.ToStringMap())
	if err != nil {
		t.Fatal(err)
	}
}

[dashpole]

Thanks. That seemed to work.

[github-actions]

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

• exporter/googlecloud: @aabmass @dashpole @jsuereth @punya @damemi @psx95

See Adding Labels via Comments if you do not have permissions to add labels yourself.

[dashpole]

Fixed by #35366