opentelemetry-semantic_conventions 1.36.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b1d56cd309c3dbd3418c4999d97dcfc7807aa56da86f17e99407b280fb8ad7b
-  data.tar.gz: e58c43ddccb57d4c2fa9e2717fdf26a379cd24be1fa829eb9bb5aa546dc27663
+  metadata.gz: ae5e00b9714aa7b343b498aa617582048e0713aa12ed975d0c4ef9350ce8532e
+  data.tar.gz: 5e8c4e48bda8d05d69652457fd07d11497d154acb603dbb876aa16b697108d7d
 SHA512:
-  metadata.gz: 13b293e3a8dd9676d7b4dd6a4578bf8fc1ecbbc3df8450dde6084301ee198db93b930f14670d45525ab2955ab30a56d9a63fc3a5476666a0c484229931492370
-  data.tar.gz: 8a71e44ef0d3157c5b29b4d84352b29acb4e0f8660ba80e82d459ea422fc6866722c9dc19ceea6f05297d114fa6ae6ba3518fca81013a53591787ae8c613b213
+  metadata.gz: cf7612172fe08e1fc05445a50d3abb8e3911946a2b1fc97098c787baa9b7e3e16bf08b5239d392c2eec45fc6af12931a590a5d4e98ba609d42fcfa050002855f
+  data.tar.gz: d399cbaaf4cad564fe862bc7e2fce0cf6dbfd9be628c4175b6e1cd336a4164b6a9ab08f164746975d411f762198c777a6e8162ff61361079ff6985a9423252d6

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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

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/

data/lib/opentelemetry/semantic_conventions/resource.rb

@@ -548,7 +548,6 @@ module OpenTelemetry
       # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated.
       #   See {OpenTelemetry::SemConv::Incubating::WEBENGINE::WEBENGINE_DESCRIPTION} for its replacement.
       WEBENGINE_DESCRIPTION = 'webengine.description'
-
     end
   end
 end

data/lib/opentelemetry/semantic_conventions/trace.rb

@@ -908,7 +908,6 @@ module OpenTelemetry
       # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated.
       #   See {OpenTelemetry::SemConv::Incubating::MESSAGE::MESSAGE_UNCOMPRESSED_SIZE} for its replacement.
       MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size'
-
     end
   end
 end

data/lib/opentelemetry/semantic_conventions/version.rb

@@ -6,6 +6,9 @@
 
 module OpenTelemetry
   module SemanticConventions
-    VERSION = '1.36.0'
+    # Version of the OpenTelemetry Semantic Conventions from which this library was generated.
+    SPEC_VERSION = '1.37.0'
+    # Release version of this gem. May not match SPEC_VERSION until gem is released after a spec update.
+    VERSION = '1.37.0'
   end
 end

data/lib/opentelemetry/semconv/aspnetcore/attributes.rb

@@ -22,76 +22,48 @@ module OpenTelemetry
   module SemConv
     module ASPNETCORE
       # @!group Attribute Names
-    
-      # ASP.NET Core exception middleware handling result
+
+      # ASP.NET Core exception middleware handling result.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   handled
-      #   unhandled
-      #
       ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result'
-  
+
       # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   Contoso.MyHandler
-      #
       ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type'
-  
+
       # Rate limiting policy name.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   fixed
-      #   sliding
-      #   token
-      #
       ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy'
-  
+
       # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   acquired
-      #   request_canceled
-      #
       ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result'
-  
+
       # Flag indicating if request was handled by the application pipeline.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   true
-      #
       ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled'
-  
+
       # A value that indicates whether the matched route is a fallback route.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   true
-      #
       ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback'
-  
+
       # Match result - success or failure
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   success
-      #   failure
-      #
       ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status'
-  
+
+      # A value that indicates whether the user is authenticated.
+      #
+      # @note Stability Level: stable
+      ASPNETCORE_USER_IS_AUTHENTICATED = 'aspnetcore.user.is_authenticated'
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/aspnetcore/metrics.rb

@@ -22,42 +22,42 @@ module OpenTelemetry
   module SemConv
     module ASPNETCORE
       # @!group Metrics Names
-    
+
       # Number of exceptions caught by exception handling middleware.
       #
       # Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions'
-  
+
       # Number of requests that are currently active on the server that hold a rate limiting lease.
       #
       # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases'
-  
+
       # Number of requests that are currently queued, waiting to acquire a rate limiting lease.
       #
       # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests'
-  
+
       # The time the request spent in a queue waiting to acquire a rate limiting lease.
       #
       # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue'
-  
+
       # The duration of rate limiting lease held by requests on the server.
       #
       # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration'
-  
+
       # Number of requests that tried to acquire a rate limiting lease.
       #
       # Requests could be:
@@ -69,15 +69,15 @@ module OpenTelemetry
       #
       # @note Stability Level: stable
       ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests'
-  
+
       # Number of requests that were attempted to be matched to an endpoint.
       #
       # Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0
       #
       # @note Stability Level: stable
       ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts'
-  
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/client/attributes.rb

@@ -22,32 +22,22 @@ module OpenTelemetry
   module SemConv
     module CLIENT
       # @!group Attribute Names
-    
+
       # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
       #
       # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries,  for example proxies, if it's available.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   client.example.com
-      #   10.1.2.80
-      #   /tmp/my.sock
-      #
       CLIENT_ADDRESS = 'client.address'
-  
+
       # Client port number.
       #
       # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries,  for example proxies, if it's available.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   65123
-      #
       CLIENT_PORT = 'client.port'
-  
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/code/attributes.rb

@@ -22,25 +22,17 @@ module OpenTelemetry
   module SemConv
     module CODE
       # @!group Attribute Names
-    
+
       # The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   16
-      #
       CODE_COLUMN_NUMBER = 'code.column.number'
-  
+
       # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   /usr/local/MyApplication/content_root/app/index.php
-      #
       CODE_FILE_PATH = 'code.file.path'
-  
+
       # The method or function fully-qualified name without arguments. The value should fit the natural representation of the language runtime, which is also likely the same used within `code.stacktrace` attribute value. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
       #
       # Values and format depends on each language runtime, thus it is impossible to provide an exhaustive list of examples.
@@ -60,33 +52,19 @@ module OpenTelemetry
       # - C function: `fopen`
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   com.example.MyHttpService.serveRequest
-      #   GuzzleHttp\Client::transfer
-      #   fopen
-      #
       CODE_FUNCTION_NAME = 'code.function.name'
-  
+
       # The line number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   42
-      #
       CODE_LINE_NUMBER = 'code.line.number'
-  
+
       # A stacktrace as a string in the natural representation for the language runtime. The representation is identical to [`exception.stacktrace`](/docs/exceptions/exceptions-spans.md#stacktrace-representation). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data integrity.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)
-
       CODE_STACKTRACE = 'code.stacktrace'
-  
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/db/attributes.rb

@@ -22,7 +22,7 @@ module OpenTelemetry
   module SemConv
     module DB
       # @!group Attribute Names
-    
+
       # The name of a collection (table, container) within the database.
       #
       # It is RECOMMENDED to capture the value as provided by the application
@@ -36,13 +36,8 @@ module OpenTelemetry
       # collection name then that collection name SHOULD be used.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   public.users
-      #   customers
-      #
       DB_COLLECTION_NAME = 'db.collection.name'
-  
+
       # The name of the database, fully qualified within the server address and port.
       #
       # If a database system has multiple namespace components, they SHOULD be concatenated from the most general to the most specific namespace component, using `|` as a separator between the components. Any missing components (and their associated separators) SHOULD be omitted.
@@ -50,26 +45,15 @@ module OpenTelemetry
       # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   customers
-      #   test.users
-      #
       DB_NAMESPACE = 'db.namespace'
-  
+
       # The number of queries included in a batch operation.
       #
       # Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   2
-      #   3
-      #   4
-      #
       DB_OPERATION_BATCH_SIZE = 'db.operation.batch.size'
-  
+
       # The name of the operation or command being executed.
       #
       # It is RECOMMENDED to capture the value as provided by the application
@@ -88,14 +72,8 @@ module OpenTelemetry
       # system specific term if more applicable.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   findAndModify
-      #   HMSET
-      #   SELECT
-      #
       DB_OPERATION_NAME = 'db.operation.name'
-  
+
       # Low cardinality summary of a database query.
       #
       # The query summary describes a class of database queries and is useful
@@ -109,14 +87,8 @@ module OpenTelemetry
       # section.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   SELECT wuser_table
-      #   INSERT shipping_details SELECT orders
-      #   get user by id
-      #
       DB_QUERY_SUMMARY = 'db.query.summary'
-  
+
       # The database query being executed.
       #
       # For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
@@ -124,28 +96,16 @@ module OpenTelemetry
       # Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   SELECT * FROM wuser_table where username = ?
-      #   SET mykey ?
-      #
       DB_QUERY_TEXT = 'db.query.text'
-  
+
       # Database response status code.
       #
       # The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
       # Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   102
-      #   ORA-17002
-      #   08P01
-      #   404
-      #
       DB_RESPONSE_STATUS_CODE = 'db.response.status_code'
-  
+
       # The name of a stored procedure within the database.
       #
       # It is RECOMMENDED to capture the value as provided by the application
@@ -155,20 +115,16 @@ module OpenTelemetry
       # stored procedure name then that stored procedure name SHOULD be used.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   GetCustomer
-      #
       DB_STORED_PROCEDURE_NAME = 'db.stored_procedure.name'
-  
+
       # The database management system (DBMS) product as identified by the client instrumentation.
       #
       # The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system.name` is set to `postgresql` based on the instrumentation's best knowledge.
       #
       # @note Stability Level: stable
       DB_SYSTEM_NAME = 'db.system.name'
-  
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/db/metrics.rb

@@ -22,15 +22,15 @@ module OpenTelemetry
   module SemConv
     module DB
       # @!group Metrics Names
-    
+
       # Duration of database client operations.
       #
       # Batch operations SHOULD be recorded as a single operation.
       #
       # @note Stability Level: stable
       DB_CLIENT_OPERATION_DURATION = 'db.client.operation.duration'
-  
+
       # @!endgroup
     end
   end
-end
+end

data/lib/opentelemetry/semconv/dotnet/attributes.rb

@@ -22,19 +22,13 @@ module OpenTelemetry
   module SemConv
     module DOTNET
       # @!group Attribute Names
-    
+
       # Name of the garbage collector managed heap generation.
       #
       # @note Stability Level: stable
-      #
-      # @example Sample Values
-      #   gen0
-      #   gen1
-      #   gen2
-      #
       DOTNET_GC_HEAP_GENERATION = 'dotnet.gc.heap.generation'
-  
+
       # @!endgroup
     end
   end
-end
+end