Suggestions on ensuring consistent instanceId

[mike9421]

Component(s)

cmd/opampsupervisor, extension/opamp

Describe the issue you're reporting

According to opampsupervisor document, the current approach is: supervisor generate instance_uid, and The value is injected into the Collector config in opamp extension's instance_uid setting and as service.instance.id attribute under the service.telemetry.resource setting. In this way, it will not work if the opamp extension is not enabled.

According to otel source code, after OTEL starts, it will read the configuration item (service.telemetry.resource.service.instance.id) of the configuration file. If the configuration item does not exist, it will be randomly generated. Why not write it to the configuration item when opampsupervisor generates instance_uid? after all OTEL is started by opampsupervisor

[github-actions]

Pinging code owners:

• cmd/opampsupervisor: @evan-bradley @atoulme @tigrannajaryan
• extension/opamp: @portertech @evan-bradley @tigrannajaryan

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

[tigrannajaryan]

Why not write it to the configuration item when opampsupervisor generates instance_uid?

I think that's exactly what Supervisor does:

opentelemetry-collector-contrib/cmd/opampsupervisor/supervisor/supervisor.go

Line 327 in d7b940b

service.instance.id: %s

What is the problem that you see?

[mike9421]

@tigrannajaryan Thanks for your answer.

Why not write it to the configuration item when opampsupervisor generates instance_uid?

I think that's exactly what Supervisor does:

opentelemetry-collector-contrib/cmd/opampsupervisor/supervisor/supervisor.go

Line 327 in d7b940b

service.instance.id: %s

Yes, the instanceId generated by opampsupervisor will be merged into the OTEL configuration file only when opampsupervisor does not have local configuration (effective.yaml) or receives remote configuration.

But if the user provides 'effective.yaml' and the opamp extension is not enabled, in this case the instanceId and OTEL's service.instance.id will be consistent only until the user remotely configures it.

When opampsupervisor generates instance_uid, this value is written into OTEL's configuration item (service.telemetry.resource.service.instance.id). This may not cause this problem?

[tigrannajaryan]

As far as I can see from the code the instance id is always generated by the supervisor and written into the Collector's config file. I am not sure I understand what is the problem.

[mike9421]

As far as I can see from the code the instance id is always generated by the supervisor and written into the Collector's config file. I am not sure I understand what is the problem.

According to the discuss, opampsupervisor should merge the default configuration (eg. noop configuration)

But according to loadAgentEffectiveConfig, If the file corresponding to the "effectiveConfigFilePath" path exists(eg. the user configures), opampsupervisor will not merge configurations when starting otel for the first time.

But if the user provides 'effective.yaml' and the opamp extension is not enabled, in this case the instanceId and OTEL's service.instance.id will be consistent only until the user remotely configures it.

There would be a problem unless the user could not customize the contents of the file corresponding to the "effectiveConfigFilePath" path before launching the program.

[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:

• cmd/opampsupervisor: @evan-bradley @atoulme @tigrannajaryan
• extension/opamp: @portertech @evan-bradley @tigrannajaryan

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

[github-actions]

This issue has been closed as inactive because it has been stale for 120 days with no activity.