hec_metadata_to_otel_attrs option is confusing on exporter/splunkhec

[bderrly]

Component(s)

exporter/splunkhec

Describe the issue you're reporting

The config option hec_metadata_to_otel_attrs is confusing when used with the splunkhec exporter as the actual effect is the opposite, i.e. taking otel attributes and using them as HEC metadata when sending to some destination.

opentelemetry-collector-contrib/exporter/splunkhecexporter/config.go

Line 120 in bd66ceb

HecToOtelAttrs splunk.HecToOtelAttrs `mapstructure:"hec_metadata_to_otel_attrs"`

[github-actions]

Pinging code owners:

• exporter/splunkhec: @atoulme @dmitryax

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

[atoulme]

Would you like to offer a PR to fix the naming?

[bderrly]

I could do that. Before I set out to do it, is there agreement that the naming is confusing enough that we should change it?

[atoulme]

Yes, I think so. As you change the name, we will want to mark the current field deprecated and keep it around for a little while, and introduce a new field. Best to discuss the name of the new field in this issue. I guess it should be otel_attrs_to_hec_metadata?

[bderrly]

I guess it should be otel_attrs_to_hec_metadata?

That is what I was thinking.