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

Database/Messaging extensions: revise extends in yaml #360

Closed
lmolkova opened this issue Oct 2, 2023 · 4 comments
Closed

Database/Messaging extensions: revise extends in yaml #360

lmolkova opened this issue Oct 2, 2023 · 4 comments
Assignees

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Oct 2, 2023

Came up in #359 (comment).

UPDATE: based on the discussion in Semconv WG:

  • we need to revisit individual database semconv and check if they should extend base db conventions in yaml.
  • if some of the recommended generic attributes do not apply to specific DB, extensions should not extend base one and should rather reference all applicable attributes
  • based on this we can also restructure generic DB conventions and adjust requirement levels

The context:

Elasticsearch semconv extends db in yaml, but re-referenced attributes in the server.* namespace, so it's unclear what was the original intent and what the actually full semconv should be:

Option 1:

If Elastic should only report attributes currently defined/referenced in yaml (without extending db), then all the attributes are

<!-- semconv db.elasticsearch -->

Attribute
db.elasticsearch.cluster.name
db.elasticsearch.node.name
db.elasticsearch.path_parts.<key>
db.operation
db.statement
http.request.method
server.address
server.port
url.full

Option 2:

If elasticsearch should extend DB, then it implicitly includes the following attributes (if a full MD table is rendered)

<!-- semconv db.elasticsearch(full) -->

Attribute
db.connection_string
db.elasticsearch.cluster.name
db.elasticsearch.node.name
db.elasticsearch.path_parts.<key>
db.jdbc.driver_classname
db.name
db.operation
db.statement
db.system
db.user
network.transport
network.type
server.address
server.port
server.socket.address
server.socket.domain
server.socket.port
url.full
@lmolkova
Copy link
Contributor Author

lmolkova commented Oct 2, 2023

/cc @estolfo

@lmolkova lmolkova changed the title Elasticsearch semconv: should it extend DB semconv? Database extensions: revise extends in yaml Oct 19, 2023
@github-actions github-actions bot added the Stale label Feb 13, 2024
@joaopgrassi joaopgrassi removed the Stale label Feb 14, 2024
@lmolkova lmolkova changed the title Database extensions: revise extends in yaml Database/Messaging extensions: revise extends in yaml Mar 18, 2024
@lmolkova
Copy link
Contributor Author

I believe we should provide all the applicable attributes in the system-specific md tables for all databases and messaging extensions.

It would provide clarify to the readers and instrumentation authors and allow semconv authors to document system-specific things about the attributes.

@lmolkova lmolkova assigned lmolkova and unassigned reyang Apr 26, 2024
@trask
Copy link
Member

trask commented Apr 26, 2024

@lmolkova is this now a duplicate of #869?

@lmolkova
Copy link
Contributor Author

lmolkova commented May 1, 2024

yes, #869 is wider than this one. Let's close this one.

@lmolkova lmolkova closed this as completed May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: V1 - Stable Semantics
Development

No branches or pull requests

4 participants