Skip to content

Conversation

@kaylareopelle
Copy link
Contributor

@kaylareopelle kaylareopelle commented Oct 30, 2025

Semantic conventions update for version 1.37.0

Also includes an adjustment to the attributes jinja template to account for multi-line comments in response to open-telemetry/semantic-conventions#3019


Outdated

This was pretty smooth overall. The only problem was with the Gen AI examples. They needed to be manually commented out. After the opening [ the rest of the example wasn't commented out. This problem also exists in the latest release, 1.38.0.

It might be related to a fix in the actual semconv repo. Things look pretty good from the weaver perspective to me, but maybe you have an idea, @robbkidd?

Where the sample values are in the weaver template:

# @example Sample Values
{%- if attribute.examples is sequence %}
{%- for example in attribute.examples %}
# {{ example }}
{%- endfor %}
{%- else %}
# {{ attribute.examples }}
{%- endif %}

@kaylareopelle
Copy link
Contributor Author

Opened an issue for the weaver problem: open-telemetry/semantic-conventions#3019

Also, update the jinja template for attributes to handle multi-
line code comments.
# client.example.com
# 10.1.2.80
# /tmp/my.sock
# # client.example.com
Copy link
Contributor

Choose a reason for hiding this comment

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

where are these extra octothorps # coming from? The jinja template?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, I'm not sure. I can take a look next week.

{%- if attribute.examples is sequence %}
{%- for example in attribute.examples %}
# {{ example }}
# {{ example | comment }}
Copy link
Contributor

@arielvalentin arielvalentin Nov 5, 2025

Choose a reason for hiding this comment

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

Is that because the example or comment may already have an octothorp in it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was directed to use this for multi line strings.

However, looking at the comment, I may have got something wrong:

open-telemetry/semantic-conventions#3019 (comment)

Perhaps just using the filter without the prefixed # would solve the issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(assuming the "that" you're referring to is the addition of "| comment" )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@arielvalentin - Your hypothesis is right, there's already a # in the example/comment.

This might've been related to a weaver version change. By including the # where we had it in earlier versions, we were able to get some extra indentation before the examples. I can't figure out how to do that now, so the documentation will look like:

      # @example Sample Values
      # CERN-LineMode/2.15 libwww/2.17b3
      # Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1
      # YourApp/1.0.0 grpc-java-okhttp/1.27.2

I can also add a colon to the end of the Sample Values, if we think that'll make things look better.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 6, 2025

👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this pull request will be closed eventually by the stale bot

@github-actions github-actions bot added the stale label Dec 6, 2025
@github-actions github-actions bot removed the stale label Dec 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants