open-telemetry/opentelemetry-ruby

Add Semantic Conventions for Logs Signal

kaylareopelle opened this issue · 4 comments

Update the existing semantic_conventions gem to incorporate the required logs signal constants.

Spec: https://opentelemetry.io/docs/specs/otel/logs/semantic_conventions/

It looks like the opentelemetry-semantic_conventions gem release versions and the specification versions match.

Ruby's latest release uses version 1.10.0. The opentelemetry version is 1.21.0.

The opentelemetry/semantic-conventions repo is the new home for semantic conventions. Version 1.21.0 is the first in this space. Versions 11 - 20 could be updated using the existing rake generate task. After that, we'll need to make some small tweaks to use the new repo.

Some questions for an approver/maintainer:

  • Why hasn't the gem been updated along with new semantic convention releases?
  • Is the current process to release gems with version numbers that match the semantic conventions version?
  • What needs to be considered when releasing a new version of the semantic conventions gem?

This isn't a blocker right now, but I'd like to discuss it further and create a path to get Ruby on version 1.21.0 so that I can use those constants to implement logs.

cc @open-telemetry/ruby-approvers @opentelemetry/ruby-maintainers

WIP branch: kaylareopelle/add-logs-to-semantic-conventions

These questions were discussed during the OTel Ruby SIG today. Full meeting notes here.

For now, Logs will use constants assigned to frozen string literals to represent the values within the Logs portion of Semantic Conventions. The values will point to the most recent version of Semantic Conventions at the time of writing and will include a code comment with a link to the semantic convention version/location with the string reference.

The frozen string literals will be added as the implementation needs them, so this issue is no longer needed.