opentelemetry-semantic_conventions 1.11.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d30ebf58d49525e0f640f6b2f8e0057053e1a142048fa05d0fd9414cc58b3a9
-  data.tar.gz: 146946fe715d0407cea0dd15532b6b14d9cec574efd24831193533b0edb3b0f2
+  metadata.gz: ae5e00b9714aa7b343b498aa617582048e0713aa12ed975d0c4ef9350ce8532e
+  data.tar.gz: 5e8c4e48bda8d05d69652457fd07d11497d154acb603dbb876aa16b697108d7d
 SHA512:
-  metadata.gz: ab0cc6b66600a01aaa5dc41a4da31066de81b21f53ea08f0b82839782a0d5706c59bfae78358adf5c81796d0296e5132de3c4e51ceff1a08b0faafc5d7957057
-  data.tar.gz: fa5bfe203028ea163a0684fac641772e57d43072bbfad15c117f0fad6570f5aa9a8e17026d378f5504228ec8fb296271394ac145a9665290ff7d47a9f4b4cbfd
+  metadata.gz: cf7612172fe08e1fc05445a50d3abb8e3911946a2b1fc97098c787baa9b7e3e16bf08b5239d392c2eec45fc6af12931a590a5d4e98ba609d42fcfa050002855f
+  data.tar.gz: d399cbaaf4cad564fe862bc7e2fce0cf6dbfd9be628c4175b6e1cd336a4164b6a9ab08f164746975d411f762198c777a6e8162ff61361079ff6985a9423252d6

data/.yardopts

@@ -1,9 +1,9 @@
 --no-private
 --title=OpenTelemetry Semantic Conventions
 --markup=markdown
+--markup-provider=kramdown
 --main=README.md
-./lib/opentelemetry/semantic_conventions/**/*.rb
-./lib/opentelemetry/semantic_conventions.rb
+./lib/opentelemetry/**/*.rb
 -
 README.md
 CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-semantic_conventions
 
+### v1.37.0 / 2026-04-07
+
+* ADDED: Bump semantic conventions to version 1.37.0 (#1952)
+* ADDED: Min Ruby Version 3.3 (#2070)
+* FIXED: Correct & simplify codegen templates (#2059)
+* FIXED: Tweak weaver generation to include new line (#2071)
+
+### v1.36.0 / 2025-09-16
+
+* ADDED: Update to v1.36 in a non-breaking way
+
 ### v1.11.0 / 2025-02-25
 
 - ADDED: Support 3.1 Min Version

data/README.md

@@ -1,16 +1,25 @@
-# Opentelemetry::SemanticConventions
+# OpenTelemetry::SemanticConventions
 
-The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry [Semantic Conventions][semantic-conventions].
+The `opentelemetry-semantic_conventions` gem provides auto-generated constants
+that represent the OpenTelemetry [Semantic Conventions][semantic-conventions].
 
 ## What is OpenTelemetry?
 
-OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+OpenTelemetry is an open source observability framework, providing a
+general-purpose API, SDK, and related tools required for the instrumentation of
+cloud-native software, frameworks, and libraries.
 
-OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
+OpenTelemetry provides a single set of APIs, libraries, agents, and collector
+services to capture distributed traces and metrics from your application. You
+can analyze them using Prometheus, Jaeger, and other observability tools.
 
 ## How does this gem fit in?
 
-The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry Semantic Conventions. They may be referenced in instrumentation or end-user code in place of hard-coding the names of the conventions. Because they are generated from the YAML models in the specification, they are kept up-to-date for you.
+The `opentelemetry-semantic_conventions` gem provides auto-generated constants
+that represent the OpenTelemetry Semantic Conventions. They may be referenced
+in instrumentation or end-user code in place of hard-coding the names of the
+conventions. Because they are generated from the YAML models in the
+specification, they are kept up-to-date for you.
 
 ## How do I get started?
 
@@ -20,29 +29,85 @@ Install the gem using:
 gem install opentelemetry-semantic_conventions
 ```
 
-Or, if you use Bundler, include `opentelemetry-semantic_conventions` in your `Gemfile`.
+Or, if you use Bundler, include `opentelemetry-semantic_conventions` in your
+`Gemfile`.
 
+## How do I use the gem?
+
+The gem's versions match the corresponding
+[OpenTelemetry Semantic Convention versions][semconv].
+
+In version 1.36.0, we established a new pattern for naming the constants:
+* `OpenTelemetry::SemConv::Incubating::#{CATEGORY_NAME}` is the prefix for
+experimental, development, or deprecated constants
+* `OpenTelemetry::SemConv::#{CATEGORY_NAME}` is the prefix for stable constants
+
+Incubating constants will never be removed. If an incubating constant becomes
+stable, it will be copied into the stable namespace and the value will be
+available from two constants. The new constant's name will be the same, except
+the `Incubating` namespace will be removed.
+
+Prior to 1.36.0 (last version 1.11.0), constants follow a different naming
+pattern: `OpenTelemetry::SemanticConventions::#{CATEGORY_NAME}`
+
+These constants will be preserved to avoid breaking changes for users who rely
+on the old constants. These constants do not differentiate between stable and
+unstable constants. New constants will not be added to this namespace.
+
+We recommend you require only the files that contain the constants you are going
+to use. For example, if you were creating instrumentation for an HTTP Client
+that emits only stable conventions, you would likely require:
+
+```rb
+require 'opentelemetry/semconv/http'
+```
+
+If you want to require all of the 1.11.0 constants, you can use:
 ```rb
 require 'opentelemetry/semantic_conventions'
 
 # Use the constants however you feel necessary, eg:
 
-puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::CODE_LINENO}"
+puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::DB_USER}"
 ```
 
+The constant names can be very long. You can consider aliasing the long bit in
+another constant to save your fingertips some trouble.
+
+```rb
+SEMCONV_HTTP_INC = OpenTelemetry::SemConv::Incubating::HTTP
+
+SEMCONV_HTTP_INC::HTTP_REQUEST_METHOD # which would return 'http.request.method'
+```
+
+## What's up with the gem's versions?
+
+This gem doesn't follow semantic versioning. Instead, the version matches the
+upstream [OpenTelemetry Semantic Conventions version][semconv].
+
 ## How do I rebuild the conventions?
 
-Bump the version number in the Rakefile, and then run `rake generate`.
+To build the library against a new version of the semantic conventions, update SPEC_VERSION in the Rakefile, and then run `rake generate`.
+
+Do not update the library's VERSION in version.rb.
+That will be handled by the automation for releasing the gem.
 
 ## How can I get involved?
 
-The `opentelemetry-semantic_conventions` gem source is on github, along with related gems.
+The `opentelemetry-semantic_conventions` gem source is on GitHub, along with
+related gems.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special
+interest group (SIG). You can get involved by joining us in
+[GitHub Discussions][discussions-url] or attending our weekly meeting. See the
+meeting calendar for dates and times. For more information on this and other
+language SIGs, see the OpenTelemetry community page.
 
 ## License
 
-The `opentelemetry-semantic_conventions` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
+The `opentelemetry-semantic_conventions` gem is distributed under the Apache 2.0
+license. See LICENSE for more information.
 
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
-[semantic-conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.20.0/semantic_conventions
+[semantic-conventions]: https://github.com/open-telemetry/semantic-conventions
+[semconv]: https://opentelemetry.io/docs/specs/semconv/