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

any_of markdown output is misleading if each set only has one member #33

Closed
Oberon00 opened this issue Mar 1, 2021 · 4 comments
Closed
Labels
bug Something isn't working semconv/md Related specifically to the markdown output of the semantic convention generator semconv Related to the semantic convention generator.

Comments

@Oberon00
Copy link
Member

Oberon00 commented Mar 1, 2021

E.g. see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.0.1/specification/trace/semantic_conventions/database.md#connection-level-attributes

Additional attribute requirements: At least one of the following sets of attributes is required:

  • net.peer.name
  • net.peer.ip

Obviously the set here is {"net.peer.name", "net.peer.ip"}, so you need both. Except: This is wrong! There are two sets, one contains only net.peer.name and the other only net.peer.ip.

I think if each set contains only one member, the text above the list MUST change to "At least one of the following sets of attributes is required:" (without the sets of).

@thisthat
Copy link
Member

thisthat commented Apr 7, 2021

I am not a native speaker, so I cannot judge properly which is the best phrase to use here.
Would you also remove "sets of" in the case where multiple attributes are listed?
An example of this is in the HTTP Client semantic convention:

Additional attribute requirements: At least one of the following sets of attributes is required:

@Oberon00
Copy link
Member Author

Oberon00 commented Apr 7, 2021

I think if at least one set has more than one member, the current phrasing is clear and in these cases I would keep it as-is.

@Oberon00 Oberon00 added semconv Related to the semantic convention generator. bug Something isn't working semconv/md Related specifically to the markdown output of the semantic convention generator labels Apr 7, 2021
Oberon00 added a commit to dynatrace-oss-contrib/opentelemetry-specification that referenced this issue Jun 10, 2021
This should be changed back once
open-telemetry/build-tools#33
is resolved & the updated build tools available.
SergeyKanzhelev pushed a commit to open-telemetry/opentelemetry-specification that referenced this issue Jun 14, 2021
* Remove rpc.jsonrpc.method, clarify rpc.method instead.

* Add PR#.

* Clarify client side code.namespace/function.

* Use "ref" instead of "constraint: any_of".

This should be changed back once
open-telemetry/build-tools#33
is resolved & the updated build tools available.

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
jsuereth pushed a commit to jsuereth/otel-semconv-test that referenced this issue Apr 19, 2023
* Remove rpc.jsonrpc.method, clarify rpc.method instead.

* Add PR#.

* Clarify client side code.namespace/function.

* Use "ref" instead of "constraint: any_of".

This should be changed back once
open-telemetry/build-tools#33
is resolved & the updated build tools available.

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
jsuereth pushed a commit to open-telemetry/semantic-conventions that referenced this issue May 11, 2023
* Remove rpc.jsonrpc.method, clarify rpc.method instead.

* Add PR#.

* Clarify client side code.namespace/function.

* Use "ref" instead of "constraint: any_of".

This should be changed back once
open-telemetry/build-tools#33
is resolved & the updated build tools available.

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
@lmolkova
Copy link
Contributor

lmolkova commented Mar 12, 2024

Related: #293

@lmolkova
Copy link
Contributor

Closing this since we no longer support constraints - 310

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working semconv/md Related specifically to the markdown output of the semantic convention generator semconv Related to the semantic convention generator.
Projects
None yet
Development

No branches or pull requests

3 participants