Skip to content

Align OpAMP data model guidance with upstream #387

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.

Sign up for GitHub

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

Open
breedx-splk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Align OpAMP data model guidance with upstream #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@

#### Enhancements

- Align OpAMP data model guidance with upstream `opamp-spec`.
- Add initial data model for agent identify with OpAMP.
[#379](https://github.com/signalfx/gdi-specification/pull/379)

Expand Down
20 changes: 10 additions & 10 deletions specification/opamp_datamodel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
**Status**: [Experimental](../README.md#versioning-and-status-of-the-specification)

This document describes data model fields used by *language agents*
when configured to communicate with an OpAMP server. For more information
about OpAMP, please see the
[opamp-spec](https://github.com/open-telemetry/opamp-spec).
when configured to communicate with an OpAMP server.

Guidance for OpenTelemetry language agents is defined upstream in
[OpenTelemetry Guidelines](https://github.com/open-telemetry/opamp-spec/blob/main/opentelemetry-guidelines.md)
in the [opamp-spec](https://github.com/open-telemetry/opamp-spec).
GDI language agents that use OpAMP SHOULD follow that upstream guidance.
Copy link
Copy Markdown
Contributor

@Kielek Kielek Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just remove everything below this line?

It is just duplication. Not a hard blocker from my perspective.

Copy link
Copy Markdown
Contributor Author

@breedx-splk breedx-splk Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, that would be fine...there are pros/cons.

Pros: shorter doc, more concise.
Cons: this doc is likely to grow beyond identity and will probably contain guidance about configuration etc. Having identify called out might be nice because it's not assumed.


## Identifying Attributes

The `AgentDescription` message includes a set of
[identifying attributes](https://github.com/open-telemetry/opamp-spec/blob/main/specification.md#agentdescriptionidentifying_attributes).

This set of identifying attributes MUST be comprised, in its entirety,
of the Agent's resource attributes. All detected or configured
resource attributes MUST be present in the identifying attributes.
The identifying attributes MUST NOT contain any other attributes
that are not obtained from the current Resource.
GDI language agents SHOULD follow the upstream guidance for which
OpenTelemetry `Resource` attributes belong in this field.

## Non-Identifying Attributes

The `AgentDescription` message includes a set of
[non-identifying attributes](https://github.com/open-telemetry/opamp-spec/blob/main/specification.md#agentdescriptionnon_identifying_attributes).
Agents SHOULD NOT specify any non-identifying attributes.
GDI language agents SHOULD follow the upstream guidance for which
OpenTelemetry `Resource` attributes belong in this field.
Loading