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

Referenced attributes are partially generated in markdown #136

Closed
lmolkova opened this issue Feb 20, 2023 · 0 comments · Fixed by #204
Closed

Referenced attributes are partially generated in markdown #136

lmolkova opened this issue Feb 20, 2023 · 0 comments · Fixed by #204
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

@lmolkova
Copy link
Contributor

lmolkova commented Feb 20, 2023

Note with possible attribute values (and allowing custom values) is not populated when an attribute is referenced.

E.g. I have

- id: messaging.destination
  prefix: messaging.destination
  brief: 'Semantic convention for attributes that describe messaging destination on broker'
  attributes:
    - id: kind
      type:
        allow_custom_values: true
        members:
          - id: queue
            value: "queue"
            brief: "A message sent to a queue"
          - id: topic
            value: "topic"
            brief: "A message sent to a topic"

If I generate md from it using <!-- semconv messaging.destination-->, I'd see an attribute in the table and a note describing possible values:

| `messaging.destination.kind` | string | The kind of message destination | `queue` | Recommended |
`messaging.destination.kind` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

| Value  | Description |
|---|---|
| `queue` | A message sent to a queue |
| `topic` | A message sent to a topic |

Then if I reference this attribute

- id: messaging.producer
  prefix: messaging
  type: span
  extends: messaging
  span_kind: producer
  brief: 'Semantic convention for producers of messages sent to a messaging systems.'
  attributes:
    - ref: messaging.destination.kind
      requirement_level:
        conditionally_required: If the message destination is either a `queue` or a `topic`.

If I generate md from it using <!-- semconv messaging.producer-->, I'd expect a similar note to be populated, but it's not (see

open-telemetry/opentelemetry-specification#3214)

@Oberon00 Oberon00 added bug Something isn't working semconv Related to the semantic convention generator. semconv/md Related specifically to the markdown output of the semantic convention generator labels Feb 21, 2023
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

Successfully merging a pull request may close this issue.

2 participants