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.

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

[cmd/opampsupervisor]: Allow configuring the agent description #32824

Closed
BinaryFissionGames opened this issue May 2, 2024 · 1 comment · Fixed by #32819
Closed

[cmd/opampsupervisor]: Allow configuring the agent description #32824

BinaryFissionGames opened this issue May 2, 2024 · 1 comment · Fixed by #32819
Labels

Comments

@BinaryFissionGames
Copy link
Contributor

Component(s)

cmd/opampsupervisor

Is your feature request related to a problem? Please describe.

We would like to be able to associate extra user-specified information with the agent. In our case, we have a user that would like to be able to add extra identifying information (a separate unique ID) to OpAMP's agent description message.

The spec allows for a user to specify necessary identifying attributes, as well as any non-identifying attributes a user would like to associate with the agent. See: https://github.com/open-telemetry/opamp-spec/blob/main/specification.md#agentdescriptionidentifying_attributes

Describe the solution you'd like

The supervisor should support configuring extra agent_description attributes.

The configuration would end up looking like this:

agent:
  description:
    identifying_attributes:
      key: val
    non_identifying_attributes:
      key: val

Where key and val are arbitrary key-value pairs.

These key-value pairs will be injected by the supervisor into the agent description retrieved during the bootstrap process. The values in the supervisor config will override the ones in the collector's agent description.

Describe alternatives you've considered

No response

Additional context

We discussed allowing the opamp extension to configure identifying attributes, but decided that it was susceptible to mis-configuration (identifying attributes must be on the agent's self-telemetry).

For more context, see:
#32644

Copy link
Contributor

github-actions bot commented May 2, 2024

Pinging code owners:

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

@evan-bradley evan-bradley removed the needs triage New item requiring triage label May 15, 2024
andrzej-stencel pushed a commit that referenced this issue May 15, 2024
**Description:** <Describe what has changed.>
* Add options to the configuration that allows configuring the agent
description

**Link to tracking Issue:** Closes #32824

**Testing:** e2e test, unit tests for validation

**Documentation:**
* Updated spec with configuration parameters

---------

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this issue Jul 11, 2024
…metry#32819)

**Description:** <Describe what has changed.>
* Add options to the configuration that allows configuring the agent
description

**Link to tracking Issue:** Closes open-telemetry#32824

**Testing:** e2e test, unit tests for validation

**Documentation:**
* Updated spec with configuration parameters

---------

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants