feat: Bump semantic conventions to version 1.37.0 by kaylareopelle · Pull Request #1952 · open-telemetry/opentelemetry-ruby

kaylareopelle · 2025-10-30T23:56:16Z

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:

opentelemetry-ruby/semantic_conventions/templates/registry/ruby/attributes.j2

Lines 44 to 51 in 1f4f85e

# @example Sample Values

{%- if attribute.examples is sequence %}

{%- for example in attribute.examples %}

# {{ example }}

{%- endfor %}

{%- else %}

# {{ attribute.examples }}

{%- endif %}

kaylareopelle · 2025-10-31T00:12:16Z

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.

error on CI "missing panolint", which is not one of our dependencies

arielvalentin · 2025-11-05T16:02:16Z

-        #   client.example.com
-        #   10.1.2.80
-        #   /tmp/my.sock
+        #   # client.example.com


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

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

I received a notification that you commented on this but for some reason I do not see it in the UI now.

Did you mention something about a weaver change that added the extra octothorpe?

@arielvalentin -- strange! This is the comment I submitted before.

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

arielvalentin · 2025-11-05T16:02:52Z

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


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

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.

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

@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 · 2025-12-06T02:08:59Z

👋 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 · 2026-01-12T02:14:40Z

👋 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

arielvalentin · 2026-01-13T15:23:09Z

-        #   client.example.com
-        #   10.1.2.80
-        #   /tmp/my.sock
+        #   # client.example.com


I received a notification that you commented on this but for some reason I do not see it in the UI now.

Did you mention something about a weaver change that added the extra octothorpe?

github-actions · 2026-03-03T02:16:19Z

👋 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

dmathieu · 2026-03-03T08:46:06Z

Note that the latest semantic conventions are 1.40.

This removes some of the indentation we had in favor of avoiding duplicate # signs

robbkidd · 2026-03-16T21:04:44Z

-      #   # unhandled
-      #
+      # handled
+      # unhandled


I'm sorry I was unavailable the past couple weeks to maybe have caught this earlier.

😬 These indents were part of the Yard markup for getting these values to appear under the @example Sample Values section in the rendered docs.

Before, with inner indent) After, without inner indent

If showing sample values as Yard @example has gotten too wonky in the weaver templating, we/I can update the template to do something more straightforward.

robbkidd · 2026-03-16T21:29:43Z

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


I think I see another fix option: don't pipe the example sample value through the templating comment macro (which prepends an octothorp):

Suggested change

{{ example | comment }}

# {{ example }}

Nope! It's more complicated than that. My current suggestion is for us to remove including examples. The shapes they come in are too varied.

kaylareopelle requested review from ahayworth, arielvalentin, dazuma, ericmustin, fbogsany, mwear, plantfansam, robbkidd and robertlaurin as code owners October 30, 2025 23:56

feat: Bump semantic conventions to version 1.37.0

d69cb7a

Also, update the jinja template for attributes to handle multi- line code comments.

kaylareopelle force-pushed the semconv-1-37-0 branch from 1cf3e76 to d69cb7a Compare October 31, 2025 20:04

kaylareopelle and others added 3 commits October 31, 2025 13:10

chore: attempt rubocop fix

5b42548

error on CI "missing panolint", which is not one of our dependencies

Merge branch 'main' into semconv-1-37-0

c2efab9

Merge branch 'main' into semconv-1-37-0

a2e60a6

arielvalentin reviewed Nov 5, 2025

View reviewed changes

github-actions Bot added the stale label Dec 6, 2025

github-actions Bot removed the stale label Dec 13, 2025

github-actions Bot added the stale label Jan 12, 2026

kaylareopelle removed the stale label Jan 13, 2026

kaylareopelle requested a review from arielvalentin January 13, 2026 15:13

arielvalentin reviewed Jan 13, 2026

View reviewed changes

arielvalentin approved these changes Jan 31, 2026

View reviewed changes

github-actions Bot added the stale label Mar 3, 2026

Merge branch 'main' into semconv-1-37-0

aa98be9

kaylareopelle added 2 commits March 3, 2026 05:59

Update for octothorpe dupes

213f93d

This removes some of the indentation we had in favor of avoiding duplicate # signs

Spelling

ec79585

github-actions Bot removed the stale label Mar 4, 2026

kaylareopelle merged commit 0cea56c into open-telemetry:main Mar 11, 2026
63 checks passed

robbkidd reviewed Mar 16, 2026

View reviewed changes

otelbot-ruby Bot mentioned this pull request Mar 24, 2026

release: Release 2 items #2065

Closed

otelbot-ruby Bot mentioned this pull request Apr 7, 2026

release: Release 17 items #2078

Merged

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

Conversation

kaylareopelle commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Outdated

Uh oh!

kaylareopelle commented Oct 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arielvalentin Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Dec 6, 2025

Uh oh!

github-actions Bot commented Jan 12, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Mar 3, 2026

Uh oh!

dmathieu commented Mar 3, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaylareopelle commented Oct 30, 2025 •

edited

Loading

arielvalentin Nov 5, 2025 •

edited

Loading