From d69cb7a5ad78cc033a122d1e31e9b30d0c906d5a Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Thu, 30 Oct 2025 16:50:41 -0700 Subject: [PATCH 1/2] feat: Bump semantic conventions to version 1.37.0 Also, update the jinja template for attributes to handle multi- line code comments. --- semantic_conventions/.rubocop.yml | 2 + semantic_conventions/Rakefile | 2 +- .../semantic_conventions/version.rb | 2 +- .../semconv/aspnetcore/attributes.rb | 35 ++- .../semconv/client/attributes.rb | 8 +- .../opentelemetry/semconv/code/attributes.rb | 6 +- .../opentelemetry/semconv/db/attributes.rb | 40 +-- .../semconv/dotnet/attributes.rb | 6 +- .../opentelemetry/semconv/error/attributes.rb | 8 +- .../semconv/exception/attributes.rb | 8 +- .../opentelemetry/semconv/http/attributes.rb | 30 +- .../semconv/incubating/android/attributes.rb | 12 +- .../semconv/incubating/app/attributes.rb | 67 ++++- .../semconv/incubating/artifact/attributes.rb | 32 +- .../incubating/aspnetcore/attributes.rb | 182 +++++++++++- .../semconv/incubating/aspnetcore/metrics.rb | 154 ++++++++++ .../semconv/incubating/aws/attributes.rb | 124 ++++---- .../semconv/incubating/az/attributes.rb | 8 +- .../semconv/incubating/azure/attributes.rb | 35 +-- .../semconv/incubating/azure/metrics.rb | 4 +- .../semconv/incubating/browser/attributes.rb | 19 +- .../incubating/cassandra/attributes.rb | 6 +- .../semconv/incubating/cicd/attributes.rb | 84 +++--- .../semconv/incubating/client/attributes.rb | 8 +- .../semconv/incubating/cloud/attributes.rb | 16 +- .../incubating/cloudevents/attributes.rb | 14 +- .../incubating/cloudfoundry/attributes.rb | 24 +- .../semconv/incubating/code/attributes.rb | 6 +- .../incubating/container/attributes.rb | 73 +++-- .../semconv/incubating/container/metrics.rb | 38 ++- .../semconv/incubating/cpu/attributes.rb | 6 +- .../semconv/incubating/cpython/attributes.rb | 6 +- .../semconv/incubating/db/attributes.rb | 130 +++++---- .../semconv/incubating/db/metrics.rb | 18 +- .../incubating/deployment/attributes.rb | 16 +- .../incubating/destination/attributes.rb | 10 +- .../semconv/incubating/device/attributes.rb | 18 +- .../semconv/incubating/disk/attributes.rb | 2 +- .../semconv/incubating/dns/attributes.rb | 8 +- .../semconv/incubating/dotnet/attributes.rb | 6 +- .../incubating/elasticsearch/attributes.rb | 2 +- .../semconv/incubating/enduser/attributes.rb | 6 +- .../semconv/incubating/error/attributes.rb | 12 +- .../semconv/incubating/event/attributes.rb | 4 +- .../incubating/exception/attributes.rb | 8 +- .../semconv/incubating/faas/attributes.rb | 18 +- .../semconv/incubating/faas/metrics.rb | 18 +- .../incubating/feature_flag/attributes.rb | 52 ++-- .../semconv/incubating/file/attributes.rb | 42 +-- .../semconv/incubating/gcp/attributes.rb | 36 +-- .../semconv/incubating/gen_ai/attributes.rb | 274 ++++++++++++++---- .../semconv/incubating/gen_ai/metrics.rb | 10 +- .../semconv/incubating/geo/attributes.rb | 14 +- .../semconv/incubating/go/attributes.rb | 4 +- .../semconv/incubating/graphql/attributes.rb | 6 +- .../semconv/incubating/heroku/attributes.rb | 6 +- .../semconv/incubating/host/attributes.rb | 40 +-- .../semconv/incubating/http/attributes.rb | 56 ++-- .../semconv/incubating/hw/attributes.rb | 207 ++++++++++++- .../semconv/incubating/hw/metrics.rb | 186 +++++++++++- .../semconv/incubating/ios/attributes.rb | 4 +- .../semconv/incubating/jvm/attributes.rb | 30 +- .../semconv/incubating/k8s/attributes.rb | 164 +++++------ .../semconv/incubating/k8s/metrics.rb | 232 +++++++++++---- .../semconv/incubating/linux/attributes.rb | 4 +- .../semconv/incubating/log/attributes.rb | 14 +- .../incubating/mainframe/attributes.rb | 2 +- .../incubating/messaging/attributes.rb | 42 +-- .../semconv/incubating/net/attributes.rb | 24 +- .../semconv/incubating/network/attributes.rb | 38 +-- .../semconv/incubating/oci/attributes.rb | 2 +- .../semconv/incubating/openai.rb | 21 ++ .../semconv/incubating/openai/attributes.rb | 60 ++++ .../semconv/incubating/os/attributes.rb | 20 +- .../semconv/incubating/otel/attributes.rb | 27 +- .../semconv/incubating/otel/metrics.rb | 30 +- .../semconv/incubating/other/attributes.rb | 2 +- .../semconv/incubating/pool/attributes.rb | 2 +- .../semconv/incubating/process/attributes.rb | 70 ++--- .../semconv/incubating/profile/attributes.rb | 2 +- .../semconv/incubating/rpc/attributes.rb | 28 +- .../incubating/security_rule/attributes.rb | 18 +- .../semconv/incubating/server/attributes.rb | 12 +- .../semconv/incubating/service/attributes.rb | 10 +- .../semconv/incubating/signalr/attributes.rb | 8 +- .../semconv/incubating/source/attributes.rb | 10 +- .../semconv/incubating/system/attributes.rb | 32 +- .../semconv/incubating/system/metrics.rb | 83 +++--- .../incubating/telemetry/attributes.rb | 8 +- .../semconv/incubating/test/attributes.rb | 24 +- .../semconv/incubating/tls/attributes.rb | 66 ++--- .../semconv/incubating/url/attributes.rb | 52 ++-- .../semconv/incubating/user/attributes.rb | 14 +- .../incubating/user_agent/attributes.rb | 24 +- .../semconv/incubating/vcs/attributes.rb | 104 +++---- .../semconv/incubating/vcs/metrics.rb | 8 +- .../incubating/webengine/attributes.rb | 6 +- .../semconv/incubating/zos/attributes.rb | 4 +- .../opentelemetry/semconv/jvm/attributes.rb | 22 +- .../semconv/network/attributes.rb | 30 +- .../opentelemetry/semconv/otel/attributes.rb | 6 +- .../semconv/server/attributes.rb | 12 +- .../semconv/service/attributes.rb | 6 +- .../semconv/signalr/attributes.rb | 8 +- .../semconv/telemetry/attributes.rb | 4 +- .../opentelemetry/semconv/url/attributes.rb | 16 +- .../semconv/user_agent/attributes.rb | 6 +- .../templates/registry/ruby/attributes.j2 | 2 +- 108 files changed, 2438 insertions(+), 1249 deletions(-) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/openai.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/openai/attributes.rb diff --git a/semantic_conventions/.rubocop.yml b/semantic_conventions/.rubocop.yml index 89c24f4c8a..7489c561a4 100644 --- a/semantic_conventions/.rubocop.yml +++ b/semantic_conventions/.rubocop.yml @@ -2,6 +2,8 @@ inherit_from: ../contrib/rubocop.yml AllCops: NewCops: enable + Exclude: + - 'tmp/semconvrepo/**/*' Bundler/OrderedGems: Exclude: diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index 7a1d178b5a..a1ac94b666 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -50,7 +50,7 @@ task default: default_tasks desc 'update semantic conventions' task generate: %i[update_gem_version generate_semconv generate_require_rollups rubocop_autocorrect] -SPEC_VERSION = '1.36.0' +SPEC_VERSION = '1.37.0' OTEL_WEAVER_VERSION = 'v0.17.1' semconv_source_dir = Pathname.new('./tmp/semconvrepo') semconv_output_dir = Pathname.new('./lib/opentelemetry/semconv') diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb index 9e1db583fa..405b1f806b 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb @@ -6,6 +6,6 @@ module OpenTelemetry module SemanticConventions - VERSION = '1.36.0' + VERSION = '1.37.0' end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb index 2654280e0a..1415b54451 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb @@ -23,13 +23,13 @@ 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 + # # handled + # # unhandled # ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' @@ -38,7 +38,7 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # Contoso.MyHandler + # # Contoso.MyHandler # ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' @@ -47,9 +47,9 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # fixed - # sliding - # token + # # fixed + # # sliding + # # token # ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' @@ -58,8 +58,8 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # acquired - # request_canceled + # # acquired + # # request_canceled # ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' @@ -68,7 +68,7 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # true + # # true # ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' @@ -77,7 +77,7 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # true + # # true # ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' @@ -86,11 +86,20 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # success - # failure + # # success + # # failure # ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' + # A value that indicates whether the user is authenticated. + # + # @note Stability Level: stable + # + # @example Sample Values + # # true + # + ASPNETCORE_USER_IS_AUTHENTICATED = 'aspnetcore.user.is_authenticated' + # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb index fa9573b067..29ec27fc39 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb @@ -30,9 +30,9 @@ module CLIENT # @note Stability Level: stable # # @example Sample Values - # client.example.com - # 10.1.2.80 - # /tmp/my.sock + # # client.example.com + # # 10.1.2.80 + # # /tmp/my.sock # CLIENT_ADDRESS = 'client.address' @@ -43,7 +43,7 @@ module CLIENT # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # CLIENT_PORT = 'client.port' diff --git a/semantic_conventions/lib/opentelemetry/semconv/code/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/code/attributes.rb index 4d016c7d1b..d3ec56edff 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/code/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/code/attributes.rb @@ -62,9 +62,9 @@ module CODE # @note Stability Level: stable # # @example Sample Values - # com.example.MyHttpService.serveRequest - # GuzzleHttp\Client::transfer - # fopen + # # com.example.MyHttpService.serveRequest + # # GuzzleHttp\Client::transfer + # # fopen # CODE_FUNCTION_NAME = 'code.function.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/db/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/db/attributes.rb index 9db17621bf..034e83194f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/db/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/db/attributes.rb @@ -38,8 +38,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # public.users - # customers + # # public.users + # # customers # DB_COLLECTION_NAME = 'db.collection.name' @@ -52,8 +52,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # customers - # test.users + # # customers + # # test.users # DB_NAMESPACE = 'db.namespace' @@ -64,9 +64,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # 2 - # 3 - # 4 + # # 2 + # # 3 + # # 4 # DB_OPERATION_BATCH_SIZE = 'db.operation.batch.size' @@ -90,9 +90,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # findAndModify - # HMSET - # SELECT + # # findAndModify + # # HMSET + # # SELECT # DB_OPERATION_NAME = 'db.operation.name' @@ -111,9 +111,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # SELECT wuser_table - # INSERT shipping_details SELECT orders - # get user by id + # # SELECT wuser_table + # # INSERT shipping_details SELECT orders + # # get user by id # DB_QUERY_SUMMARY = 'db.query.summary' @@ -126,8 +126,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # SELECT * FROM wuser_table where username = ? - # SET mykey ? + # # SELECT * FROM wuser_table where username = ? + # # SET mykey ? # DB_QUERY_TEXT = 'db.query.text' @@ -139,10 +139,10 @@ module DB # @note Stability Level: stable # # @example Sample Values - # 102 - # ORA-17002 - # 08P01 - # 404 + # # 102 + # # ORA-17002 + # # 08P01 + # # 404 # DB_RESPONSE_STATUS_CODE = 'db.response.status_code' @@ -157,7 +157,7 @@ module DB # @note Stability Level: stable # # @example Sample Values - # GetCustomer + # # GetCustomer # DB_STORED_PROCEDURE_NAME = 'db.stored_procedure.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/dotnet/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/dotnet/attributes.rb index dfe8621814..d37344313c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/dotnet/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/dotnet/attributes.rb @@ -28,9 +28,9 @@ module DOTNET # @note Stability Level: stable # # @example Sample Values - # gen0 - # gen1 - # gen2 + # # gen0 + # # gen1 + # # gen2 # DOTNET_GC_HEAP_GENERATION = 'dotnet.gc.heap.generation' diff --git a/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb index db13d5aec1..00b6aace93 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb @@ -48,10 +48,10 @@ module ERROR # @note Stability Level: stable # # @example Sample Values - # timeout - # java.net.UnknownHostException - # server_certificate_invalid - # 500 + # # timeout + # # java.net.UnknownHostException + # # server_certificate_invalid + # # 500 # ERROR_TYPE = 'error.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb index 59d80ea38b..e65980a916 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb @@ -34,8 +34,8 @@ module EXCEPTION # @note Stability Level: stable # # @example Sample Values - # Division by zero - # Can't convert 'int' object to str implicitly + # # Division by zero + # # Can't convert 'int' object to str implicitly # EXCEPTION_MESSAGE = 'exception.message' @@ -53,8 +53,8 @@ module EXCEPTION # @note Stability Level: stable # # @example Sample Values - # java.net.ConnectException - # OSError + # # java.net.ConnectException + # # OSError # EXCEPTION_TYPE = 'exception.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb index bc9f4b6b11..467a2f87a4 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb @@ -51,9 +51,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # ["application/json"] - # ["1.2.3.4", "1.2.3.5"] - # + # # application/json + # # 1.2.3.4 + # 1.2.3.5 HTTP_REQUEST_HEADER_LAMBDA = ->(key) { "http.request.header.#{key}" } # HTTP request method. @@ -76,9 +76,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # GET - # POST - # HEAD + # # GET + # # POST + # # HEAD # HTTP_REQUEST_METHOD = 'http.request.method' @@ -87,9 +87,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # GeT - # ACL - # foo + # # GeT + # # ACL + # # foo # HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' @@ -131,9 +131,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # ["application/json"] - # ["abc", "def"] - # + # # application/json + # # abc + # def HTTP_RESPONSE_HEADER_LAMBDA = ->(key) { "http.response.header.#{key}" } # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). @@ -141,7 +141,7 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # 200 + # # 200 # HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' @@ -153,8 +153,8 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # /users/:userID? - # {controller}/{action}/{id?} + # # /users/:userID? + # # {controller}/{action}/{id?} # HTTP_ROUTE = 'http.route' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb index 6f6b10ab26..64111cc724 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb @@ -31,24 +31,24 @@ module ANDROID # @note Stability Level: development # # @example Sample Values - # created + # # created # ANDROID_APP_STATE = 'android.app.state' - # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). + # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). # # @note Stability Level: development # # @example Sample Values - # 33 - # 32 + # # 33 + # # 32 # ANDROID_OS_API_LEVEL = 'android.os.api_level' - # Deprecated. Use `android.app.state` body field instead. + # Deprecated. Use `android.app.state` attribute instead. # # @note Stability Level: development - # @deprecated {"note": "Use `android.app.state` body field instead.", "reason": "uncategorized"} + # @deprecated {"note": "Replaced by `android.app.state`.", "reason": "renamed", "renamed_to": "android.app.state"} ANDROID_STATE = 'android.state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/app/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/app/attributes.rb index b8aaf110e1..90b49775d2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/app/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/app/attributes.rb @@ -24,6 +24,17 @@ module Incubating module APP # @!group Attribute Names + # Unique identifier for a particular build or compilation of the application. + # + # @note Stability Level: development + # + # @example Sample Values + # # 6cff0a7e-cefc-4668-96f5-1273d8b334d0 + # # 9f2b833506aa6973a92fde9733e6271f + # # my-app-1.0.0-code-123 + # + APP_BUILD_ID = 'app.build_id' + # A unique identifier representing the installation of an application on a specific device # # Its value SHOULD persist across launches of the same application installation, including through application upgrades. @@ -42,22 +53,56 @@ module APP # - [App set ID](https://developer.android.com/identity/app-set-id). # - [`Settings.getString(Settings.Secure.ANDROID_ID)`](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID). # - # More information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids). + # More information about Android identifier best practices can be found in the [Android user data IDs guide](https://developer.android.com/training/articles/user-data-ids). # # @note Stability Level: development # # @example Sample Values - # 2ab2916d-a51f-4ac8-80ee-45ac31a28092 + # # 2ab2916d-a51f-4ac8-80ee-45ac31a28092 # APP_INSTALLATION_ID = 'app.installation.id' + # A number of frame renders that experienced jank. + # + # Depending on platform limitations, the value provided MAY be approximation. + # + # @note Stability Level: development + # + # @example Sample Values + # # 9 + # # 42 + # + APP_JANK_FRAME_COUNT = 'app.jank.frame_count' + + # The time period, in seconds, for which this jank is being reported. + # + # @note Stability Level: development + # + # @example Sample Values + # # 1.0 + # # 5.0 + # # 10.24 + # + APP_JANK_PERIOD = 'app.jank.period' + + # The minimum rendering threshold for this jank, in seconds. + # + # @note Stability Level: development + # + # @example Sample Values + # # 0.016 + # # 0.7 + # # 1.024 + # + APP_JANK_THRESHOLD = 'app.jank.threshold' + # The x (horizontal) coordinate of a screen coordinate, in screen pixels. # # @note Stability Level: development # # @example Sample Values - # 0 - # 131 + # # 0 + # # 131 # APP_SCREEN_COORDINATE_X = 'app.screen.coordinate.x' @@ -66,8 +111,8 @@ module APP # @note Stability Level: development # # @example Sample Values - # 12 - # 99 + # # 12 + # # 99 # APP_SCREEN_COORDINATE_Y = 'app.screen.coordinate.y' @@ -78,8 +123,8 @@ module APP # @note Stability Level: development # # @example Sample Values - # f9bc787d-ff05-48ad-90e1-fca1d46130b3 - # submit_order_1829 + # # f9bc787d-ff05-48ad-90e1-fca1d46130b3 + # # submit_order_1829 # APP_WIDGET_ID = 'app.widget.id' @@ -90,9 +135,9 @@ module APP # @note Stability Level: development # # @example Sample Values - # submit - # attack - # Clear Cart + # # submit + # # attack + # # Clear Cart # APP_WIDGET_NAME = 'app.widget.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/artifact/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/artifact/attributes.rb index 47420cb6ae..3cd069e02e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/artifact/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/artifact/attributes.rb @@ -29,10 +29,10 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # golang-binary-amd64-v0.1.0.attestation - # docker-image-amd64-v0.1.0.intoto.json1 - # release-1.tar.gz.attestation - # file-name-package.tar.gz.intoto.json1 + # # golang-binary-amd64-v0.1.0.attestation + # # docker-image-amd64-v0.1.0.intoto.json1 + # # release-1.tar.gz.attestation + # # file-name-package.tar.gz.intoto.json1 # ARTIFACT_ATTESTATION_FILENAME = 'artifact.attestation.filename' @@ -41,7 +41,7 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # 1b31dfcd5b7f9267bf2ff47651df1cfb9147b9e4df1f335accf65b4cda498408 + # # 1b31dfcd5b7f9267bf2ff47651df1cfb9147b9e4df1f335accf65b4cda498408 # ARTIFACT_ATTESTATION_HASH = 'artifact.attestation.hash' @@ -50,7 +50,7 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # 123 + # # 123 # ARTIFACT_ATTESTATION_ID = 'artifact.attestation.id' @@ -64,10 +64,10 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # golang-binary-amd64-v0.1.0 - # docker-image-amd64-v0.1.0 - # release-1.tar.gz - # file-name-package.tar.gz + # # golang-binary-amd64-v0.1.0 + # # docker-image-amd64-v0.1.0 + # # release-1.tar.gz + # # file-name-package.tar.gz # ARTIFACT_FILENAME = 'artifact.filename' @@ -85,7 +85,7 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # 9ff4c52759e2c4ac70b7d517bc7fcdc1cda631ca0045271ddd1b192544f8a3e9 + # # 9ff4c52759e2c4ac70b7d517bc7fcdc1cda631ca0045271ddd1b192544f8a3e9 # ARTIFACT_HASH = 'artifact.hash' @@ -94,8 +94,8 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # pkg:github/package-url/purl-spec@1209109710924 - # pkg:npm/foo@12.12.3 + # # pkg:github/package-url/purl-spec@1209109710924 + # # pkg:npm/foo@12.12.3 # ARTIFACT_PURL = 'artifact.purl' @@ -104,9 +104,9 @@ module ARTIFACT # @note Stability Level: development # # @example Sample Values - # v0.1.0 - # 1.2.1 - # 122691-build + # # v0.1.0 + # # 1.2.1 + # # 122691-build # ARTIFACT_VERSION = 'artifact.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb index a4b5269e15..af4fd12ae8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb @@ -24,13 +24,53 @@ module Incubating module ASPNETCORE # @!group Attribute Names - # ASP.NET Core exception middleware handling result + # The result of the authentication operation. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_AUTHENTICATION_RESULT = 'aspnetcore.authentication.result' + + # The identifier that names a particular authentication handler. + # + # @note Stability Level: development + # + # @example Sample Values + # # Cookies + # # Bearer + # # Identity.Application + # + ASPNETCORE_AUTHENTICATION_SCHEME = 'aspnetcore.authentication.scheme' + + # The name of the authorization policy. + # + # @note Stability Level: development + # + # @example Sample Values + # # RequireAdminRole + # + ASPNETCORE_AUTHORIZATION_POLICY = 'aspnetcore.authorization.policy' + + # The result of calling the authorization service. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_AUTHORIZATION_RESULT = 'aspnetcore.authorization.result' + + # ASP.NET Core exception middleware handling result. # # @note Stability Level: stable # # @example Sample Values - # handled - # unhandled + # # handled + # # unhandled # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. @@ -41,20 +81,120 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # Contoso.MyHandler + # # Contoso.MyHandler # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' + # The error code for a failed identity operation. + # + # @note Stability Level: development + # + # @example Sample Values + # # DefaultError + # # PasswordMismatch + # + ASPNETCORE_IDENTITY_ERROR_CODE = 'aspnetcore.identity.error_code' + + # The result from checking the password. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_IDENTITY_PASSWORD_CHECK_RESULT = 'aspnetcore.identity.password_check_result' + + # The result of the identity operation. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_IDENTITY_RESULT = 'aspnetcore.identity.result' + + # Whether the sign in result was success or failure. + # + # @note Stability Level: development + # + # @example Sample Values + # # password + # # two_factor + # + ASPNETCORE_IDENTITY_SIGN_IN_RESULT = 'aspnetcore.identity.sign_in.result' + + # The authentication type. + # + # @note Stability Level: development + # + # @example Sample Values + # # password + # # two_factor + # + ASPNETCORE_IDENTITY_SIGN_IN_TYPE = 'aspnetcore.identity.sign_in.type' + + # What the token will be used for. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_IDENTITY_TOKEN_PURPOSE = 'aspnetcore.identity.token_purpose' + + # The result of token verification. + # + # @note Stability Level: development + # + # @example Sample Values + # # success + # # failure + # + ASPNETCORE_IDENTITY_TOKEN_VERIFIED = 'aspnetcore.identity.token_verified' + + # The user update type. + # + # @note Stability Level: development + # + # @example Sample Values + # # update + # # user_name + # # reset_password + # + ASPNETCORE_IDENTITY_USER_UPDATE_TYPE = 'aspnetcore.identity.user.update_type' + + # The full name of the identity user type. + # + # @note Stability Level: development + # + # @example Sample Values + # # Contoso.ContosoUser + # + ASPNETCORE_IDENTITY_USER_TYPE = 'aspnetcore.identity.user_type' + + # The name of the library or subsystem using the memory pool instance. + # + # @note Stability Level: development + # + # @example Sample Values + # # kestrel + # # iis + # + ASPNETCORE_MEMORY_POOL_OWNER = 'aspnetcore.memory_pool.owner' + # Rate limiting policy name. # # @note Stability Level: stable # # @example Sample Values - # fixed - # sliding - # token + # # fixed + # # sliding + # # token # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. @@ -65,8 +205,8 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # acquired - # request_canceled + # # acquired + # # request_canceled # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. @@ -77,7 +217,7 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # true + # # true # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. @@ -88,7 +228,7 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # true + # # true # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. @@ -99,13 +239,29 @@ module ASPNETCORE # @note Stability Level: stable # # @example Sample Values - # success - # failure + # # success + # # failure # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' + # A flag indicating whether the sign in is persistent. + # + # @note Stability Level: development + ASPNETCORE_SIGN_IN_IS_PERSISTENT = 'aspnetcore.sign_in.is_persistent' + + # A value that indicates whether the user is authenticated. + # + # @note Stability Level: stable + # + # @example Sample Values + # # true + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_USER_IS_AUTHENTICATED}. + ASPNETCORE_USER_IS_AUTHENTICATED = 'aspnetcore.user.is_authenticated' + # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb index b7586126ae..88f861ac8a 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb @@ -24,6 +24,48 @@ module Incubating module ASPNETCORE # @!group Metrics Names + # The authentication duration for a request. + # + # Meter name: `Microsoft.AspNetCore.Authentication`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHENTICATION_AUTHENTICATE_DURATION = 'aspnetcore.authentication.authenticate.duration' + + # The total number of times a scheme is challenged. + # + # Meter name: `Microsoft.AspNetCore.Authentication`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHENTICATION_CHALLENGES = 'aspnetcore.authentication.challenges' + + # The total number of times an authenticated user attempts to access a resource they are not permitted to access. + # + # Meter name: `Microsoft.AspNetCore.Authentication`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHENTICATION_FORBIDS = 'aspnetcore.authentication.forbids' + + # The total number of times a principal is signed in with a scheme. + # + # Meter name: `Microsoft.AspNetCore.Authentication`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHENTICATION_SIGN_INS = 'aspnetcore.authentication.sign_ins' + + # The total number of times a principal is signed out with a scheme. + # + # Meter name: `Microsoft.AspNetCore.Authentication`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHENTICATION_SIGN_OUTS = 'aspnetcore.authentication.sign_outs' + + # The total number of authorization attempts. + # + # Meter name: `Microsoft.AspNetCore.Authorization`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_AUTHORIZATION_ATTEMPTS = 'aspnetcore.authorization.attempts' + # Number of exceptions caught by exception handling middleware. # # Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0 @@ -33,6 +75,118 @@ module ASPNETCORE # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTIONS}. ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions' + # The duration of authenticate attempts. The authenticate metrics is recorded by sign in methods such as PasswordSignInAsync and TwoFactorSignInAsync. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_AUTHENTICATE_DURATION = 'aspnetcore.identity.sign_in.authenticate.duration' + + # The total number of check password attempts. Checks that the account is in a state that can log in and that the password is valid using the UserManager.CheckPasswordAsync method. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_CHECK_PASSWORD_ATTEMPTS = 'aspnetcore.identity.sign_in.check_password_attempts' + + # The total number of calls to sign in user principals. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_SIGN_INS = 'aspnetcore.identity.sign_in.sign_ins' + + # The total number of calls to sign out user principals. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_SIGN_OUTS = 'aspnetcore.identity.sign_in.sign_outs' + + # The total number of two factor clients forgotten. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_TWO_FACTOR_CLIENTS_FORGOTTEN = 'aspnetcore.identity.sign_in.two_factor_clients_forgotten' + + # The total number of two factor clients remembered. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_SIGN_IN_TWO_FACTOR_CLIENTS_REMEMBERED = 'aspnetcore.identity.sign_in.two_factor_clients_remembered' + + # The number of check password attempts. Only checks whether the password is valid and not whether the user account is in a state that can log in. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_CHECK_PASSWORD_ATTEMPTS = 'aspnetcore.identity.user.check_password_attempts' + + # The duration of user creation operations. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_CREATE_DURATION = 'aspnetcore.identity.user.create.duration' + + # The duration of user deletion operations. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_DELETE_DURATION = 'aspnetcore.identity.user.delete.duration' + + # The total number of token generations. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_GENERATED_TOKENS = 'aspnetcore.identity.user.generated_tokens' + + # The duration of user update operations. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_UPDATE_DURATION = 'aspnetcore.identity.user.update.duration' + + # The total number of token verification attempts. + # + # Meter name: `Microsoft.AspNetCore.Identity`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_IDENTITY_USER_VERIFY_TOKEN_ATTEMPTS = 'aspnetcore.identity.user.verify_token_attempts' + + # Total number of bytes allocated by the memory pool. Allocation occurs when a memory rental request exceeds the available pooled memory. + # + # Meter name: `Microsoft.AspNetCore.MemoryPool`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_MEMORY_POOL_ALLOCATED = 'aspnetcore.memory_pool.allocated' + + # Total number of bytes evicted from the memory pool. Eviction occurs when idle pooled memory is reclaimed. + # + # Meter name: `Microsoft.AspNetCore.MemoryPool`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_MEMORY_POOL_EVICTED = 'aspnetcore.memory_pool.evicted' + + # Number of bytes currently pooled and available for reuse. + # + # Meter name: `Microsoft.AspNetCore.MemoryPool`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_MEMORY_POOL_POOLED = 'aspnetcore.memory_pool.pooled' + + # Total number of bytes rented from the memory pool. + # + # Meter name: `Microsoft.AspNetCore.MemoryPool`; Added in: ASP.NET Core 10.0 + # + # @note Stability Level: development + ASPNETCORE_MEMORY_POOL_RENTED = 'aspnetcore.memory_pool.rented' + # 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 diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb index f7a38d65a9..aa8940e774 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb @@ -29,7 +29,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # sgi5gkybzqak + # # sgi5gkybzqak # AWS_BEDROCK_GUARDRAIL_ID = 'aws.bedrock.guardrail.id' @@ -38,7 +38,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # XFWUPB9PAW + # # XFWUPB9PAW # AWS_BEDROCK_KNOWLEDGE_BASE_ID = 'aws.bedrock.knowledge_base.id' @@ -47,7 +47,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"] + # # { "AttributeName": "string", "AttributeType": "string" } # AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' @@ -56,8 +56,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["lives", "id"] - # + # # lives + # id AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' # The value of the `ConsistentRead` request parameter. @@ -70,7 +70,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"] + # # { "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "LocalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "ReadCapacityUnits": number, "Table": { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableName": "string", "WriteCapacityUnits": number } # AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' @@ -79,7 +79,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 10 + # # 10 # AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' @@ -88,8 +88,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # Users - # CatsTable + # # Users + # # CatsTable # AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' @@ -98,7 +98,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["{ \"Create\": { \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"] + # # { "Create": { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } # AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' @@ -107,7 +107,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["{ \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"] + # # { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } # AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' @@ -116,7 +116,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # name_to_group + # # name_to_group # AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' @@ -125,7 +125,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] } + # # { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] } # AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' @@ -134,7 +134,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 10 + # # 10 # AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' @@ -143,7 +143,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["{ \"IndexArn\": \"string\", \"IndexName\": \"string\", \"IndexSizeBytes\": number, \"ItemCount\": number, \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" } }"] + # # { "IndexArn": "string", "IndexName": "string", "IndexSizeBytes": number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } } # AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' @@ -152,9 +152,9 @@ module AWS # @note Stability Level: development # # @example Sample Values - # Title - # Title, Price, Color - # Title, Description, RelatedItems, ProductReviews + # # Title + # # Title, Price, Color + # # Title, Description, RelatedItems, ProductReviews # AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' @@ -163,8 +163,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 1.0 - # 2.0 + # # 1.0 + # # 2.0 # AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' @@ -173,8 +173,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 1.0 - # 2.0 + # # 1.0 + # # 2.0 # AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' @@ -188,7 +188,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 50 + # # 50 # AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' @@ -197,7 +197,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 10 + # # 10 # AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' @@ -206,8 +206,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ALL_ATTRIBUTES - # COUNT + # # ALL_ATTRIBUTES + # # COUNT # AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' @@ -216,7 +216,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 20 + # # 20 # AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' @@ -225,8 +225,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["Users", "Cats"] - # + # # Users + # Cats AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' # The value of the `TotalSegments` request parameter. @@ -234,7 +234,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 100 + # # 100 # AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' @@ -243,7 +243,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster + # # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster # AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' @@ -252,7 +252,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9 + # # arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9 # AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' @@ -266,8 +266,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b - # arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd + # # arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b + # # arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd # AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' @@ -276,7 +276,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # opentelemetry-family + # # opentelemetry-family # AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' @@ -285,8 +285,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 10838bed-421f-43ef-870a-f43feacbbb5b - # 23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd + # # 10838bed-421f-43ef-870a-f43feacbbb5b + # # 23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd # AWS_ECS_TASK_ID = 'aws.ecs.task.id' @@ -295,8 +295,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 8 - # 26 + # # 8 + # # 26 # AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' @@ -305,7 +305,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster + # # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster # AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' @@ -314,7 +314,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= + # # wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ= # AWS_EXTENDED_REQUEST_ID = 'aws.extended_request_id' @@ -323,7 +323,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # some-stream-name + # # some-stream-name # AWS_KINESIS_STREAM_NAME = 'aws.kinesis.stream_name' @@ -334,7 +334,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:lambda:us-east-1:123456:function:myfunction:myalias + # # arn:aws:lambda:us-east-1:123456:function:myfunction:myalias # AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' @@ -343,7 +343,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 587ad24b-03b9-4413-8202-bbd56b36e5b7 + # # 587ad24b-03b9-4413-8202-bbd56b36e5b7 # AWS_LAMBDA_RESOURCE_MAPPING_ID = 'aws.lambda.resource_mapping.id' @@ -354,7 +354,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"] + # # arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:* # AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' @@ -365,8 +365,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["/aws/lambda/my-function", "opentelemetry-service"] - # + # # /aws/lambda/my-function + # opentelemetry-service AWS_LOG_GROUP_NAMES = 'aws.log.group.names' # The ARN(s) of the AWS log stream(s). @@ -376,7 +376,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"] + # # arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b # AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' @@ -385,7 +385,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # ["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"] + # # logs/main/10838bed-421f-43ef-870a-f43feacbbb5b # AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' @@ -394,8 +394,8 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 79b9da39-b7ae-508a-a6bc-864b2829c622 - # C9ER4AJX75574TDJ + # # 79b9da39-b7ae-508a-a6bc-864b2829c622 + # # C9ER4AJX75574TDJ # AWS_REQUEST_ID = 'aws.request_id' @@ -407,7 +407,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # some-bucket-name + # # some-bucket-name # AWS_S3_BUCKET = 'aws.s3.bucket' @@ -423,7 +423,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # someFile.yml + # # someFile.yml # AWS_S3_COPY_SOURCE = 'aws.s3.copy_source' @@ -436,7 +436,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean + # # Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean # AWS_S3_DELETE = 'aws.s3.delete' @@ -462,7 +462,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # someFile.yml + # # someFile.yml # AWS_S3_KEY = 'aws.s3.key' @@ -476,7 +476,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # 3456 + # # 3456 # AWS_S3_PART_NUMBER = 'aws.s3.part_number' @@ -495,7 +495,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ + # # dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ # AWS_S3_UPLOAD_ID = 'aws.s3.upload_id' @@ -504,7 +504,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters + # # arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters # AWS_SECRETSMANAGER_SECRET_ARN = 'aws.secretsmanager.secret.arn' @@ -513,7 +513,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE + # # arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE # AWS_SNS_TOPIC_ARN = 'aws.sns.topic.arn' @@ -522,7 +522,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue + # # https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue # AWS_SQS_QUEUE_URL = 'aws.sqs.queue.url' @@ -531,7 +531,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:states:us-east-1:123456789012:activity:get-greeting + # # arn:aws:states:us-east-1:123456789012:activity:get-greeting # AWS_STEP_FUNCTIONS_ACTIVITY_ARN = 'aws.step_functions.activity.arn' @@ -540,7 +540,7 @@ module AWS # @note Stability Level: development # # @example Sample Values - # arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1 + # # arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1 # AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN = 'aws.step_functions.state_machine.arn' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/az/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/az/attributes.rb index 76c0c34943..dcc5821db8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/az/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/az/attributes.rb @@ -29,9 +29,9 @@ module AZ # @note Stability Level: development # # @example Sample Values - # Microsoft.Storage - # Microsoft.KeyVault - # Microsoft.ServiceBus + # # Microsoft.Storage + # # Microsoft.KeyVault + # # Microsoft.ServiceBus # # @deprecated {"note": "Replaced by `azure.resource_provider.namespace`.", "reason": "renamed", "renamed_to": "azure.resource_provider.namespace"} AZ_NAMESPACE = 'az.namespace' @@ -41,7 +41,7 @@ module AZ # @note Stability Level: development # # @example Sample Values - # 00000000-0000-0000-0000-000000000000 + # # 00000000-0000-0000-0000-000000000000 # # @deprecated {"note": "Replaced by `azure.service.request.id`.", "reason": "renamed", "renamed_to": "azure.service.request.id"} AZ_SERVICE_REQUEST_ID = 'az.service_request_id' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/attributes.rb index e8607a4fd7..2ace79df7a 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/attributes.rb @@ -29,8 +29,8 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # 3ba4827d-4422-483f-b59f-85b74211c11d - # storage-client-1 + # # 3ba4827d-4422-483f-b59f-85b74211c11d + # # storage-client-1 # AZURE_CLIENT_ID = 'azure.client.id' @@ -44,11 +44,11 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # Eventual - # ConsistentPrefix - # BoundedStaleness - # Strong - # Session + # # Eventual + # # ConsistentPrefix + # # BoundedStaleness + # # Strong + # # Session # AZURE_COSMOSDB_CONSISTENCY_LEVEL = 'azure.cosmosdb.consistency.level' @@ -59,8 +59,9 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # ["North Central US", "Australia East", "Australia Southeast"] - # + # # North Central US + # Australia East + # Australia Southeast AZURE_COSMOSDB_OPERATION_CONTACTED_REGIONS = 'azure.cosmosdb.operation.contacted_regions' # The number of request units consumed by the operation. @@ -68,8 +69,8 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # 46.18 - # 1.0 + # # 46.18 + # # 1.0 # AZURE_COSMOSDB_OPERATION_REQUEST_CHARGE = 'azure.cosmosdb.operation.request_charge' @@ -83,8 +84,8 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # 1000 - # 1002 + # # 1000 + # # 1002 # AZURE_COSMOSDB_RESPONSE_SUB_STATUS_CODE = 'azure.cosmosdb.response.sub_status_code' @@ -93,9 +94,9 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # Microsoft.Storage - # Microsoft.KeyVault - # Microsoft.ServiceBus + # # Microsoft.Storage + # # Microsoft.KeyVault + # # Microsoft.ServiceBus # AZURE_RESOURCE_PROVIDER_NAMESPACE = 'azure.resource_provider.namespace' @@ -104,7 +105,7 @@ module AZURE # @note Stability Level: development # # @example Sample Values - # 00000000-0000-0000-0000-000000000000 + # # 00000000-0000-0000-0000-000000000000 # AZURE_SERVICE_REQUEST_ID = 'azure.service.request.id' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/metrics.rb index 0b1c564918..df2178956b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/azure/metrics.rb @@ -24,12 +24,12 @@ module Incubating module AZURE # @!group Metrics Names - # Number of active client instances + # Number of active client instances. # # @note Stability Level: development AZURE_COSMOSDB_CLIENT_ACTIVE_INSTANCE_COUNT = 'azure.cosmosdb.client.active_instance.count' - # [Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation + # [Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation. # # @note Stability Level: development AZURE_COSMOSDB_CLIENT_OPERATION_REQUEST_CHARGE = 'azure.cosmosdb.client.operation.request_charge' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb index 7ba9993eef..51631608c0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb @@ -31,8 +31,9 @@ module BROWSER # @note Stability Level: development # # @example Sample Values - # [" Not A;Brand 99", "Chromium 99", "Chrome 99"] - # + # # Not A;Brand 99 + # Chromium 99 + # Chrome 99 BROWSER_BRANDS = 'browser.brands' # Preferred language of the user using the browser @@ -42,10 +43,10 @@ module BROWSER # @note Stability Level: development # # @example Sample Values - # en - # en-US - # fr - # fr-FR + # # en + # # en-US + # # fr + # # fr-FR # BROWSER_LANGUAGE = 'browser.language' @@ -64,9 +65,9 @@ module BROWSER # @note Stability Level: development # # @example Sample Values - # Windows - # macOS - # Android + # # Windows + # # macOS + # # Android # BROWSER_PLATFORM = 'browser.platform' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb index dc3e69d793..9791b09b01 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb @@ -52,7 +52,7 @@ module CASSANDRA # @note Stability Level: development # # @example Sample Values - # 5000 + # # 5000 # CASSANDRA_PAGE_SIZE = 'cassandra.page.size' @@ -66,8 +66,8 @@ module CASSANDRA # @note Stability Level: development # # @example Sample Values - # 0 - # 2 + # # 0 + # # 2 # CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'cassandra.speculative_execution.count' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cicd/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cicd/attributes.rb index 07826b2ecb..e2a3fd3dda 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cicd/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cicd/attributes.rb @@ -29,9 +29,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # BUILD - # RUN - # SYNC + # # BUILD + # # RUN + # # SYNC # CICD_PIPELINE_ACTION_NAME = 'cicd.pipeline.action.name' @@ -40,10 +40,10 @@ module CICD # @note Stability Level: development # # @example Sample Values - # Build and Test - # Lint - # Deploy Go Project - # deploy_to_environment + # # Build and Test + # # Lint + # # Deploy Go Project + # # deploy_to_environment # CICD_PIPELINE_NAME = 'cicd.pipeline.name' @@ -52,10 +52,10 @@ module CICD # @note Stability Level: development # # @example Sample Values - # success - # failure - # timeout - # skipped + # # success + # # failure + # # timeout + # # skipped # CICD_PIPELINE_RESULT = 'cicd.pipeline.result' @@ -64,7 +64,7 @@ module CICD # @note Stability Level: development # # @example Sample Values - # 120912 + # # 120912 # CICD_PIPELINE_RUN_ID = 'cicd.pipeline.run.id' @@ -73,9 +73,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # pending - # executing - # finalizing + # # pending + # # executing + # # finalizing # CICD_PIPELINE_RUN_STATE = 'cicd.pipeline.run.state' @@ -84,7 +84,7 @@ module CICD # @note Stability Level: development # # @example Sample Values - # https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075 + # # https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075 # CICD_PIPELINE_RUN_URL_FULL = 'cicd.pipeline.run.url.full' @@ -93,10 +93,10 @@ module CICD # @note Stability Level: development # # @example Sample Values - # Run GoLang Linter - # Go Build - # go-test - # deploy_binary + # # Run GoLang Linter + # # Go Build + # # go-test + # # deploy_binary # CICD_PIPELINE_TASK_NAME = 'cicd.pipeline.task.name' @@ -105,7 +105,7 @@ module CICD # @note Stability Level: development # # @example Sample Values - # 12097 + # # 12097 # CICD_PIPELINE_TASK_RUN_ID = 'cicd.pipeline.task.run.id' @@ -114,10 +114,10 @@ module CICD # @note Stability Level: development # # @example Sample Values - # success - # failure - # timeout - # skipped + # # success + # # failure + # # timeout + # # skipped # CICD_PIPELINE_TASK_RUN_RESULT = 'cicd.pipeline.task.run.result' @@ -126,7 +126,7 @@ module CICD # @note Stability Level: development # # @example Sample Values - # https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075 + # # https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075 # CICD_PIPELINE_TASK_RUN_URL_FULL = 'cicd.pipeline.task.run.url.full' @@ -135,9 +135,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # build - # test - # deploy + # # build + # # test + # # deploy # CICD_PIPELINE_TASK_TYPE = 'cicd.pipeline.task.type' @@ -146,9 +146,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # controller - # scheduler - # agent + # # controller + # # scheduler + # # agent # CICD_SYSTEM_COMPONENT = 'cicd.system.component' @@ -157,9 +157,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # abc123 - # 10.0.1.2 - # controller + # # abc123 + # # 10.0.1.2 + # # controller # CICD_WORKER_ID = 'cicd.worker.id' @@ -168,9 +168,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # agent-abc - # controller - # Ubuntu LTS + # # agent-abc + # # controller + # # Ubuntu LTS # CICD_WORKER_NAME = 'cicd.worker.name' @@ -179,9 +179,9 @@ module CICD # @note Stability Level: development # # @example Sample Values - # idle - # busy - # down + # # idle + # # busy + # # down # CICD_WORKER_STATE = 'cicd.worker.state' @@ -190,7 +190,7 @@ module CICD # @note Stability Level: development # # @example Sample Values - # https://cicd.example.org/worker/abc123 + # # https://cicd.example.org/worker/abc123 # CICD_WORKER_URL_FULL = 'cicd.worker.url.full' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb index 484b20428b..3a80d4f079 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb @@ -31,9 +31,9 @@ module CLIENT # @note Stability Level: stable # # @example Sample Values - # client.example.com - # 10.1.2.80 - # /tmp/my.sock + # # client.example.com + # # 10.1.2.80 + # # /tmp/my.sock # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_ADDRESS}. @@ -46,7 +46,7 @@ module CLIENT # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_PORT}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb index 76b858f6a5..1a07c6f153 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb @@ -29,8 +29,8 @@ module CLOUD # @note Stability Level: development # # @example Sample Values - # 111111111111 - # opentelemetry + # # 111111111111 + # # opentelemetry # CLOUD_ACCOUNT_ID = 'cloud.account.id' @@ -41,7 +41,7 @@ module CLOUD # @note Stability Level: development # # @example Sample Values - # us-east-1c + # # us-east-1c # CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' @@ -64,8 +64,8 @@ module CLOUD # @note Stability Level: development # # @example Sample Values - # us-central1 - # us-east-1 + # # us-central1 + # # us-east-1 # CLOUD_REGION = 'cloud.region' @@ -92,9 +92,9 @@ module CLOUD # @note Stability Level: development # # @example Sample Values - # arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function - # //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID - # /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ + # # arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function + # # //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID + # # /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ # CLOUD_RESOURCE_ID = 'cloud.resource_id' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb index 44f12c6e4c..caf6c9bec7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb @@ -29,8 +29,8 @@ module CLOUDEVENTS # @note Stability Level: development # # @example Sample Values - # 123e4567-e89b-12d3-a456-426614174000 - # 0001 + # # 123e4567-e89b-12d3-a456-426614174000 + # # 0001 # CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' @@ -39,9 +39,9 @@ module CLOUDEVENTS # @note Stability Level: development # # @example Sample Values - # https://github.com/cloudevents - # /cloudevents/spec/pull/123 - # my-service + # # https://github.com/cloudevents + # # /cloudevents/spec/pull/123 + # # my-service # CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' @@ -68,8 +68,8 @@ module CLOUDEVENTS # @note Stability Level: development # # @example Sample Values - # com.github.pull_request.opened - # com.example.object.deleted.v2 + # # com.github.pull_request.opened + # # com.example.object.deleted.v2 # CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb index a4592daf7b..8a92528b61 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb @@ -33,7 +33,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # CLOUDFOUNDRY_APP_ID = 'cloudfoundry.app.id' @@ -50,8 +50,8 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 0 - # 1 + # # 0 + # # 1 # CLOUDFOUNDRY_APP_INSTANCE_ID = 'cloudfoundry.app.instance.id' @@ -64,7 +64,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # my-app-name + # # my-app-name # CLOUDFOUNDRY_APP_NAME = 'cloudfoundry.app.name' @@ -77,7 +77,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # CLOUDFOUNDRY_ORG_ID = 'cloudfoundry.org.id' @@ -90,7 +90,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # my-org-name + # # my-org-name # CLOUDFOUNDRY_ORG_NAME = 'cloudfoundry.org.name' @@ -104,7 +104,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # CLOUDFOUNDRY_PROCESS_ID = 'cloudfoundry.process.id' @@ -117,7 +117,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # web + # # web # CLOUDFOUNDRY_PROCESS_TYPE = 'cloudfoundry.process.type' @@ -130,7 +130,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # CLOUDFOUNDRY_SPACE_ID = 'cloudfoundry.space.id' @@ -143,7 +143,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # my-space-name + # # my-space-name # CLOUDFOUNDRY_SPACE_NAME = 'cloudfoundry.space.name' @@ -162,7 +162,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # cf/gorouter + # # cf/gorouter # CLOUDFOUNDRY_SYSTEM_ID = 'cloudfoundry.system.id' @@ -179,7 +179,7 @@ module CLOUDFOUNDRY # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # CLOUDFOUNDRY_SYSTEM_INSTANCE_ID = 'cloudfoundry.system.instance.id' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb index 541b40dd55..a0f3c10ae8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb @@ -97,9 +97,9 @@ module CODE # @note Stability Level: stable # # @example Sample Values - # com.example.MyHttpService.serveRequest - # GuzzleHttp\Client::transfer - # fopen + # # com.example.MyHttpService.serveRequest + # # GuzzleHttp\Client::transfer + # # fopen # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CODE::CODE_FUNCTION_NAME}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb index 0bea55a3e9..6306905144 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb @@ -31,7 +31,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # otelcontribcol + # # otelcontribcol # CONTAINER_COMMAND = 'container.command' @@ -40,8 +40,9 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # ["otelcontribcol", "--config", "config.yaml"] - # + # # otelcontribcol + # --config + # config.yaml CONTAINER_COMMAND_ARGS = 'container.command_args' # The full command run by the container as a single string representing the full command. @@ -49,7 +50,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # otelcontribcol --config config.yaml + # # otelcontribcol --config config.yaml # CONTAINER_COMMAND_LINE = 'container.command_line' @@ -58,8 +59,8 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # user - # kernel + # # user + # # kernel # # @deprecated {"note": "Replaced by `cpu.mode`.", "reason": "renamed", "renamed_to": "cpu.mode"} CONTAINER_CPU_STATE = 'container.cpu.state' @@ -71,7 +72,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # pd.csi.storage.gke.io + # # pd.csi.storage.gke.io # CONTAINER_CSI_PLUGIN_NAME = 'container.csi.plugin.name' @@ -82,7 +83,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk + # # projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk # CONTAINER_CSI_VOLUME_ID = 'container.csi.volume.id' @@ -91,7 +92,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # a3bf90e006b2 + # # a3bf90e006b2 # CONTAINER_ID = 'container.id' @@ -104,7 +105,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f + # # sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f # CONTAINER_IMAGE_ID = 'container.image.id' @@ -113,7 +114,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # gcr.io/opentelemetry/operator + # # gcr.io/opentelemetry/operator # CONTAINER_IMAGE_NAME = 'container.image.name' @@ -124,8 +125,8 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # ["example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb", "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"] - # + # # example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb + # internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578 CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests' # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:`. @@ -133,8 +134,8 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # ["v1.27.1", "3.5.7-0"] - # + # # v1.27.1 + # 3.5.7-0 CONTAINER_IMAGE_TAGS = 'container.image.tags' # Must be called with a key for the full attribute name. See notes below about the expectations @@ -150,7 +151,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # nginx + # # nginx # CONTAINER_LABEL_LAMBDA = ->(key) { "container.label.#{key}" } @@ -165,7 +166,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # nginx + # # nginx # # @deprecated {"note": "Replaced by `container.label`.", "reason": "renamed", "renamed_to": "container.label"} CONTAINER_LABELS_LAMBDA = ->(key) { "container.labels.#{key}" } @@ -175,7 +176,7 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # opentelemetry-autoconf + # # opentelemetry-autoconf # CONTAINER_NAME = 'container.name' @@ -184,12 +185,42 @@ module CONTAINER # @note Stability Level: development # # @example Sample Values - # docker - # containerd - # rkt + # # docker + # # containerd + # # rkt # + # @deprecated {"note": "Replaced by `container.runtime.name`.", "reason": "renamed", "renamed_to": "container.runtime.name"} CONTAINER_RUNTIME = 'container.runtime' + # A description about the runtime which could include, for example details about the CRI/API version being used or other customisations. + # + # @note Stability Level: development + # + # @example Sample Values + # # docker://19.3.1 - CRI: 1.22.0 + # + CONTAINER_RUNTIME_DESCRIPTION = 'container.runtime.description' + + # The container runtime managing this container. + # + # @note Stability Level: development + # + # @example Sample Values + # # docker + # # containerd + # # rkt + # + CONTAINER_RUNTIME_NAME = 'container.runtime.name' + + # The version of the runtime of this process, as returned by the runtime without modification. + # + # @note Stability Level: development + # + # @example Sample Values + # 1.0.0 + # + CONTAINER_RUNTIME_VERSION = 'container.runtime.version' + # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb index e8acd812b9..863e319d66 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb @@ -24,14 +24,14 @@ module Incubating module CONTAINER # @!group Metrics Names - # Total CPU time consumed + # Total CPU time consumed. # # Total CPU time consumed by the specific container on all available CPU cores # # @note Stability Level: development CONTAINER_CPU_TIME = 'container.cpu.time' - # Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs + # Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs. # # CPU usage of the specific container on all available CPU cores, averaged over the sample window # @@ -45,6 +45,38 @@ module CONTAINER # @note Stability Level: development CONTAINER_DISK_IO = 'container.disk.io' + # Container filesystem available bytes. + # + # In K8s, this metric is derived from the + # [FsStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + CONTAINER_FILESYSTEM_AVAILABLE = 'container.filesystem.available' + + # Container filesystem capacity. + # + # In K8s, this metric is derived from the + # [FsStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + CONTAINER_FILESYSTEM_CAPACITY = 'container.filesystem.capacity' + + # Container filesystem usage. + # + # This may not equal capacity - available. + # + # In K8s, this metric is derived from the + # [FsStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + CONTAINER_FILESYSTEM_USAGE = 'container.filesystem.usage' + # Memory usage of the container. # # Memory usage of the container. @@ -59,7 +91,7 @@ module CONTAINER # @note Stability Level: development CONTAINER_NETWORK_IO = 'container.network.io' - # The time the container has been running + # The time the container has been running. # # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. # The actual accuracy would depend on the instrumentation and operating system. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cpu/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cpu/attributes.rb index 775413ad99..9e79b1f5bc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cpu/attributes.rb @@ -29,7 +29,7 @@ module CPU # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # CPU_LOGICAL_NUMBER = 'cpu.logical_number' @@ -38,8 +38,8 @@ module CPU # @note Stability Level: development # # @example Sample Values - # user - # system + # # user + # # system # CPU_MODE = 'cpu.mode' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cpython/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cpython/attributes.rb index b2a23b00e4..03363a6f97 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cpython/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cpython/attributes.rb @@ -29,9 +29,9 @@ module CPYTHON # @note Stability Level: development # # @example Sample Values - # 0 - # 1 - # 2 + # # 0 + # # 1 + # # 2 # CPYTHON_GC_GENERATION = 'cpython.gc.generation' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb index 15575e1031..e330de1dd1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb @@ -61,7 +61,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # 5000 + # # 5000 # # @deprecated {"note": "Replaced by `cassandra.page.size`.", "reason": "renamed", "renamed_to": "cassandra.page.size"} DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' @@ -71,8 +71,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # 0 - # 2 + # # 0 + # # 2 # # @deprecated {"note": "Replaced by `cassandra.speculative_execution.count`.", "reason": "renamed", "renamed_to": "cassandra.speculative_execution.count"} DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' @@ -92,7 +92,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # myDataSource + # # myDataSource # DB_CLIENT_CONNECTION_POOL_NAME = 'db.client.connection.pool.name' @@ -101,7 +101,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # idle + # # idle # DB_CLIENT_CONNECTION_STATE = 'db.client.connection.state' @@ -110,7 +110,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # myDataSource + # # myDataSource # # @deprecated {"note": "Replaced by `db.client.connection.pool.name`.", "reason": "renamed", "renamed_to": "db.client.connection.pool.name"} DB_CLIENT_CONNECTIONS_POOL_NAME = 'db.client.connections.pool.name' @@ -120,7 +120,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # idle + # # idle # # @deprecated {"note": "Replaced by `db.client.connection.state`.", "reason": "renamed", "renamed_to": "db.client.connection.state"} DB_CLIENT_CONNECTIONS_STATE = 'db.client.connections.state' @@ -140,8 +140,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # public.users - # customers + # # public.users + # # customers # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_COLLECTION_NAME}. @@ -178,11 +178,11 @@ module DB # @note Stability Level: development # # @example Sample Values - # Eventual - # ConsistentPrefix - # BoundedStaleness - # Strong - # Session + # # Eventual + # # ConsistentPrefix + # # BoundedStaleness + # # Strong + # # Session # # @deprecated {"note": "Replaced by `azure.cosmosdb.consistency.level`.", "reason": "renamed", "renamed_to": "azure.cosmosdb.consistency.level"} DB_COSMOSDB_CONSISTENCY_LEVEL = 'db.cosmosdb.consistency_level' @@ -208,7 +208,9 @@ module DB # @note Stability Level: development # # @example Sample Values - # ["North Central US", "Australia East", "Australia Southeast"] + # # North Central US + # Australia East + # Australia Southeast # # @deprecated {"note": "Replaced by `azure.cosmosdb.operation.contacted_regions`.", "reason": "renamed", "renamed_to": "azure.cosmosdb.operation.contacted_regions"} DB_COSMOSDB_REGIONS_CONTACTED = 'db.cosmosdb.regions_contacted' @@ -218,8 +220,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # 46.18 - # 1.0 + # # 46.18 + # # 1.0 # # @deprecated {"note": "Replaced by `azure.cosmosdb.operation.request_charge`.", "reason": "renamed", "renamed_to": "azure.cosmosdb.operation.request_charge"} DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge' @@ -235,8 +237,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # 200 - # 201 + # # 200 + # # 201 # # @deprecated {"note": "Replaced by `db.response.status_code`.", "reason": "renamed", "renamed_to": "db.response.status_code"} DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code' @@ -246,8 +248,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # 1000 - # 1002 + # # 1000 + # # 1002 # # @deprecated {"note": "Replaced by `azure.cosmosdb.response.sub_status_code`.", "reason": "renamed", "renamed_to": "azure.cosmosdb.response.sub_status_code"} DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code' @@ -257,7 +259,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # e9106fc68e3044f0b1475b04bf4ffd5f + # # e9106fc68e3044f0b1475b04bf4ffd5f # # @deprecated {"note": "Replaced by `db.namespace`.", "reason": "renamed", "renamed_to": "db.namespace"} DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' @@ -267,7 +269,7 @@ module DB # @note Stability Level: development # # @example Sample Values - # instance-0000000001 + # # instance-0000000001 # # @deprecated {"note": "Replaced by `elasticsearch.node.name`.", "reason": "renamed", "renamed_to": "elasticsearch.node.name"} DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' @@ -283,8 +285,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # test-index - # 123 + # # test-index + # # 123 # # @deprecated {"note": "Replaced by `db.operation.parameter`.", "reason": "renamed", "renamed_to": "db.operation.parameter"} DB_ELASTICSEARCH_PATH_PARTS_LAMBDA = ->(key) { "db.elasticsearch.path_parts.#{key}" } @@ -304,8 +306,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # org.postgresql.Driver - # com.microsoft.sqlserver.jdbc.SQLServerDriver + # # org.postgresql.Driver + # # com.microsoft.sqlserver.jdbc.SQLServerDriver # # @deprecated {"note": "Removed, no replacement at this time.\n", "reason": "obsoleted"} DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' @@ -335,8 +337,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # customers - # main + # # customers + # # main # # @deprecated {"note": "Replaced by `db.namespace`.", "reason": "renamed", "renamed_to": "db.namespace"} DB_NAME = 'db.name' @@ -350,8 +352,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # customers - # test.users + # # customers + # # test.users # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_NAMESPACE}. @@ -362,9 +364,9 @@ module DB # @note Stability Level: development # # @example Sample Values - # findAndModify - # HMSET - # SELECT + # # findAndModify + # # HMSET + # # SELECT # # @deprecated {"note": "Replaced by `db.operation.name`.", "reason": "renamed", "renamed_to": "db.operation.name"} DB_OPERATION = 'db.operation' @@ -376,9 +378,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # 2 - # 3 - # 4 + # # 2 + # # 3 + # # 4 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_OPERATION_BATCH_SIZE}. @@ -404,9 +406,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # findAndModify - # HMSET - # SELECT + # # findAndModify + # # HMSET + # # SELECT # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_OPERATION_NAME}. @@ -429,8 +431,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # someval - # 55 + # # someval + # # 55 # DB_OPERATION_PARAMETER_LAMBDA = ->(key) { "db.operation.parameter.#{key}" } @@ -460,8 +462,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # someval - # 55 + # # someval + # # 55 # DB_QUERY_PARAMETER_LAMBDA = ->(key) { "db.query.parameter.#{key}" } @@ -480,9 +482,9 @@ module DB # @note Stability Level: stable # # @example Sample Values - # SELECT wuser_table - # INSERT shipping_details SELECT orders - # get user by id + # # SELECT wuser_table + # # INSERT shipping_details SELECT orders + # # get user by id # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_QUERY_SUMMARY}. @@ -497,8 +499,8 @@ module DB # @note Stability Level: stable # # @example Sample Values - # SELECT * FROM wuser_table where username = ? - # SET mykey ? + # # SELECT * FROM wuser_table where username = ? + # # SET mykey ? # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_QUERY_TEXT}. @@ -509,9 +511,9 @@ module DB # @note Stability Level: development # # @example Sample Values - # 0 - # 1 - # 15 + # # 0 + # # 1 + # # 15 # # @deprecated {"note": "Replaced by `db.namespace`.", "reason": "renamed", "renamed_to": "db.namespace"} DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' @@ -521,9 +523,9 @@ module DB # @note Stability Level: development # # @example Sample Values - # 10 - # 30 - # 1000 + # # 10 + # # 30 + # # 1000 # DB_RESPONSE_RETURNED_ROWS = 'db.response.returned_rows' @@ -535,10 +537,10 @@ module DB # @note Stability Level: stable # # @example Sample Values - # 102 - # ORA-17002 - # 08P01 - # 404 + # # 102 + # # ORA-17002 + # # 08P01 + # # 404 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_RESPONSE_STATUS_CODE}. @@ -559,8 +561,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # SELECT * FROM wuser_table - # SET mykey "WuValue" + # # SELECT * FROM wuser_table + # # SET mykey "WuValue" # # @deprecated {"note": "Replaced by `db.query.text`.", "reason": "renamed", "renamed_to": "db.query.text"} DB_STATEMENT = 'db.statement' @@ -576,7 +578,7 @@ module DB # @note Stability Level: stable # # @example Sample Values - # GetCustomer + # # GetCustomer # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_STORED_PROCEDURE_NAME}. @@ -602,8 +604,8 @@ module DB # @note Stability Level: development # # @example Sample Values - # readonly_user - # reporting_user + # # readonly_user + # # reporting_user # # @deprecated {"note": "Removed, no replacement at this time.", "reason": "obsoleted"} DB_USER = 'db.user' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb index 30df4f2125..638e9f3435 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb @@ -24,47 +24,47 @@ module Incubating module DB # @!group Metrics Names - # The number of connections that are currently in state described by the `state` attribute + # The number of connections that are currently in state described by the `state` attribute. # # @note Stability Level: development DB_CLIENT_CONNECTION_COUNT = 'db.client.connection.count' - # The time it took to create a new connection + # The time it took to create a new connection. # # @note Stability Level: development DB_CLIENT_CONNECTION_CREATE_TIME = 'db.client.connection.create_time' - # The maximum number of idle open connections allowed + # The maximum number of idle open connections allowed. # # @note Stability Level: development DB_CLIENT_CONNECTION_IDLE_MAX = 'db.client.connection.idle.max' - # The minimum number of idle open connections allowed + # The minimum number of idle open connections allowed. # # @note Stability Level: development DB_CLIENT_CONNECTION_IDLE_MIN = 'db.client.connection.idle.min' - # The maximum number of open connections allowed + # The maximum number of open connections allowed. # # @note Stability Level: development DB_CLIENT_CONNECTION_MAX = 'db.client.connection.max' - # The number of current pending requests for an open connection + # The number of current pending requests for an open connection. # # @note Stability Level: development DB_CLIENT_CONNECTION_PENDING_REQUESTS = 'db.client.connection.pending_requests' - # The number of connection timeouts that have occurred trying to obtain a connection from the pool + # The number of connection timeouts that have occurred trying to obtain a connection from the pool. # # @note Stability Level: development DB_CLIENT_CONNECTION_TIMEOUTS = 'db.client.connection.timeouts' - # The time between borrowing a connection and returning it to the pool + # The time between borrowing a connection and returning it to the pool. # # @note Stability Level: development DB_CLIENT_CONNECTION_USE_TIME = 'db.client.connection.use_time' - # The time it took to obtain an open connection from the pool + # The time it took to obtain an open connection from the pool. # # @note Stability Level: development DB_CLIENT_CONNECTION_WAIT_TIME = 'db.client.connection.wait_time' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb index 7e3fdbb7b1..cc618af8e2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb @@ -24,13 +24,13 @@ module Incubating module DEPLOYMENT # @!group Attribute Names - # 'Deprecated, use `deployment.environment.name` instead.' + # Deprecated, use `deployment.environment.name` instead. # # @note Stability Level: development # # @example Sample Values - # staging - # production + # # staging + # # production # # @deprecated {"note": "Replaced by `deployment.environment.name`.", "reason": "renamed", "renamed_to": "deployment.environment.name"} DEPLOYMENT_ENVIRONMENT = 'deployment.environment' @@ -48,8 +48,8 @@ module DEPLOYMENT # @note Stability Level: development # # @example Sample Values - # staging - # production + # # staging + # # production # DEPLOYMENT_ENVIRONMENT_NAME = 'deployment.environment.name' @@ -58,7 +58,7 @@ module DEPLOYMENT # @note Stability Level: development # # @example Sample Values - # 1208 + # # 1208 # DEPLOYMENT_ID = 'deployment.id' @@ -67,8 +67,8 @@ module DEPLOYMENT # @note Stability Level: development # # @example Sample Values - # deploy my app - # deploy-frontend + # # deploy my app + # # deploy-frontend # DEPLOYMENT_NAME = 'deployment.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb index 1ca9f509c8..77b6221712 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb @@ -31,9 +31,9 @@ module DESTINATION # @note Stability Level: development # # @example Sample Values - # destination.example.com - # 10.1.2.80 - # /tmp/my.sock + # # destination.example.com + # # 10.1.2.80 + # # /tmp/my.sock # DESTINATION_ADDRESS = 'destination.address' @@ -42,8 +42,8 @@ module DESTINATION # @note Stability Level: development # # @example Sample Values - # 3389 - # 2888 + # # 3389 + # # 2888 # DESTINATION_PORT = 'destination.port' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb index 53c46cb79d..60f710dca8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb @@ -30,7 +30,7 @@ module DEVICE # However, it might be resettable by the user for all apps on a device. # Hardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be used as values. # - # More information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids). + # More information about Android identifier best practices can be found in the [Android user data IDs guide](https://developer.android.com/training/articles/user-data-ids). # # > [!WARNING]> This attribute may contain sensitive (PII) information. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, # > ensure you do your own due diligence.> Due to these reasons, this identifier is not recommended for consumer applications and will likely result in rejection from both Google Play and App Store. @@ -40,8 +40,8 @@ module DEVICE # @note Stability Level: development # # @example Sample Values - # 123456789012345 - # 01:23:45:67:89:AB + # # 123456789012345 + # # 01:23:45:67:89:AB # DEVICE_ID = 'device.id' @@ -52,8 +52,8 @@ module DEVICE # @note Stability Level: development # # @example Sample Values - # Apple - # Samsung + # # Apple + # # Samsung # DEVICE_MANUFACTURER = 'device.manufacturer' @@ -64,8 +64,8 @@ module DEVICE # @note Stability Level: development # # @example Sample Values - # iPhone3,4 - # SM-G920F + # # iPhone3,4 + # # SM-G920F # DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' @@ -76,8 +76,8 @@ module DEVICE # @note Stability Level: development # # @example Sample Values - # iPhone 6s Plus - # Samsung Galaxy S6 + # # iPhone 6s Plus + # # Samsung Galaxy S6 # DEVICE_MODEL_NAME = 'device.model.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb index 87fb5e538d..f4ad68f1a4 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb @@ -29,7 +29,7 @@ module DISK # @note Stability Level: development # # @example Sample Values - # read + # # read # DISK_IO_DIRECTION = 'disk.io.direction' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb index 75f2dc36e8..446eb04a4e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb @@ -29,8 +29,8 @@ module DNS # @note Stability Level: development # # @example Sample Values - # ["10.0.0.1", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"] - # + # # 10.0.0.1 + # 2001:0db8:85a3:0000:0000:8a2e:0370:7334 DNS_ANSWERS = 'dns.answers' # The name being queried. @@ -40,8 +40,8 @@ module DNS # @note Stability Level: development # # @example Sample Values - # www.example.com - # opentelemetry.io + # # www.example.com + # # opentelemetry.io # DNS_QUESTION_NAME = 'dns.question.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb index 60e1ff407a..7ec88d36a1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb @@ -29,9 +29,9 @@ module DOTNET # @note Stability Level: stable # # @example Sample Values - # gen0 - # gen1 - # gen2 + # # gen0 + # # gen1 + # # gen2 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DOTNET::DOTNET_GC_HEAP_GENERATION}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb index e54e4e130f..1b9039fd0c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb @@ -29,7 +29,7 @@ module ELASTICSEARCH # @note Stability Level: development # # @example Sample Values - # instance-0000000001 + # # instance-0000000001 # ELASTICSEARCH_NODE_NAME = 'elasticsearch.node.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb index bd1c84ddc4..58b701759a 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb @@ -34,7 +34,7 @@ module ENDUSER # @note Stability Level: development # # @example Sample Values - # username + # # username # ENDUSER_ID = 'enduser.id' @@ -48,7 +48,7 @@ module ENDUSER # @note Stability Level: development # # @example Sample Values - # QdH5CAWJgqVT4rOr0qtumf + # # QdH5CAWJgqVT4rOr0qtumf # ENDUSER_PSEUDO_ID = 'enduser.pseudo.id' @@ -59,7 +59,7 @@ module ENDUSER # @example Sample Values # admin # - # @deprecated {"note": "Use `user.roles` attribute instead.", "reason": "uncategorized"} + # @deprecated {"note": "Replaced by `user.roles`.", "reason": "renamed", "renamed_to": "user.roles"} ENDUSER_ROLE = 'enduser.role' # Deprecated, no replacement at this time. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb index ac656d8ef9..ff34d2ceca 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb @@ -35,8 +35,8 @@ module ERROR # @note Stability Level: development # # @example Sample Values - # Unexpected input type: string - # The user has exceeded their storage quota + # # Unexpected input type: string + # # The user has exceeded their storage quota # ERROR_MESSAGE = 'error.message' @@ -65,10 +65,10 @@ module ERROR # @note Stability Level: stable # # @example Sample Values - # timeout - # java.net.UnknownHostException - # server_certificate_invalid - # 500 + # # timeout + # # java.net.UnknownHostException + # # server_certificate_invalid + # # 500 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ERROR::ERROR_TYPE}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb index b0c2f0b687..e116cbc993 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb @@ -29,8 +29,8 @@ module EVENT # @note Stability Level: development # # @example Sample Values - # browser.mouse.click - # device.app.lifecycle + # # browser.mouse.click + # # device.app.lifecycle # # @deprecated {"note": "Replaced by EventName top-level field on the LogRecord.\n", "reason": "uncategorized"} EVENT_NAME = 'event.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb index 5cf992d30c..dd2879965c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb @@ -35,8 +35,8 @@ module EXCEPTION # @note Stability Level: stable # # @example Sample Values - # Division by zero - # Can't convert 'int' object to str implicitly + # # Division by zero + # # Can't convert 'int' object to str implicitly # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_MESSAGE}. @@ -59,8 +59,8 @@ module EXCEPTION # @note Stability Level: stable # # @example Sample Values - # java.net.ConnectException - # OSError + # # java.net.ConnectException + # # OSError # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_TYPE}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb index fe171fd482..25ee56ce1e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb @@ -43,8 +43,8 @@ module FAAS # @note Stability Level: development # # @example Sample Values - # myBucketName - # myDbName + # # myBucketName + # # myDbName # FAAS_DOCUMENT_COLLECTION = 'faas.document.collection' @@ -53,8 +53,8 @@ module FAAS # @note Stability Level: development # # @example Sample Values - # myFile.txt - # myTableName + # # myFile.txt + # # myTableName # FAAS_DOCUMENT_NAME = 'faas.document.name' @@ -79,7 +79,7 @@ module FAAS # @note Stability Level: development # # @example Sample Values - # 2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de + # # 2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de # FAAS_INSTANCE = 'faas.instance' @@ -154,8 +154,8 @@ module FAAS # @note Stability Level: development # # @example Sample Values - # my-function - # myazurefunctionapp/some-function-name + # # my-function + # # myazurefunctionapp/some-function-name # FAAS_NAME = 'faas.name' @@ -188,8 +188,8 @@ module FAAS # @note Stability Level: development # # @example Sample Values - # 26 - # pinkfroid-00002 + # # 26 + # # pinkfroid-00002 # FAAS_VERSION = 'faas.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb index 9f3577da08..1b568955c1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb @@ -24,47 +24,47 @@ module Incubating module FAAS # @!group Metrics Names - # Number of invocation cold starts + # Number of invocation cold starts. # # @note Stability Level: development FAAS_COLDSTARTS = 'faas.coldstarts' - # Distribution of CPU usage per invocation + # Distribution of CPU usage per invocation. # # @note Stability Level: development FAAS_CPU_USAGE = 'faas.cpu_usage' - # Number of invocation errors + # Number of invocation errors. # # @note Stability Level: development FAAS_ERRORS = 'faas.errors' - # Measures the duration of the function's initialization, such as a cold start + # Measures the duration of the function's initialization, such as a cold start. # # @note Stability Level: development FAAS_INIT_DURATION = 'faas.init_duration' - # Number of successful invocations + # Number of successful invocations. # # @note Stability Level: development FAAS_INVOCATIONS = 'faas.invocations' - # Measures the duration of the function's logic execution + # Measures the duration of the function's logic execution. # # @note Stability Level: development FAAS_INVOKE_DURATION = 'faas.invoke_duration' - # Distribution of max memory usage per invocation + # Distribution of max memory usage per invocation. # # @note Stability Level: development FAAS_MEM_USAGE = 'faas.mem_usage' - # Distribution of net I/O usage per invocation + # Distribution of net I/O usage per invocation. # # @note Stability Level: development FAAS_NET_IO = 'faas.net_io' - # Number of invocation timeouts + # Number of invocation timeouts. # # @note Stability Level: development FAAS_TIMEOUTS = 'faas.timeouts' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb index 6358612057..8f7b3da4f5 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb @@ -29,7 +29,7 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # 5157782b-2203-4c80-a857-dbbd5e7761db + # # 5157782b-2203-4c80-a857-dbbd5e7761db # FEATURE_FLAG_CONTEXT_ID = 'feature_flag.context.id' @@ -38,7 +38,7 @@ module FEATURE_FLAG # @note Stability Level: development # # @example Sample Values - # Flag `header-color` expected type `string` but found type `number` + # # Flag `header-color` expected type `string` but found type `number` # # @deprecated {"note": "Replaced by `error.message`.", "reason": "renamed", "renamed_to": "error.message"} FEATURE_FLAG_EVALUATION_ERROR_MESSAGE = 'feature_flag.evaluation.error.message' @@ -48,10 +48,10 @@ module FEATURE_FLAG # @note Stability Level: development # # @example Sample Values - # static - # targeting_match - # error - # default + # # static + # # targeting_match + # # error + # # default # # @deprecated {"note": "Replaced by `feature_flag.result.reason`.", "reason": "renamed", "renamed_to": "feature_flag.result.reason"} FEATURE_FLAG_EVALUATION_REASON = 'feature_flag.evaluation.reason' @@ -61,7 +61,7 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # logo-color + # # logo-color # FEATURE_FLAG_KEY = 'feature_flag.key' @@ -70,7 +70,7 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # Flag Manager + # # Flag Manager # FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider.name' @@ -79,10 +79,10 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # static - # targeting_match - # error - # default + # # static + # # targeting_match + # # error + # # default # FEATURE_FLAG_RESULT_REASON = 'feature_flag.result.reason' @@ -97,9 +97,9 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # #ff0000 - # true - # 3 + # # #ff0000 + # # true + # # 3 # FEATURE_FLAG_RESULT_VALUE = 'feature_flag.result.value' @@ -113,9 +113,9 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # red - # true - # on + # # red + # # true + # # on # FEATURE_FLAG_RESULT_VARIANT = 'feature_flag.result.variant' @@ -124,9 +124,9 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # proj-1 - # ab98sgs - # service1/dev + # # proj-1 + # # ab98sgs + # # service1/dev # FEATURE_FLAG_SET_ID = 'feature_flag.set.id' @@ -135,9 +135,9 @@ module FEATURE_FLAG # @note Stability Level: development # # @example Sample Values - # red - # true - # on + # # red + # # true + # # on # # @deprecated {"note": "Replaced by `feature_flag.result.variant`.", "reason": "renamed", "renamed_to": "feature_flag.result.variant"} FEATURE_FLAG_VARIANT = 'feature_flag.variant' @@ -147,8 +147,8 @@ module FEATURE_FLAG # @note Stability Level: release_candidate # # @example Sample Values - # 1 - # 01ABCDEF + # # 1 + # # 01ABCDEF # FEATURE_FLAG_VERSION = 'feature_flag.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb index e87537719e..b7ab1e70fc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb @@ -31,7 +31,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 2021-01-01T12:00:00Z + # # 2021-01-01T12:00:00Z # FILE_ACCESSED = 'file.accessed' @@ -42,8 +42,8 @@ module FILE # @note Stability Level: development # # @example Sample Values - # ["readonly", "hidden"] - # + # # readonly + # hidden FILE_ATTRIBUTES = 'file.attributes' # Time when the file attributes or metadata was last changed, in ISO 8601 format. @@ -53,7 +53,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 2021-01-01T12:00:00Z + # # 2021-01-01T12:00:00Z # FILE_CHANGED = 'file.changed' @@ -64,7 +64,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 2021-01-01T12:00:00Z + # # 2021-01-01T12:00:00Z # FILE_CREATED = 'file.created' @@ -73,8 +73,8 @@ module FILE # @note Stability Level: development # # @example Sample Values - # /home/user - # C:\Program Files\MyApp + # # /home/user + # # C:\Program Files\MyApp # FILE_DIRECTORY = 'file.directory' @@ -85,8 +85,8 @@ module FILE # @note Stability Level: development # # @example Sample Values - # png - # gz + # # png + # # gz # FILE_EXTENSION = 'file.extension' @@ -98,7 +98,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # Zone.Identifer + # # Zone.Identifier # FILE_FORK_NAME = 'file.fork_name' @@ -107,7 +107,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 1000 + # # 1000 # FILE_GROUP_ID = 'file.group.id' @@ -116,7 +116,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # users + # # users # FILE_GROUP_NAME = 'file.group.name' @@ -125,7 +125,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 256383 + # # 256383 # FILE_INODE = 'file.inode' @@ -134,7 +134,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 0640 + # # 0640 # FILE_MODE = 'file.mode' @@ -143,7 +143,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 2021-01-01T12:00:00Z + # # 2021-01-01T12:00:00Z # FILE_MODIFIED = 'file.modified' @@ -152,7 +152,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # example.png + # # example.png # FILE_NAME = 'file.name' @@ -161,7 +161,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # 1000 + # # 1000 # FILE_OWNER_ID = 'file.owner.id' @@ -170,7 +170,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # root + # # root # FILE_OWNER_NAME = 'file.owner.name' @@ -179,8 +179,8 @@ module FILE # @note Stability Level: development # # @example Sample Values - # /home/alice/example.png - # C:\Program Files\MyApp\myapp.exe + # # /home/alice/example.png + # # C:\Program Files\MyApp\myapp.exe # FILE_PATH = 'file.path' @@ -196,7 +196,7 @@ module FILE # @note Stability Level: development # # @example Sample Values - # /usr/bin/python3 + # # /usr/bin/python3 # FILE_SYMBOLIC_LINK_TARGET_PATH = 'file.symbolic_link.target_path' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb index 23f6245b10..0fcb2dc676 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb @@ -29,7 +29,7 @@ module GCP # @note Stability Level: development # # @example Sample Values - # projects/my-container-project + # # projects/my-container-project # GCP_APPHUB_APPLICATION_CONTAINER = 'gcp.apphub.application.container' @@ -38,7 +38,7 @@ module GCP # @note Stability Level: development # # @example Sample Values - # my-application + # # my-application # GCP_APPHUB_APPLICATION_ID = 'gcp.apphub.application.id' @@ -47,7 +47,7 @@ module GCP # @note Stability Level: development # # @example Sample Values - # us-central1 + # # us-central1 # GCP_APPHUB_APPLICATION_LOCATION = 'gcp.apphub.application.location' @@ -70,7 +70,7 @@ module GCP # @note Stability Level: development # # @example Sample Values - # my-service + # # my-service # GCP_APPHUB_SERVICE_ID = 'gcp.apphub.service.id' @@ -93,7 +93,7 @@ module GCP # @note Stability Level: development # # @example Sample Values - # my-workload + # # my-workload # GCP_APPHUB_WORKLOAD_ID = 'gcp.apphub.workload.id' @@ -104,11 +104,11 @@ module GCP # @note Stability Level: development # # @example Sample Values - # appengine - # run - # firestore - # alloydb - # spanner + # # appengine + # # run + # # firestore + # # alloydb + # # spanner # GCP_CLIENT_SERVICE = 'gcp.client.service' @@ -117,8 +117,8 @@ module GCP # @note Stability Level: development # # @example Sample Values - # job-name-xxxx - # sample-job-mdw84 + # # job-name-xxxx + # # sample-job-mdw84 # GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution' @@ -127,8 +127,8 @@ module GCP # @note Stability Level: development # # @example Sample Values - # 0 - # 1 + # # 0 + # # 1 # GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index' @@ -137,8 +137,8 @@ module GCP # @note Stability Level: development # # @example Sample Values - # my-host1234.example.com - # sample-vm.us-west1-b.c.my-project.internal + # # my-host1234.example.com + # # sample-vm.us-west1-b.c.my-project.internal # GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname' @@ -147,8 +147,8 @@ module GCP # @note Stability Level: development # # @example Sample Values - # instance-1 - # my-vm-name + # # instance-1 + # # my-vm-name # GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb index c925272227..dd0b2ae5c6 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb @@ -29,8 +29,8 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # Helps with math problems - # Generates fiction stories + # # Helps with math problems + # # Generates fiction stories # GEN_AI_AGENT_DESCRIPTION = 'gen_ai.agent.description' @@ -39,7 +39,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # asst_5j66UpCpwteGg4YSxUnt7lPY + # # asst_5j66UpCpwteGg4YSxUnt7lPY # GEN_AI_AGENT_ID = 'gen_ai.agent.id' @@ -48,8 +48,8 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # Math Tutor - # Fiction Writer + # # Math Tutor + # # Fiction Writer # GEN_AI_AGENT_NAME = 'gen_ai.agent.name' @@ -58,7 +58,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # [{'role': 'assistant', 'content': 'The capital of France is Paris.'}] + # # [{'role': 'assistant', 'content': 'The capital of France is Paris.'}] # # @deprecated {"note": "Removed, no replacement at this time.", "reason": "obsoleted"} GEN_AI_COMPLETION = 'gen_ai.completion' @@ -68,7 +68,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # conv_5j66UpCpwteGg4YSxUnt7lPY + # # conv_5j66UpCpwteGg4YSxUnt7lPY # GEN_AI_CONVERSATION_ID = 'gen_ai.conversation.id' @@ -79,10 +79,66 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # H7STPQYOND + # # H7STPQYOND # GEN_AI_DATA_SOURCE_ID = 'gen_ai.data_source.id' + # The chat history provided to the model as an input. + # + # Instrumentations MUST follow [Input messages JSON schema](/docs/gen-ai/gen-ai-input-messages.json). + # When the attribute is recorded on events, it MUST be recorded in structured + # form. When recorded on spans, it MAY be recorded as a JSON string if structured + # format is not supported and SHOULD be recorded in structured form otherwise. + # + # Messages MUST be provided in the order they were sent to the model. + # Instrumentations MAY provide a way for users to filter or truncate + # input messages. + # + # > [!Warning] + # > This attribute is likely to contain sensitive information including user/PII data. + # + # See [Recording content on attributes](/docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes) + # section for more details. + # + # @note Stability Level: development + # + # @example Sample Values + # # [ + # { + # "role": "user", + # "parts": [ + # { + # "type": "text", + # "content": "Weather in Paris?" + # } + # ] + # }, + # { + # "role": "assistant", + # "parts": [ + # { + # "type": "tool_call", + # "id": "call_VSPygqKTWdrhaFErNvMV18Yl", + # "name": "get_weather", + # "arguments": { + # "location": "Paris" + # } + # } + # ] + # }, + # { + # "role": "tool", + # "parts": [ + # { + # "type": "tool_call_response", + # "id": " call_VSPygqKTWdrhaFErNvMV18Yl", + # "result": "rainy, 57°F" + # } + # ] + # } + # ] + GEN_AI_INPUT_MESSAGES = 'gen_ai.input.messages' + # Deprecated, use `gen_ai.output.type`. # # @note Stability Level: development @@ -94,38 +150,36 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 100 + # # 100 # # @deprecated {"note": "Replaced by `gen_ai.request.seed`.", "reason": "renamed", "renamed_to": "gen_ai.request.seed"} GEN_AI_OPENAI_REQUEST_SEED = 'gen_ai.openai.request.seed' - # The service tier requested. May be a specific tier, default, or auto. + # Deprecated, use `openai.request.service_tier`. # # @note Stability Level: development - # - # @example Sample Values - # auto - # default - # + # @deprecated {"note": "Replaced by `openai.request.service_tier`.", "reason": "renamed", "renamed_to": "openai.request.service_tier"} GEN_AI_OPENAI_REQUEST_SERVICE_TIER = 'gen_ai.openai.request.service_tier' - # The service tier used for the response. + # Deprecated, use `openai.response.service_tier`. # # @note Stability Level: development # # @example Sample Values - # scale - # default + # # scale + # # default # + # @deprecated {"note": "Replaced by `openai.response.service_tier`.", "reason": "renamed", "renamed_to": "openai.response.service_tier"} GEN_AI_OPENAI_RESPONSE_SERVICE_TIER = 'gen_ai.openai.response.service_tier' - # A fingerprint to track any eventual change in the Generative AI environment. + # Deprecated, use `openai.response.system_fingerprint`. # # @note Stability Level: development # # @example Sample Values - # fp_44709d6fcb + # # fp_44709d6fcb # + # @deprecated {"note": "Replaced by `openai.response.system_fingerprint`.", "reason": "renamed", "renamed_to": "openai.response.system_fingerprint"} GEN_AI_OPENAI_RESPONSE_SYSTEM_FINGERPRINT = 'gen_ai.openai.response.system_fingerprint' # The name of the operation being performed. @@ -135,6 +189,45 @@ module GEN_AI # @note Stability Level: development GEN_AI_OPERATION_NAME = 'gen_ai.operation.name' + # Messages returned by the model where each message represents a specific model response (choice, candidate). + # + # Instrumentations MUST follow [Output messages JSON schema](/docs/gen-ai/gen-ai-output-messages.json) + # + # Each message represents a single output choice/candidate generated by + # the model. Each message corresponds to exactly one generation + # (choice/candidate) and vice versa - one choice cannot be split across + # multiple messages or one message cannot contain parts from multiple choices. + # + # When the attribute is recorded on events, it MUST be recorded in structured + # form. When recorded on spans, it MAY be recorded as a JSON string if structured + # format is not supported and SHOULD be recorded in structured form otherwise. + # + # Instrumentations MAY provide a way for users to filter or truncate + # output messages. + # + # > [!Warning] + # > This attribute is likely to contain sensitive information including user/PII data. + # + # See [Recording content on attributes](/docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes) + # section for more details. + # + # @note Stability Level: development + # + # @example Sample Values + # # [ + # { + # "role": "assistant", + # "parts": [ + # { + # "type": "text", + # "content": "The weather in Paris is currently rainy with a temperature of 57°F." + # } + # ], + # "finish_reason": "stop" + # } + # ] + GEN_AI_OUTPUT_MESSAGES = 'gen_ai.output.messages' + # Represents the content type requested by the client. # # This attribute SHOULD be used when the client requests output of a specific type. The model may return zero or more outputs of this type. @@ -149,17 +242,41 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # [{'role': 'user', 'content': 'What is the capital of France?'}] + # # [{'role': 'user', 'content': 'What is the capital of France?'}] # # @deprecated {"note": "Removed, no replacement at this time.", "reason": "obsoleted"} GEN_AI_PROMPT = 'gen_ai.prompt' + # The Generative AI provider as identified by the client or server instrumentation. + # + # The attribute SHOULD be set based on the instrumentation's best + # knowledge and may differ from the actual model provider. + # + # Multiple providers, including Azure OpenAI, Gemini, and AI hosting platforms + # are accessible using the OpenAI REST API and corresponding client libraries, + # but may proxy or host models from different providers. + # + # The `gen_ai.request.model`, `gen_ai.response.model`, and `server.address` + # attributes may help identify the actual system in use. + # + # The `gen_ai.provider.name` attribute acts as a discriminator that + # identifies the GenAI telemetry format flavor specific to that provider + # within GenAI semantic conventions. + # It SHOULD be set consistently with provider-specific attributes and signals. + # For example, GenAI spans, metrics, and events related to AWS Bedrock + # should have the `gen_ai.provider.name` set to `aws.bedrock` and include + # applicable `aws.bedrock.*` attributes and are not expected to include + # `openai.*` attributes. + # + # @note Stability Level: development + GEN_AI_PROVIDER_NAME = 'gen_ai.provider.name' + # The target number of candidate completions to return. # # @note Stability Level: development # # @example Sample Values - # 3 + # # 3 # GEN_AI_REQUEST_CHOICE_COUNT = 'gen_ai.request.choice.count' @@ -170,9 +287,9 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # ["base64"] - # ["float", "binary"] - # + # # base64 + # # float + # binary GEN_AI_REQUEST_ENCODING_FORMATS = 'gen_ai.request.encoding_formats' # The frequency penalty setting for the GenAI request. @@ -180,7 +297,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 0.1 + # # 0.1 # GEN_AI_REQUEST_FREQUENCY_PENALTY = 'gen_ai.request.frequency_penalty' @@ -189,7 +306,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 100 + # # 100 # GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens' @@ -207,7 +324,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 0.1 + # # 0.1 # GEN_AI_REQUEST_PRESENCE_PENALTY = 'gen_ai.request.presence_penalty' @@ -216,7 +333,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 100 + # # 100 # GEN_AI_REQUEST_SEED = 'gen_ai.request.seed' @@ -225,8 +342,8 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # ["forest", "lived"] - # + # # forest + # lived GEN_AI_REQUEST_STOP_SEQUENCES = 'gen_ai.request.stop_sequences' # The temperature setting for the GenAI request. @@ -234,7 +351,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 0.0 + # # 0.0 # GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature' @@ -243,7 +360,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 1.0 + # # 1.0 # GEN_AI_REQUEST_TOP_K = 'gen_ai.request.top_k' @@ -252,7 +369,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 1.0 + # # 1.0 # GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p' @@ -261,9 +378,9 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # ["stop"] - # ["stop", "length"] - # + # # stop + # # stop + # length GEN_AI_RESPONSE_FINISH_REASONS = 'gen_ai.response.finish_reasons' # The unique identifier for the completion. @@ -271,7 +388,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # chatcmpl-123 + # # chatcmpl-123 # GEN_AI_RESPONSE_ID = 'gen_ai.response.id' @@ -280,38 +397,67 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # gpt-4-0613 + # # gpt-4-0613 # GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model' - # The Generative AI product as identified by the client or server instrumentation. + # Deprecated, use `gen_ai.provider.name` instead. # - # The `gen_ai.system` describes a family of GenAI models with specific model identified - # by `gen_ai.request.model` and `gen_ai.response.model` attributes. + # @note Stability Level: development + # @deprecated {"note": "Replaced by `gen_ai.provider.name`.", "reason": "renamed", "renamed_to": "gen_ai.provider.name"} + GEN_AI_SYSTEM = 'gen_ai.system' + + # The system message or instructions provided to the GenAI model separately from the chat history. + # + # This attribute SHOULD be used when the corresponding provider or API + # allows to provide system instructions or messages separately from the + # chat history. + # + # Instructions that are part of the chat history SHOULD be recorded in + # `gen_ai.input.messages` attribute instead. + # + # Instrumentations MUST follow [System instructions JSON schema](/docs/gen-ai/gen-ai-system-instructions.json). # - # The actual GenAI product may differ from the one identified by the client. - # Multiple systems, including Azure OpenAI and Gemini, are accessible by OpenAI client - # libraries. In such cases, the `gen_ai.system` is set to `openai` based on the - # instrumentation's best knowledge, instead of the actual system. The `server.address` - # attribute may help identify the actual system in use for `openai`. + # When recorded on spans, it MAY be recorded as a JSON string if structured + # format is not supported and SHOULD be recorded in structured form otherwise. # - # For custom model, a custom friendly name SHOULD be used. - # If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. + # Instrumentations MAY provide a way for users to filter or truncate + # system instructions. + # + # > [!Warning] + # > This attribute may contain sensitive information. + # + # See [Recording content on attributes](/docs/gen-ai/gen-ai-spans.md#recording-content-on-attributes) + # section for more details. # # @note Stability Level: development # # @example Sample Values - # openai - # - GEN_AI_SYSTEM = 'gen_ai.system' + # # [ + # { + # "type": "text", + # "content": "You are an Agent that greet users, always use greetings tool to respond" + # } + # ] + # # [ + # { + # "type": "text", + # "content": "You are a language translator." + # }, + # { + # "type": "text", + # "content": "Your mission is to translate text in English to French." + # } + # ] + GEN_AI_SYSTEM_INSTRUCTIONS = 'gen_ai.system_instructions' # The type of token being counted. # # @note Stability Level: development # # @example Sample Values - # input - # output + # # input + # # output # GEN_AI_TOKEN_TYPE = 'gen_ai.token.type' @@ -320,7 +466,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # call_mszuSIzqtI65i1wAUOE8w5H4 + # # call_mszuSIzqtI65i1wAUOE8w5H4 # GEN_AI_TOOL_CALL_ID = 'gen_ai.tool.call.id' @@ -329,7 +475,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # Multiply two numbers + # # Multiply two numbers # GEN_AI_TOOL_DESCRIPTION = 'gen_ai.tool.description' @@ -338,7 +484,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # Flights + # # Flights # GEN_AI_TOOL_NAME = 'gen_ai.tool.name' @@ -353,9 +499,9 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # function - # extension - # datastore + # # function + # # extension + # # datastore # GEN_AI_TOOL_TYPE = 'gen_ai.tool.type' @@ -364,7 +510,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 42 + # # 42 # # @deprecated {"note": "Replaced by `gen_ai.usage.output_tokens`.", "reason": "renamed", "renamed_to": "gen_ai.usage.output_tokens"} GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.completion_tokens' @@ -374,7 +520,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 100 + # # 100 # GEN_AI_USAGE_INPUT_TOKENS = 'gen_ai.usage.input_tokens' @@ -383,7 +529,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 180 + # # 180 # GEN_AI_USAGE_OUTPUT_TOKENS = 'gen_ai.usage.output_tokens' @@ -392,7 +538,7 @@ module GEN_AI # @note Stability Level: development # # @example Sample Values - # 42 + # # 42 # # @deprecated {"note": "Replaced by `gen_ai.usage.input_tokens`.", "reason": "renamed", "renamed_to": "gen_ai.usage.input_tokens"} GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.prompt_tokens' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb index 98d20cf316..ad3e301189 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb @@ -24,27 +24,27 @@ module Incubating module GEN_AI # @!group Metrics Names - # GenAI operation duration + # GenAI operation duration. # # @note Stability Level: development GEN_AI_CLIENT_OPERATION_DURATION = 'gen_ai.client.operation.duration' - # Measures number of input and output tokens used + # Number of input and output tokens used. # # @note Stability Level: development GEN_AI_CLIENT_TOKEN_USAGE = 'gen_ai.client.token.usage' - # Generative AI server request duration such as time-to-last byte or last output token + # Generative AI server request duration such as time-to-last byte or last output token. # # @note Stability Level: development GEN_AI_SERVER_REQUEST_DURATION = 'gen_ai.server.request.duration' - # Time per output token generated after the first token for successful responses + # Time per output token generated after the first token for successful responses. # # @note Stability Level: development GEN_AI_SERVER_TIME_PER_OUTPUT_TOKEN = 'gen_ai.server.time_per_output_token' - # Time to generate first token for successful responses + # Time to generate first token for successful responses. # # @note Stability Level: development GEN_AI_SERVER_TIME_TO_FIRST_TOKEN = 'gen_ai.server.time_to_first_token' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/geo/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/geo/attributes.rb index 7c48ea92d1..fa195dbbc1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/geo/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/geo/attributes.rb @@ -34,7 +34,7 @@ module GEO # @note Stability Level: development # # @example Sample Values - # CA + # # CA # GEO_COUNTRY_ISO_CODE = 'geo.country.iso_code' @@ -43,8 +43,8 @@ module GEO # @note Stability Level: development # # @example Sample Values - # Montreal - # Berlin + # # Montreal + # # Berlin # GEO_LOCALITY_NAME = 'geo.locality.name' @@ -53,7 +53,7 @@ module GEO # @note Stability Level: development # # @example Sample Values - # 45.505918 + # # 45.505918 # GEO_LOCATION_LAT = 'geo.location.lat' @@ -62,7 +62,7 @@ module GEO # @note Stability Level: development # # @example Sample Values - # -73.61483 + # # -73.61483 # GEO_LOCATION_LON = 'geo.location.lon' @@ -71,7 +71,7 @@ module GEO # @note Stability Level: development # # @example Sample Values - # 94040 + # # 94040 # GEO_POSTAL_CODE = 'geo.postal_code' @@ -80,7 +80,7 @@ module GEO # @note Stability Level: development # # @example Sample Values - # CA-QC + # # CA-QC # GEO_REGION_ISO_CODE = 'geo.region.iso_code' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/go/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/go/attributes.rb index 430aaf1399..c11f2b9eec 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/go/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/go/attributes.rb @@ -29,8 +29,8 @@ module GO # @note Stability Level: development # # @example Sample Values - # other - # stack + # # other + # # stack # GO_MEMORY_TYPE = 'go.memory.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb index 3696a513ef..1e9c397168 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb @@ -49,9 +49,9 @@ module GRAPHQL # @note Stability Level: development # # @example Sample Values - # query - # mutation - # subscription + # # query + # # mutation + # # subscription # GRAPHQL_OPERATION_TYPE = 'graphql.operation.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb index fa5eedf5f0..d85c958595 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb @@ -29,7 +29,7 @@ module HEROKU # @note Stability Level: development # # @example Sample Values - # 2daa2797-e42b-4624-9322-ec3f968df4da + # # 2daa2797-e42b-4624-9322-ec3f968df4da # HEROKU_APP_ID = 'heroku.app.id' @@ -38,7 +38,7 @@ module HEROKU # @note Stability Level: development # # @example Sample Values - # e6134959463efd8966b20e75b913cafe3f5ec + # # e6134959463efd8966b20e75b913cafe3f5ec # HEROKU_RELEASE_COMMIT = 'heroku.release.commit' @@ -47,7 +47,7 @@ module HEROKU # @note Stability Level: development # # @example Sample Values - # 2022-10-23T18:00:42Z + # # 2022-10-23T18:00:42Z # HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb index 761b7d5993..0f049ead03 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb @@ -34,7 +34,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 12288000 + # # 12288000 # HOST_CPU_CACHE_L2_SIZE = 'host.cpu.cache.l2.size' @@ -43,8 +43,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 6 - # PA-RISC 1.1e + # # 6 + # # PA-RISC 1.1e # HOST_CPU_FAMILY = 'host.cpu.family' @@ -53,8 +53,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 6 - # 9000/778/B180L + # # 6 + # # 9000/778/B180L # HOST_CPU_MODEL_ID = 'host.cpu.model.id' @@ -63,7 +63,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz + # # 11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz # HOST_CPU_MODEL_NAME = 'host.cpu.model.name' @@ -72,8 +72,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 1 - # r1p1 + # # 1 + # # r1p1 # HOST_CPU_STEPPING = 'host.cpu.stepping' @@ -84,7 +84,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # GenuineIntel + # # GenuineIntel # HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id' @@ -93,7 +93,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # fdbf79e8af94cb7f9e8df36789187052 + # # fdbf79e8af94cb7f9e8df36789187052 # HOST_ID = 'host.id' @@ -102,7 +102,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # ami-07b06b442921831e5 + # # ami-07b06b442921831e5 # HOST_IMAGE_ID = 'host.image.id' @@ -111,8 +111,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # infra-ami-eks-worker-node-7d4ec78312 - # CentOS-8-x86_64-1905 + # # infra-ami-eks-worker-node-7d4ec78312 + # # CentOS-8-x86_64-1905 # HOST_IMAGE_NAME = 'host.image.name' @@ -121,7 +121,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # 0.1 + # # 0.1 # HOST_IMAGE_VERSION = 'host.image.version' @@ -132,8 +132,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # ["192.168.1.140", "fe80::abc2:4a28:737a:609e"] - # + # # 192.168.1.140 + # fe80::abc2:4a28:737a:609e HOST_IP = 'host.ip' # Available MAC addresses of the host, excluding loopback interfaces. @@ -143,8 +143,8 @@ module HOST # @note Stability Level: development # # @example Sample Values - # ["AC-DE-48-23-45-67", "AC-DE-48-23-45-67-01-9F"] - # + # # AC-DE-48-23-45-67 + # AC-DE-48-23-45-67-01-9F HOST_MAC = 'host.mac' # Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user. @@ -152,7 +152,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # opentelemetry-test + # # opentelemetry-test # HOST_NAME = 'host.name' @@ -161,7 +161,7 @@ module HOST # @note Stability Level: development # # @example Sample Values - # n1-standard-1 + # # n1-standard-1 # HOST_TYPE = 'host.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb index 4f4ac62bfd..b3c81a9aa3 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb @@ -39,8 +39,8 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # active - # idle + # # active + # # idle # HTTP_CONNECTION_STATE = 'http.connection.state' @@ -55,7 +55,7 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # www.example.org + # # www.example.org # # @deprecated {"note": "Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage.\n", "reason": "uncategorized"} HTTP_HOST = 'http.host' @@ -65,9 +65,9 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # GET - # POST - # HEAD + # # GET + # # POST + # # HEAD # # @deprecated {"note": "Replaced by `http.request.method`.", "reason": "renamed", "renamed_to": "http.request.method"} HTTP_METHOD = 'http.method' @@ -109,8 +109,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # ["application/json"] - # ["1.2.3.4", "1.2.3.5"] + # # application/json + # # 1.2.3.4 + # 1.2.3.5 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_HEADER_LAMBDA}. @@ -136,9 +137,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # GET - # POST - # HEAD + # # GET + # # POST + # # HEAD # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD}. @@ -149,9 +150,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # GeT - # ACL - # foo + # # GeT + # # ACL + # # foo # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. @@ -235,8 +236,9 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # ["application/json"] - # ["abc", "def"] + # # application/json + # # abc + # def # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_HEADER_LAMBDA}. @@ -256,7 +258,7 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # 200 + # # 200 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_STATUS_CODE}. @@ -290,8 +292,8 @@ module HTTP # @note Stability Level: stable # # @example Sample Values - # /users/:userID? - # {controller}/{action}/{id?} + # # /users/:userID? + # # {controller}/{action}/{id?} # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_ROUTE}. @@ -302,8 +304,8 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # http - # https + # # http + # # https # # @deprecated {"note": "Replaced by `url.scheme`.", "reason": "renamed", "renamed_to": "url.scheme"} HTTP_SCHEME = 'http.scheme' @@ -313,7 +315,7 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # example.com + # # example.com # # @deprecated {"note": "Replaced by `server.address`.", "reason": "renamed", "renamed_to": "server.address"} HTTP_SERVER_NAME = 'http.server_name' @@ -323,7 +325,7 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # 200 + # # 200 # # @deprecated {"note": "Replaced by `http.response.status_code`.", "reason": "renamed", "renamed_to": "http.response.status_code"} HTTP_STATUS_CODE = 'http.status_code' @@ -333,7 +335,7 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # /search?q=OpenTelemetry#SemConv + # # /search?q=OpenTelemetry#SemConv # # @deprecated {"note": "Split to `url.path` and `url.query`.", "reason": "obsoleted"} HTTP_TARGET = 'http.target' @@ -343,7 +345,7 @@ module HTTP # @note Stability Level: development # # @example Sample Values - # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # # https://www.foo.bar/search?q=OpenTelemetry#SemConv # # @deprecated {"note": "Replaced by `url.full`.", "reason": "renamed", "renamed_to": "url.full"} HTTP_URL = 'http.url' @@ -353,8 +355,8 @@ module HTTP # @note Stability Level: development # # @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 + # # 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 # # @deprecated {"note": "Replaced by `user_agent.original`.", "reason": "renamed", "renamed_to": "user_agent.original"} HTTP_USER_AGENT = 'http.user_agent' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/attributes.rb index b3cf480527..0b587dde53 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/attributes.rb @@ -24,38 +24,225 @@ module Incubating module HW # @!group Attribute Names + # Design capacity in Watts-hours or Amper-hours + # + # @note Stability Level: development + # + # @example Sample Values + # # 9.3Ah + # # 50Wh + # + HW_BATTERY_CAPACITY = 'hw.battery.capacity' + + # Battery [chemistry](https://schemas.dmtf.org/wbem/cim-html/2.31.0/CIM_Battery.html), e.g. Lithium-Ion, Nickel-Cadmium, etc. + # + # @note Stability Level: development + # + # @example Sample Values + # # Li-ion + # # NiMH + # + HW_BATTERY_CHEMISTRY = 'hw.battery.chemistry' + + # The current state of the battery + # + # @note Stability Level: development + HW_BATTERY_STATE = 'hw.battery.state' + + # BIOS version of the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # 1.2.3 + # + HW_BIOS_VERSION = 'hw.bios_version' + + # Driver version for the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # 10.2.1-3 + # + HW_DRIVER_VERSION = 'hw.driver_version' + + # Type of the enclosure (useful for modular systems) + # + # @note Stability Level: development + # + # @example Sample Values + # # Computer + # # Storage + # # Switch + # + HW_ENCLOSURE_TYPE = 'hw.enclosure.type' + + # Firmware version of the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # 2.0.1 + # + HW_FIRMWARE_VERSION = 'hw.firmware_version' + + # Type of task the GPU is performing + # + # @note Stability Level: development + HW_GPU_TASK = 'hw.gpu.task' + # An identifier for the hardware component, unique within the monitored host # # @note Stability Level: development # # @example Sample Values - # win32battery_battery_testsysa33_1 + # # win32battery_battery_testsysa33_1 # HW_ID = 'hw.id' + # Type of limit for hardware components + # + # @note Stability Level: development + HW_LIMIT_TYPE = 'hw.limit_type' + + # RAID Level of the logical disk + # + # @note Stability Level: development + # + # @example Sample Values + # # RAID0+1 + # # RAID5 + # # RAID10 + # + HW_LOGICAL_DISK_RAID_LEVEL = 'hw.logical_disk.raid_level' + + # State of the logical disk space usage + # + # @note Stability Level: development + HW_LOGICAL_DISK_STATE = 'hw.logical_disk.state' + + # Type of the memory module + # + # @note Stability Level: development + # + # @example Sample Values + # # DDR4 + # # DDR5 + # # LPDDR5 + # + HW_MEMORY_TYPE = 'hw.memory.type' + + # Descriptive model name of the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # PERC H740P + # # Intel(R) Core(TM) i7-10700K + # # Dell XPS 15 Battery + # + HW_MODEL = 'hw.model' + # An easily-recognizable name for the hardware component # # @note Stability Level: development # # @example Sample Values - # eth0 + # # eth0 # HW_NAME = 'hw.name' + # Logical addresses of the adapter (e.g. IP address, or WWPN) + # + # @note Stability Level: development + # + # @example Sample Values + # # 172.16.8.21 + # 57.11.193.42 + HW_NETWORK_LOGICAL_ADDRESSES = 'hw.network.logical_addresses' + + # Physical address of the adapter (e.g. MAC address, or WWNN) + # + # @note Stability Level: development + # + # @example Sample Values + # # 00-90-F5-E9-7B-36 + # + HW_NETWORK_PHYSICAL_ADDRESS = 'hw.network.physical_address' + # Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) # # @note Stability Level: development # # @example Sample Values - # dellStorage_perc_0 + # # dellStorage_perc_0 # HW_PARENT = 'hw.parent' + # [S.M.A.R.T.](https://wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis, and Reporting Technology) attribute of the physical disk + # + # @note Stability Level: development + # + # @example Sample Values + # # Spin Retry Count + # # Seek Error Rate + # # Raw Read Error Rate + # + HW_PHYSICAL_DISK_SMART_ATTRIBUTE = 'hw.physical_disk.smart_attribute' + + # State of the physical disk endurance utilization + # + # @note Stability Level: development + HW_PHYSICAL_DISK_STATE = 'hw.physical_disk.state' + + # Type of the physical disk + # + # @note Stability Level: development + # + # @example Sample Values + # # HDD + # # SSD + # # 10K + # + HW_PHYSICAL_DISK_TYPE = 'hw.physical_disk.type' + + # Location of the sensor + # + # @note Stability Level: development + # + # @example Sample Values + # # cpu0 + # # ps1 + # # INLET + # # CPU0_DIE + # # AMBIENT + # # MOTHERBOARD + # # PS0 V3_3 + # # MAIN_12V + # # CPU_VCORE + # + HW_SENSOR_LOCATION = 'hw.sensor_location' + + # Serial number of the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # CNFCP0123456789 + # + HW_SERIAL_NUMBER = 'hw.serial_number' + # The current state of the component # # @note Stability Level: development HW_STATE = 'hw.state' + # Type of tape drive operation + # + # @note Stability Level: development + HW_TAPE_DRIVE_OPERATION_TYPE = 'hw.tape_drive.operation_type' + # Type of the component # # Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. @@ -63,6 +250,20 @@ module HW # @note Stability Level: development HW_TYPE = 'hw.type' + # Vendor name of the hardware component + # + # @note Stability Level: development + # + # @example Sample Values + # # Dell + # # HP + # # Intel + # # AMD + # # LSI + # # Lenovo + # + HW_VENDOR = 'hw.vendor' + # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/metrics.rb index 82cffe6f5c..78af70e7d0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/hw/metrics.rb @@ -24,54 +24,224 @@ module Incubating module HW # @!group Metrics Names - # Energy consumed by the component + # Remaining fraction of battery charge. + # + # @note Stability Level: development + HW_BATTERY_CHARGE = 'hw.battery.charge' + + # Lower limit of battery charge fraction to ensure proper operation. + # + # @note Stability Level: development + HW_BATTERY_CHARGE_LIMIT = 'hw.battery.charge.limit' + + # Time left before battery is completely charged or discharged. + # + # @note Stability Level: development + HW_BATTERY_TIME_LEFT = 'hw.battery.time_left' + + # CPU current frequency. + # + # @note Stability Level: development + HW_CPU_SPEED = 'hw.cpu.speed' + + # CPU maximum frequency. + # + # @note Stability Level: development + HW_CPU_SPEED_LIMIT = 'hw.cpu.speed.limit' + + # Energy consumed by the component. # # @note Stability Level: development HW_ENERGY = 'hw.energy' - # Number of errors encountered by the component + # Number of errors encountered by the component. # # @note Stability Level: development HW_ERRORS = 'hw.errors' - # Ambient (external) temperature of the physical host + # Fan speed in revolutions per minute. + # + # @note Stability Level: development + HW_FAN_SPEED = 'hw.fan.speed' + + # Speed limit in rpm. + # + # @note Stability Level: development + HW_FAN_SPEED_LIMIT = 'hw.fan.speed.limit' + + # Fan speed expressed as a fraction of its maximum speed. + # + # @note Stability Level: development + HW_FAN_SPEED_RATIO = 'hw.fan.speed_ratio' + + # Received and transmitted bytes by the GPU. + # + # @note Stability Level: development + HW_GPU_IO = 'hw.gpu.io' + + # Size of the GPU memory. + # + # @note Stability Level: development + HW_GPU_MEMORY_LIMIT = 'hw.gpu.memory.limit' + + # GPU memory used. + # + # @note Stability Level: development + HW_GPU_MEMORY_USAGE = 'hw.gpu.memory.usage' + + # Fraction of GPU memory used. + # + # @note Stability Level: development + HW_GPU_MEMORY_UTILIZATION = 'hw.gpu.memory.utilization' + + # Fraction of time spent in a specific task. + # + # @note Stability Level: development + HW_GPU_UTILIZATION = 'hw.gpu.utilization' + + # Ambient (external) temperature of the physical host. # # @note Stability Level: development HW_HOST_AMBIENT_TEMPERATURE = 'hw.host.ambient_temperature' - # Total energy consumed by the entire physical host, in joules + # Total energy consumed by the entire physical host, in joules. # # The overall energy usage of a host MUST be reported using the specific `hw.host.energy` and `hw.host.power` metrics **only**, instead of the generic `hw.energy` and `hw.power` described in the previous section, to prevent summing up overlapping values. # # @note Stability Level: development HW_HOST_ENERGY = 'hw.host.energy' - # By how many degrees Celsius the temperature of the physical host can be increased, before reaching a warning threshold on one of the internal sensors + # By how many degrees Celsius the temperature of the physical host can be increased, before reaching a warning threshold on one of the internal sensors. # # @note Stability Level: development HW_HOST_HEATING_MARGIN = 'hw.host.heating_margin' - # Instantaneous power consumed by the entire physical host in Watts (`hw.host.energy` is preferred) + # Instantaneous power consumed by the entire physical host in Watts (`hw.host.energy` is preferred). # # The overall energy usage of a host MUST be reported using the specific `hw.host.energy` and `hw.host.power` metrics **only**, instead of the generic `hw.energy` and `hw.power` described in the previous section, to prevent summing up overlapping values. # # @note Stability Level: development HW_HOST_POWER = 'hw.host.power' - # Instantaneous power consumed by the component + # Size of the logical disk. + # + # @note Stability Level: development + HW_LOGICAL_DISK_LIMIT = 'hw.logical_disk.limit' + + # Logical disk space usage. + # + # @note Stability Level: development + HW_LOGICAL_DISK_USAGE = 'hw.logical_disk.usage' + + # Logical disk space utilization as a fraction. + # + # @note Stability Level: development + HW_LOGICAL_DISK_UTILIZATION = 'hw.logical_disk.utilization' + + # Size of the memory module. + # + # @note Stability Level: development + HW_MEMORY_SIZE = 'hw.memory.size' + + # Link speed. + # + # @note Stability Level: development + HW_NETWORK_BANDWIDTH_LIMIT = 'hw.network.bandwidth.limit' + + # Utilization of the network bandwidth as a fraction. + # + # @note Stability Level: development + HW_NETWORK_BANDWIDTH_UTILIZATION = 'hw.network.bandwidth.utilization' + + # Received and transmitted network traffic in bytes. + # + # @note Stability Level: development + HW_NETWORK_IO = 'hw.network.io' + + # Received and transmitted network traffic in packets (or frames). + # + # @note Stability Level: development + HW_NETWORK_PACKETS = 'hw.network.packets' + + # Link status: `1` (up) or `0` (down). + # + # @note Stability Level: development + HW_NETWORK_UP = 'hw.network.up' + + # Endurance remaining for this SSD disk. + # + # @note Stability Level: development + HW_PHYSICAL_DISK_ENDURANCE_UTILIZATION = 'hw.physical_disk.endurance_utilization' + + # Size of the disk. + # + # @note Stability Level: development + HW_PHYSICAL_DISK_SIZE = 'hw.physical_disk.size' + + # Value of the corresponding [S.M.A.R.T.](https://wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis, and Reporting Technology) attribute. + # + # @note Stability Level: development + HW_PHYSICAL_DISK_SMART = 'hw.physical_disk.smart' + + # Instantaneous power consumed by the component. # # It is recommended to report `hw.energy` instead of `hw.power` when possible. # # @note Stability Level: development HW_POWER = 'hw.power' - # Operational status: `1` (true) or `0` (false) for each of the possible states + # Maximum power output of the power supply. + # + # @note Stability Level: development + HW_POWER_SUPPLY_LIMIT = 'hw.power_supply.limit' + + # Current power output of the power supply. + # + # @note Stability Level: development + HW_POWER_SUPPLY_USAGE = 'hw.power_supply.usage' + + # Utilization of the power supply as a fraction of its maximum output. + # + # @note Stability Level: development + HW_POWER_SUPPLY_UTILIZATION = 'hw.power_supply.utilization' + + # Operational status: `1` (true) or `0` (false) for each of the possible states. # # `hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a [*StateSet* as defined in OpenMetrics](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset). This semantic convention will be updated once *StateSet* is specified in OpenTelemetry. This planned change is not expected to have any consequence on the way users query their timeseries backend to retrieve the values of `hw.status` over time. # # @note Stability Level: development HW_STATUS = 'hw.status' + # Operations performed by the tape drive. + # + # @note Stability Level: development + HW_TAPE_DRIVE_OPERATIONS = 'hw.tape_drive.operations' + + # Temperature in degrees Celsius. + # + # @note Stability Level: development + HW_TEMPERATURE = 'hw.temperature' + + # Temperature limit in degrees Celsius. + # + # @note Stability Level: development + HW_TEMPERATURE_LIMIT = 'hw.temperature.limit' + + # Voltage measured by the sensor. + # + # @note Stability Level: development + HW_VOLTAGE = 'hw.voltage' + + # Voltage limit in Volts. + # + # @note Stability Level: development + HW_VOLTAGE_LIMIT = 'hw.voltage.limit' + + # Nominal (expected) voltage. + # + # @note Stability Level: development + HW_VOLTAGE_NOMINAL = 'hw.voltage.nominal' + # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb index ea20582a6a..fcbe9297a8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb @@ -31,10 +31,12 @@ module IOS # @note Stability Level: development IOS_APP_STATE = 'ios.app.state' + # Deprecated. Use the `ios.app.state` attribute. + # # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate), and from which the `OS terminology` column values are derived. # # @note Stability Level: development - # @deprecated {"note": "Replaced by the `ios.app.state` event body field.", "reason": "uncategorized"} + # @deprecated {"note": "Replaced by `ios.app.state`.", "reason": "renamed", "renamed_to": "ios.app.state"} IOS_STATE = 'ios.state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb index 258124b200..17cf80daf5 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb @@ -31,8 +31,8 @@ module JVM # @note Stability Level: development # # @example Sample Values - # mapped - # direct + # # mapped + # # direct # JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name' @@ -43,8 +43,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # end of minor GC - # end of major GC + # # end of minor GC + # # end of major GC # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_ACTION}. @@ -57,8 +57,8 @@ module JVM # @note Stability Level: development # # @example Sample Values - # System.gc() - # Allocation Failure + # # System.gc() + # # Allocation Failure # JVM_GC_CAUSE = 'jvm.gc.cause' @@ -69,8 +69,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # G1 Young Generation - # G1 Old Generation + # # G1 Young Generation + # # G1 Old Generation # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_NAME}. @@ -83,9 +83,9 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # G1 Old Gen - # G1 Eden space - # G1 Survivor Space + # # G1 Old Gen + # # G1 Eden space + # # G1 Survivor Space # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_POOL_NAME}. @@ -96,8 +96,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # heap - # non_heap + # # heap + # # non_heap # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_TYPE}. @@ -115,8 +115,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # runnable - # blocked + # # runnable + # # blocked # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_STATE}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb index a9564b1dbf..ac993122d9 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb @@ -29,7 +29,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry-cluster + # # opentelemetry-cluster # K8S_CLUSTER_NAME = 'k8s.cluster.name' @@ -61,7 +61,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d # K8S_CLUSTER_UID = 'k8s.cluster.uid' @@ -70,7 +70,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # redis + # # redis # K8S_CONTAINER_NAME = 'k8s.container.name' @@ -84,8 +84,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # Evicted - # Error + # # Evicted + # # Error # K8S_CONTAINER_STATUS_LAST_TERMINATED_REASON = 'k8s.container.status.last_terminated_reason' @@ -94,15 +94,15 @@ module K8S # @note Stability Level: development # # @example Sample Values - # ContainerCreating - # CrashLoopBackOff - # CreateContainerConfigError - # ErrImagePull - # ImagePullBackOff - # OOMKilled - # Completed - # Error - # ContainerCannotRun + # # ContainerCreating + # # CrashLoopBackOff + # # CreateContainerConfigError + # # ErrImagePull + # # ImagePullBackOff + # # OOMKilled + # # Completed + # # Error + # # ContainerCannotRun # K8S_CONTAINER_STATUS_REASON = 'k8s.container.status.reason' @@ -111,9 +111,9 @@ module K8S # @note Stability Level: development # # @example Sample Values - # terminated - # running - # waiting + # # terminated + # # running + # # waiting # K8S_CONTAINER_STATUS_STATE = 'k8s.container.status.state' @@ -135,7 +135,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 4 + # # 4 # # K8S_CRONJOB_ANNOTATION_LAMBDA = ->(key) { "k8s.cronjob.annotation.#{key}" } @@ -158,7 +158,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # weekly + # # weekly # # K8S_CRONJOB_LABEL_LAMBDA = ->(key) { "k8s.cronjob.label.#{key}" } @@ -168,7 +168,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_CRONJOB_NAME = 'k8s.cronjob.name' @@ -177,7 +177,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_CRONJOB_UID = 'k8s.cronjob.uid' @@ -199,7 +199,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # # K8S_DAEMONSET_ANNOTATION_LAMBDA = ->(key) { "k8s.daemonset.annotation.#{key}" } @@ -222,7 +222,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # guestbook + # # guestbook # # K8S_DAEMONSET_LABEL_LAMBDA = ->(key) { "k8s.daemonset.label.#{key}" } @@ -232,7 +232,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_DAEMONSET_NAME = 'k8s.daemonset.name' @@ -241,7 +241,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_DAEMONSET_UID = 'k8s.daemonset.uid' @@ -263,7 +263,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # # K8S_DEPLOYMENT_ANNOTATION_LAMBDA = ->(key) { "k8s.deployment.annotation.#{key}" } @@ -286,7 +286,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # guestbook + # # guestbook # # K8S_DEPLOYMENT_LABEL_LAMBDA = ->(key) { "k8s.deployment.label.#{key}" } @@ -296,7 +296,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' @@ -305,7 +305,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' @@ -316,8 +316,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # Resource - # ContainerResource + # # Resource + # # ContainerResource # K8S_HPA_METRIC_TYPE = 'k8s.hpa.metric.type' @@ -326,7 +326,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_HPA_NAME = 'k8s.hpa.name' @@ -337,8 +337,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # apps/v1 - # autoscaling/v2 + # # apps/v1 + # # autoscaling/v2 # K8S_HPA_SCALETARGETREF_API_VERSION = 'k8s.hpa.scaletargetref.api_version' @@ -349,8 +349,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # Deployment - # StatefulSet + # # Deployment + # # StatefulSet # K8S_HPA_SCALETARGETREF_KIND = 'k8s.hpa.scaletargetref.kind' @@ -361,8 +361,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # my-deployment - # my-statefulset + # # my-deployment + # # my-statefulset # K8S_HPA_SCALETARGETREF_NAME = 'k8s.hpa.scaletargetref.name' @@ -371,7 +371,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_HPA_UID = 'k8s.hpa.uid' @@ -380,7 +380,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 2Mi + # # 2Mi # K8S_HUGEPAGE_SIZE = 'k8s.hugepage.size' @@ -402,7 +402,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # # K8S_JOB_ANNOTATION_LAMBDA = ->(key) { "k8s.job.annotation.#{key}" } @@ -425,7 +425,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # ci + # # ci # # K8S_JOB_LABEL_LAMBDA = ->(key) { "k8s.job.label.#{key}" } @@ -435,7 +435,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_JOB_NAME = 'k8s.job.name' @@ -444,7 +444,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_JOB_UID = 'k8s.job.uid' @@ -466,7 +466,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 0 + # # 0 # # K8S_NAMESPACE_ANNOTATION_LAMBDA = ->(key) { "k8s.namespace.annotation.#{key}" } @@ -489,7 +489,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # default + # # default # # K8S_NAMESPACE_LABEL_LAMBDA = ->(key) { "k8s.namespace.label.#{key}" } @@ -499,7 +499,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # default + # # default # K8S_NAMESPACE_NAME = 'k8s.namespace.name' @@ -511,8 +511,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # active - # terminating + # # active + # # terminating # K8S_NAMESPACE_PHASE = 'k8s.namespace.phase' @@ -534,7 +534,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 0 + # # 0 # # K8S_NODE_ANNOTATION_LAMBDA = ->(key) { "k8s.node.annotation.#{key}" } @@ -547,9 +547,9 @@ module K8S # @note Stability Level: development # # @example Sample Values - # true - # false - # unknown + # # true + # # false + # # unknown # K8S_NODE_CONDITION_STATUS = 'k8s.node.condition.status' @@ -568,8 +568,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # Ready - # DiskPressure + # # Ready + # # DiskPressure # K8S_NODE_CONDITION_TYPE = 'k8s.node.condition.type' @@ -591,7 +591,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # arm64 + # # arm64 # # K8S_NODE_LABEL_LAMBDA = ->(key) { "k8s.node.label.#{key}" } @@ -601,7 +601,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # node-1 + # # node-1 # K8S_NODE_NAME = 'k8s.node.name' @@ -610,7 +610,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2 + # # 1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2 # K8S_NODE_UID = 'k8s.node.uid' @@ -634,8 +634,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # true - # x64 + # # true + # # x64 # # K8S_POD_ANNOTATION_LAMBDA = ->(key) { "k8s.pod.annotation.#{key}" } @@ -660,8 +660,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # my-app - # x64 + # # my-app + # # x64 # # K8S_POD_LABEL_LAMBDA = ->(key) { "k8s.pod.label.#{key}" } @@ -677,7 +677,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # my-app + # # my-app # # @deprecated {"note": "Replaced by `k8s.pod.label`.", "reason": "renamed", "renamed_to": "k8s.pod.label"} K8S_POD_LABELS_LAMBDA = ->(key) { "k8s.pod.labels.#{key}" } @@ -687,7 +687,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry-pod-autoconf + # # opentelemetry-pod-autoconf # K8S_POD_NAME = 'k8s.pod.name' @@ -696,7 +696,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_POD_UID = 'k8s.pod.uid' @@ -718,7 +718,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 0 + # # 0 # # K8S_REPLICASET_ANNOTATION_LAMBDA = ->(key) { "k8s.replicaset.annotation.#{key}" } @@ -741,7 +741,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # guestbook + # # guestbook # # K8S_REPLICASET_LABEL_LAMBDA = ->(key) { "k8s.replicaset.label.#{key}" } @@ -751,7 +751,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_REPLICASET_NAME = 'k8s.replicaset.name' @@ -760,7 +760,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_REPLICASET_UID = 'k8s.replicaset.uid' @@ -769,7 +769,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_REPLICATIONCONTROLLER_NAME = 'k8s.replicationcontroller.name' @@ -778,7 +778,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_REPLICATIONCONTROLLER_UID = 'k8s.replicationcontroller.uid' @@ -787,7 +787,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_RESOURCEQUOTA_NAME = 'k8s.resourcequota.name' @@ -798,7 +798,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # count/replicationcontrollers + # # count/replicationcontrollers # K8S_RESOURCEQUOTA_RESOURCE_NAME = 'k8s.resourcequota.resource_name' @@ -807,7 +807,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_RESOURCEQUOTA_UID = 'k8s.resourcequota.uid' @@ -829,7 +829,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # # K8S_STATEFULSET_ANNOTATION_LAMBDA = ->(key) { "k8s.statefulset.annotation.#{key}" } @@ -852,7 +852,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # guestbook + # # guestbook # # K8S_STATEFULSET_LABEL_LAMBDA = ->(key) { "k8s.statefulset.label.#{key}" } @@ -862,7 +862,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # opentelemetry + # # opentelemetry # K8S_STATEFULSET_NAME = 'k8s.statefulset.name' @@ -871,7 +871,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff # K8S_STATEFULSET_UID = 'k8s.statefulset.uid' @@ -880,7 +880,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # gold.storageclass.storage.k8s.io + # # gold.storageclass.storage.k8s.io # K8S_STORAGECLASS_NAME = 'k8s.storageclass.name' @@ -889,7 +889,7 @@ module K8S # @note Stability Level: development # # @example Sample Values - # volume0 + # # volume0 # K8S_VOLUME_NAME = 'k8s.volume.name' @@ -898,8 +898,8 @@ module K8S # @note Stability Level: development # # @example Sample Values - # emptyDir - # persistentVolumeClaim + # # emptyDir + # # persistentVolumeClaim # K8S_VOLUME_TYPE = 'k8s.volume.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/metrics.rb index 0f02c52ddb..85f9b247b7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/metrics.rb @@ -24,49 +24,49 @@ module Incubating module K8S # @!group Metrics Names - # Maximum CPU resource limit set for the container + # Maximum CPU resource limit set for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_CPU_LIMIT = 'k8s.container.cpu.limit' - # CPU resource requested for the container + # CPU resource requested for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_CPU_REQUEST = 'k8s.container.cpu.request' - # Maximum ephemeral storage resource limit set for the container + # Maximum ephemeral storage resource limit set for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_EPHEMERAL_STORAGE_LIMIT = 'k8s.container.ephemeral_storage.limit' - # Ephemeral storage resource requested for the container + # Ephemeral storage resource requested for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_EPHEMERAL_STORAGE_REQUEST = 'k8s.container.ephemeral_storage.request' - # Maximum memory resource limit set for the container + # Maximum memory resource limit set for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_MEMORY_LIMIT = 'k8s.container.memory.limit' - # Memory resource requested for the container + # Memory resource requested for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_MEMORY_REQUEST = 'k8s.container.memory.request' - # Indicates whether the container is currently marked as ready to accept traffic, based on its readiness probe (1 = ready, 0 = not ready) + # Indicates whether the container is currently marked as ready to accept traffic, based on its readiness probe (1 = ready, 0 = not ready). # # This metric SHOULD reflect the value of the `ready` field in the # [K8s ContainerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#containerstatus-v1-core). @@ -74,7 +74,7 @@ module K8S # @note Stability Level: development K8S_CONTAINER_READY = 'k8s.container.ready' - # Describes how many times the container has restarted (since the last counter reset) + # Describes how many times the container has restarted (since the last counter reset). # # This value is pulled directly from the K8s API and the value can go indefinitely high and be reset to 0 # at any time depending on how your kubelet is configured to prune dead containers. @@ -85,7 +85,7 @@ module K8S # @note Stability Level: development K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart.count' - # Describes the number of K8s containers that are currently in a state for a given reason + # Describes the number of K8s containers that are currently in a state for a given reason. # # All possible container state reasons will be reported at each time interval to avoid missing metrics. # Only the value corresponding to the current state reason will be non-zero. @@ -93,7 +93,7 @@ module K8S # @note Stability Level: development K8S_CONTAINER_STATUS_REASON = 'k8s.container.status.reason' - # Describes the number of K8s containers that are currently in a given state + # Describes the number of K8s containers that are currently in a given state. # # All possible container states will be reported at each time interval to avoid missing metrics. # Only the value corresponding to the current state will be non-zero. @@ -101,21 +101,21 @@ module K8S # @note Stability Level: development K8S_CONTAINER_STATUS_STATE = 'k8s.container.status.state' - # Maximum storage resource limit set for the container + # Maximum storage resource limit set for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_STORAGE_LIMIT = 'k8s.container.storage.limit' - # Storage resource requested for the container + # Storage resource requested for the container. # # See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details. # # @note Stability Level: development K8S_CONTAINER_STORAGE_REQUEST = 'k8s.container.storage.request' - # The number of actively running jobs for a cronjob + # The number of actively running jobs for a cronjob. # # This metric aligns with the `active` field of the # [K8s CronJobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#cronjobstatus-v1-batch). @@ -123,7 +123,7 @@ module K8S # @note Stability Level: development K8S_CRONJOB_ACTIVE_JOBS = 'k8s.cronjob.active_jobs' - # Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod + # Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. # # This metric aligns with the `currentNumberScheduled` field of the # [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). @@ -131,7 +131,7 @@ module K8S # @note Stability Level: development K8S_DAEMONSET_CURRENT_SCHEDULED_NODES = 'k8s.daemonset.current_scheduled_nodes' - # Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod) + # Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod). # # This metric aligns with the `desiredNumberScheduled` field of the # [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). @@ -139,7 +139,7 @@ module K8S # @note Stability Level: development K8S_DAEMONSET_DESIRED_SCHEDULED_NODES = 'k8s.daemonset.desired_scheduled_nodes' - # Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod + # Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. # # This metric aligns with the `numberMisscheduled` field of the # [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). @@ -147,7 +147,7 @@ module K8S # @note Stability Level: development K8S_DAEMONSET_MISSCHEDULED_NODES = 'k8s.daemonset.misscheduled_nodes' - # Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready + # Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. # # This metric aligns with the `numberReady` field of the # [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). @@ -155,7 +155,7 @@ module K8S # @note Stability Level: development K8S_DAEMONSET_READY_NODES = 'k8s.daemonset.ready_nodes' - # Total number of available replica pods (ready for at least minReadySeconds) targeted by this deployment + # Total number of available replica pods (ready for at least minReadySeconds) targeted by this deployment. # # This metric aligns with the `availableReplicas` field of the # [K8s DeploymentStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentstatus-v1-apps). @@ -163,7 +163,7 @@ module K8S # @note Stability Level: development K8S_DEPLOYMENT_AVAILABLE_PODS = 'k8s.deployment.available_pods' - # Number of desired replica pods in this deployment + # Number of desired replica pods in this deployment. # # This metric aligns with the `replicas` field of the # [K8s DeploymentSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentspec-v1-apps). @@ -171,7 +171,7 @@ module K8S # @note Stability Level: development K8S_DEPLOYMENT_DESIRED_PODS = 'k8s.deployment.desired_pods' - # Current number of replica pods managed by this horizontal pod autoscaler, as last seen by the autoscaler + # Current number of replica pods managed by this horizontal pod autoscaler, as last seen by the autoscaler. # # This metric aligns with the `currentReplicas` field of the # [K8s HorizontalPodAutoscalerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerstatus-v2-autoscaling) @@ -179,7 +179,7 @@ module K8S # @note Stability Level: development K8S_HPA_CURRENT_PODS = 'k8s.hpa.current_pods' - # Desired number of replica pods managed by this horizontal pod autoscaler, as last calculated by the autoscaler + # Desired number of replica pods managed by this horizontal pod autoscaler, as last calculated by the autoscaler. # # This metric aligns with the `desiredReplicas` field of the # [K8s HorizontalPodAutoscalerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerstatus-v2-autoscaling) @@ -187,7 +187,7 @@ module K8S # @note Stability Level: development K8S_HPA_DESIRED_PODS = 'k8s.hpa.desired_pods' - # The upper limit for the number of replica pods to which the autoscaler can scale up + # The upper limit for the number of replica pods to which the autoscaler can scale up. # # This metric aligns with the `maxReplicas` field of the # [K8s HorizontalPodAutoscalerSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerspec-v2-autoscaling) @@ -225,7 +225,7 @@ module K8S # @note Stability Level: development K8S_HPA_METRIC_TARGET_CPU_VALUE = 'k8s.hpa.metric.target.cpu.value' - # The lower limit for the number of replica pods to which the autoscaler can scale down + # The lower limit for the number of replica pods to which the autoscaler can scale down. # # This metric aligns with the `minReplicas` field of the # [K8s HorizontalPodAutoscalerSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerspec-v2-autoscaling) @@ -233,7 +233,7 @@ module K8S # @note Stability Level: development K8S_HPA_MIN_PODS = 'k8s.hpa.min_pods' - # The number of pending and actively running pods for a job + # The number of pending and actively running pods for a job. # # This metric aligns with the `active` field of the # [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch). @@ -241,7 +241,7 @@ module K8S # @note Stability Level: development K8S_JOB_ACTIVE_PODS = 'k8s.job.active_pods' - # The desired number of successfully finished pods the job should be run with + # The desired number of successfully finished pods the job should be run with. # # This metric aligns with the `completions` field of the # [K8s JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobspec-v1-batch).. @@ -249,7 +249,7 @@ module K8S # @note Stability Level: development K8S_JOB_DESIRED_SUCCESSFUL_PODS = 'k8s.job.desired_successful_pods' - # The number of pods which reached phase Failed for a job + # The number of pods which reached phase Failed for a job. # # This metric aligns with the `failed` field of the # [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch). @@ -257,7 +257,7 @@ module K8S # @note Stability Level: development K8S_JOB_FAILED_PODS = 'k8s.job.failed_pods' - # The max desired number of pods the job should run at any given time + # The max desired number of pods the job should run at any given time. # # This metric aligns with the `parallelism` field of the # [K8s JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobspec-v1-batch). @@ -265,7 +265,7 @@ module K8S # @note Stability Level: development K8S_JOB_MAX_PARALLEL_PODS = 'k8s.job.max_parallel_pods' - # The number of pods which reached phase Succeeded for a job + # The number of pods which reached phase Succeeded for a job. # # This metric aligns with the `succeeded` field of the # [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch). @@ -278,22 +278,22 @@ module K8S # @note Stability Level: development K8S_NAMESPACE_PHASE = 'k8s.namespace.phase' - # Amount of cpu allocatable on the node + # Amount of cpu allocatable on the node. # # @note Stability Level: development K8S_NODE_ALLOCATABLE_CPU = 'k8s.node.allocatable.cpu' - # Amount of ephemeral-storage allocatable on the node + # Amount of ephemeral-storage allocatable on the node. # # @note Stability Level: development K8S_NODE_ALLOCATABLE_EPHEMERAL_STORAGE = 'k8s.node.allocatable.ephemeral_storage' - # Amount of memory allocatable on the node + # Amount of memory allocatable on the node. # # @note Stability Level: development K8S_NODE_ALLOCATABLE_MEMORY = 'k8s.node.allocatable.memory' - # Amount of pods allocatable on the node + # Amount of pods allocatable on the node. # # @note Stability Level: development K8S_NODE_ALLOCATABLE_PODS = 'k8s.node.allocatable.pods' @@ -305,38 +305,70 @@ module K8S # @note Stability Level: development K8S_NODE_CONDITION_STATUS = 'k8s.node.condition.status' - # Total CPU time consumed + # Total CPU time consumed. # # Total CPU time consumed by the specific Node on all available CPU cores # # @note Stability Level: development K8S_NODE_CPU_TIME = 'k8s.node.cpu.time' - # Node's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs + # Node's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs. # # CPU usage of the specific Node on all available CPU cores, averaged over the sample window # # @note Stability Level: development K8S_NODE_CPU_USAGE = 'k8s.node.cpu.usage' - # Memory usage of the Node + # Node filesystem available bytes. + # + # This metric is derived from the + # [FsStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_NODE_FILESYSTEM_AVAILABLE = 'k8s.node.filesystem.available' + + # Node filesystem capacity. + # + # This metric is derived from the + # [FsStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_NODE_FILESYSTEM_CAPACITY = 'k8s.node.filesystem.capacity' + + # Node filesystem usage. + # + # This may not equal capacity - available. + # + # This metric is derived from the + # [FsStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_NODE_FILESYSTEM_USAGE = 'k8s.node.filesystem.usage' + + # Memory usage of the Node. # # Total memory usage of the Node # # @note Stability Level: development K8S_NODE_MEMORY_USAGE = 'k8s.node.memory.usage' - # Node network errors + # Node network errors. # # @note Stability Level: development K8S_NODE_NETWORK_ERRORS = 'k8s.node.network.errors' - # Network bytes for the Node + # Network bytes for the Node. # # @note Stability Level: development K8S_NODE_NETWORK_IO = 'k8s.node.network.io' - # The time the Node has been running + # The time the Node has been running. # # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. # The actual accuracy would depend on the instrumentation and operating system. @@ -344,38 +376,70 @@ module K8S # @note Stability Level: development K8S_NODE_UPTIME = 'k8s.node.uptime' - # Total CPU time consumed + # Total CPU time consumed. # # Total CPU time consumed by the specific Pod on all available CPU cores # # @note Stability Level: development K8S_POD_CPU_TIME = 'k8s.pod.cpu.time' - # Pod's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs + # Pod's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs. # # CPU usage of the specific Pod on all available CPU cores, averaged over the sample window # # @note Stability Level: development K8S_POD_CPU_USAGE = 'k8s.pod.cpu.usage' - # Memory usage of the Pod + # Pod filesystem available bytes. + # + # This metric is derived from the + # [FsStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [PodStats.EphemeralStorage](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_FILESYSTEM_AVAILABLE = 'k8s.pod.filesystem.available' + + # Pod filesystem capacity. + # + # This metric is derived from the + # [FsStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [PodStats.EphemeralStorage](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_FILESYSTEM_CAPACITY = 'k8s.pod.filesystem.capacity' + + # Pod filesystem usage. + # + # This may not equal capacity - available. + # + # This metric is derived from the + # [FsStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field + # of the [PodStats.EphemeralStorage](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) + # of the Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_FILESYSTEM_USAGE = 'k8s.pod.filesystem.usage' + + # Memory usage of the Pod. # # Total memory usage of the Pod # # @note Stability Level: development K8S_POD_MEMORY_USAGE = 'k8s.pod.memory.usage' - # Pod network errors + # Pod network errors. # # @note Stability Level: development K8S_POD_NETWORK_ERRORS = 'k8s.pod.network.errors' - # Network bytes for the Pod + # Network bytes for the Pod. # # @note Stability Level: development K8S_POD_NETWORK_IO = 'k8s.pod.network.io' - # The time the Pod has been running + # The time the Pod has been running. # # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. # The actual accuracy would depend on the instrumentation and operating system. @@ -383,7 +447,71 @@ module K8S # @note Stability Level: development K8S_POD_UPTIME = 'k8s.pod.uptime' - # Total number of available replica pods (ready for at least minReadySeconds) targeted by this replicaset + # Pod volume storage space available. + # + # This metric is derived from the + # [VolumeStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_VOLUME_AVAILABLE = 'k8s.pod.volume.available' + + # Pod volume total capacity. + # + # This metric is derived from the + # [VolumeStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_VOLUME_CAPACITY = 'k8s.pod.volume.capacity' + + # The total inodes in the filesystem of the Pod's volume. + # + # This metric is derived from the + # [VolumeStats.Inodes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_VOLUME_INODE_COUNT = 'k8s.pod.volume.inode.count' + + # The free inodes in the filesystem of the Pod's volume. + # + # This metric is derived from the + # [VolumeStats.InodesFree](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_VOLUME_INODE_FREE = 'k8s.pod.volume.inode.free' + + # The inodes used by the filesystem of the Pod's volume. + # + # This metric is derived from the + # [VolumeStats.InodesUsed](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # This may not be equal to `inodes - free` because filesystem may share inodes with other filesystems. + # + # @note Stability Level: development + K8S_POD_VOLUME_INODE_USED = 'k8s.pod.volume.inode.used' + + # Pod volume usage. + # + # This may not equal capacity - available. + # + # This metric is derived from the + # [VolumeStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#VolumeStats) field + # of the [PodStats](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#PodStats) of the + # Kubelet's stats API. + # + # @note Stability Level: development + K8S_POD_VOLUME_USAGE = 'k8s.pod.volume.usage' + + # Total number of available replica pods (ready for at least minReadySeconds) targeted by this replicaset. # # This metric aligns with the `availableReplicas` field of the # [K8s ReplicaSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetstatus-v1-apps). @@ -391,7 +519,7 @@ module K8S # @note Stability Level: development K8S_REPLICASET_AVAILABLE_PODS = 'k8s.replicaset.available_pods' - # Number of desired replica pods in this replicaset + # Number of desired replica pods in this replicaset. # # This metric aligns with the `replicas` field of the # [K8s ReplicaSetSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetspec-v1-apps). @@ -411,7 +539,7 @@ module K8S # @deprecated {"note": "Replaced by `k8s.replicationcontroller.desired_pods`.", "reason": "renamed", "renamed_to": "k8s.replicationcontroller.desired_pods"} K8S_REPLICATION_CONTROLLER_DESIRED_PODS = 'k8s.replication_controller.desired_pods' - # Total number of available replica pods (ready for at least minReadySeconds) targeted by this replication controller + # Total number of available replica pods (ready for at least minReadySeconds) targeted by this replication controller. # # This metric aligns with the `availableReplicas` field of the # [K8s ReplicationControllerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicationcontrollerstatus-v1-core) @@ -419,7 +547,7 @@ module K8S # @note Stability Level: development K8S_REPLICATIONCONTROLLER_AVAILABLE_PODS = 'k8s.replicationcontroller.available_pods' - # Number of desired replica pods in this replication controller + # Number of desired replica pods in this replication controller. # # This metric aligns with the `replicas` field of the # [K8s ReplicationControllerSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicationcontrollerspec-v1-core) @@ -619,7 +747,7 @@ module K8S # @note Stability Level: development K8S_RESOURCEQUOTA_STORAGE_REQUEST_USED = 'k8s.resourcequota.storage.request.used' - # The number of replica pods created by the statefulset controller from the statefulset version indicated by currentRevision + # The number of replica pods created by the statefulset controller from the statefulset version indicated by currentRevision. # # This metric aligns with the `currentReplicas` field of the # [K8s StatefulSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#statefulsetstatus-v1-apps). @@ -627,7 +755,7 @@ module K8S # @note Stability Level: development K8S_STATEFULSET_CURRENT_PODS = 'k8s.statefulset.current_pods' - # Number of desired replica pods in this statefulset + # Number of desired replica pods in this statefulset. # # This metric aligns with the `replicas` field of the # [K8s StatefulSetSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#statefulsetspec-v1-apps). @@ -635,7 +763,7 @@ module K8S # @note Stability Level: development K8S_STATEFULSET_DESIRED_PODS = 'k8s.statefulset.desired_pods' - # The number of replica pods created for this statefulset with a Ready Condition + # The number of replica pods created for this statefulset with a Ready Condition. # # This metric aligns with the `readyReplicas` field of the # [K8s StatefulSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#statefulsetstatus-v1-apps). @@ -643,7 +771,7 @@ module K8S # @note Stability Level: development K8S_STATEFULSET_READY_PODS = 'k8s.statefulset.ready_pods' - # Number of replica pods created by the statefulset controller from the statefulset version indicated by updateRevision + # Number of replica pods created by the statefulset controller from the statefulset version indicated by updateRevision. # # This metric aligns with the `updatedReplicas` field of the # [K8s StatefulSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#statefulsetstatus-v1-apps). diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/linux/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/linux/attributes.rb index 2b7f3df804..55e11f2cf2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/linux/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/linux/attributes.rb @@ -29,8 +29,8 @@ module LINUX # @note Stability Level: development # # @example Sample Values - # reclaimable - # unreclaimable + # # reclaimable + # # unreclaimable # LINUX_MEMORY_SLAB_STATE = 'linux.memory.slab.state' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb index 45bd7eb53d..572ad3e54b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb @@ -29,7 +29,7 @@ module LOG # @note Stability Level: development # # @example Sample Values - # audit.log + # # audit.log # LOG_FILE_NAME = 'log.file.name' @@ -38,7 +38,7 @@ module LOG # @note Stability Level: development # # @example Sample Values - # uuid.log + # # uuid.log # LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved' @@ -47,7 +47,7 @@ module LOG # @note Stability Level: development # # @example Sample Values - # /var/log/mysql/audit.log + # # /var/log/mysql/audit.log # LOG_FILE_PATH = 'log.file.path' @@ -56,7 +56,7 @@ module LOG # @note Stability Level: development # # @example Sample Values - # /var/lib/docker/uuid.log + # # /var/lib/docker/uuid.log # LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved' @@ -72,8 +72,8 @@ module LOG # @note Stability Level: development # # @example Sample Values - # 77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened - # [INFO] 8/3/24 12:34:56 Something happened + # # 77 <86>1 2015-08-06T21:58:59.694Z 192.168.2.133 inactive - - - Something happened + # # [INFO] 8/3/24 12:34:56 Something happened # LOG_RECORD_ORIGINAL = 'log.record.original' @@ -85,7 +85,7 @@ module LOG # @note Stability Level: development # # @example Sample Values - # 01ARZ3NDEKTSV4RRFFQ69G5FAV + # # 01ARZ3NDEKTSV4RRFFQ69G5FAV # LOG_RECORD_UID = 'log.record.uid' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb index 3ad8ffdaa0..88ca7ac928 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb @@ -29,7 +29,7 @@ module MAINFRAME # @note Stability Level: development # # @example Sample Values - # LPAR01 + # # LPAR01 # MAINFRAME_LPAR_NAME = 'mainframe.lpar.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb index ae8ab70951..43c2e0a4d8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb @@ -31,9 +31,9 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # 0 - # 1 - # 2 + # # 0 + # # 1 + # # 2 # MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count' @@ -42,8 +42,8 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # client-5 - # myhost@8742@s8083jm + # # client-5 + # # myhost@8742@s8083jm # MESSAGING_CLIENT_ID = 'messaging.client.id' @@ -54,8 +54,8 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # my-group - # indexer + # # my-group + # # indexer # MESSAGING_CONSUMER_GROUP_NAME = 'messaging.consumer.group.name' @@ -72,8 +72,8 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # MyQueue - # MyTopic + # # MyQueue + # # MyTopic # MESSAGING_DESTINATION_NAME = 'messaging.destination.name' @@ -93,7 +93,7 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # subscription-a + # # subscription-a # MESSAGING_DESTINATION_SUBSCRIPTION_NAME = 'messaging.destination.subscription.name' @@ -104,7 +104,7 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # /customers/{customerId} + # # /customers/{customerId} # MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template' @@ -124,8 +124,8 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # MyQueue - # MyTopic + # # MyQueue + # # MyTopic # # @deprecated {"note": "Removed. No replacement at this time.", "reason": "obsoleted"} MESSAGING_DESTINATION_PUBLISH_NAME = 'messaging.destination_publish.name' @@ -287,9 +287,9 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # publish - # create - # process + # # publish + # # create + # # process # # @deprecated {"note": "Replaced by `messaging.operation.type`.", "reason": "renamed", "renamed_to": "messaging.operation.type"} MESSAGING_OPERATION = 'messaging.operation' @@ -299,9 +299,9 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # ack - # nack - # send + # # ack + # # nack + # # send # MESSAGING_OPERATION_NAME = 'messaging.operation.name' @@ -377,8 +377,8 @@ module MESSAGING # @note Stability Level: development # # @example Sample Values - # ["keyA", "keyB"] - # + # # keyA + # keyB MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message.keys' # The secondary classifier of message besides topic. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb index 1f0d2fa56b..a3417dccd7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb @@ -39,7 +39,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # example.com + # # example.com # # @deprecated {"note": "Replaced by `server.address`.", "reason": "renamed", "renamed_to": "server.address"} NET_HOST_NAME = 'net.host.name' @@ -49,7 +49,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # 8080 + # # 8080 # # @deprecated {"note": "Replaced by `server.port`.", "reason": "renamed", "renamed_to": "server.port"} NET_HOST_PORT = 'net.host.port' @@ -69,7 +69,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # example.com + # # example.com # # @deprecated {"note": "Replaced by `server.address` on client spans and `client.address` on server spans.", "reason": "uncategorized"} NET_PEER_NAME = 'net.peer.name' @@ -79,7 +79,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # 8080 + # # 8080 # # @deprecated {"note": "Replaced by `server.port` on client spans and `client.port` on server spans.", "reason": "uncategorized"} NET_PEER_PORT = 'net.peer.port' @@ -89,9 +89,9 @@ module NET # @note Stability Level: development # # @example Sample Values - # amqp - # http - # mqtt + # # amqp + # # http + # # mqtt # # @deprecated {"note": "Replaced by `network.protocol.name`.", "reason": "renamed", "renamed_to": "network.protocol.name"} NET_PROTOCOL_NAME = 'net.protocol.name' @@ -117,7 +117,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # /var/my.sock + # # /var/my.sock # # @deprecated {"note": "Replaced by `network.local.address`.", "reason": "renamed", "renamed_to": "network.local.address"} NET_SOCK_HOST_ADDR = 'net.sock.host.addr' @@ -127,7 +127,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # 8080 + # # 8080 # # @deprecated {"note": "Replaced by `network.local.port`.", "reason": "renamed", "renamed_to": "network.local.port"} NET_SOCK_HOST_PORT = 'net.sock.host.port' @@ -137,7 +137,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # 192.168.0.1 + # # 192.168.0.1 # # @deprecated {"note": "Replaced by `network.peer.address`.", "reason": "renamed", "renamed_to": "network.peer.address"} NET_SOCK_PEER_ADDR = 'net.sock.peer.addr' @@ -147,7 +147,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # /var/my.sock + # # /var/my.sock # # @deprecated {"note": "Removed. No replacement at this time.", "reason": "obsoleted"} NET_SOCK_PEER_NAME = 'net.sock.peer.name' @@ -157,7 +157,7 @@ module NET # @note Stability Level: development # # @example Sample Values - # 65531 + # # 65531 # # @deprecated {"note": "Replaced by `network.peer.port`.", "reason": "renamed", "renamed_to": "network.peer.port"} NET_SOCK_PEER_PORT = 'net.sock.peer.port' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb index 8304b432d1..db525d4c29 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb @@ -67,7 +67,7 @@ module NETWORK # @note Stability Level: development # # @example Sample Values - # close_wait + # # close_wait # NETWORK_CONNECTION_STATE = 'network.connection.state' @@ -94,8 +94,8 @@ module NETWORK # @note Stability Level: development # # @example Sample Values - # lo - # eth0 + # # lo + # # eth0 # NETWORK_INTERFACE_NAME = 'network.interface.name' @@ -104,7 +104,7 @@ module NETWORK # @note Stability Level: development # # @example Sample Values - # transmit + # # transmit # NETWORK_IO_DIRECTION = 'network.io.direction' @@ -113,8 +113,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 10.1.2.80 - # /tmp/my.sock + # # 10.1.2.80 + # # /tmp/my.sock # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_ADDRESS}. @@ -125,7 +125,7 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_PORT}. @@ -136,8 +136,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 10.1.2.80 - # /tmp/my.sock + # # 10.1.2.80 + # # /tmp/my.sock # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_ADDRESS}. @@ -148,7 +148,7 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_PORT}. @@ -161,9 +161,9 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # amqp - # http - # mqtt + # # amqp + # # http + # # mqtt # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_NAME}. @@ -176,8 +176,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 1.1 - # 2 + # # 1.1 + # # 2 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_VERSION}. @@ -194,8 +194,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # tcp - # udp + # # tcp + # # udp # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TRANSPORT}. @@ -208,8 +208,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # ipv4 - # ipv6 + # # ipv4 + # # ipv6 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TYPE}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb index ee76c311a7..4a51eff048 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb @@ -32,7 +32,7 @@ module OCI # @note Stability Level: development # # @example Sample Values - # sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 + # # sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 # OCI_MANIFEST_DIGEST = 'oci.manifest.digest' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/openai.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/openai.rb new file mode 100644 index 0000000000..d5f2d00ad0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/openai.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 + +# This file was autogenerated. Do not edit it by hand. + +require_relative 'openai/attributes' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/openai/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/openai/attributes.rb new file mode 100644 index 0000000000..c850191fe0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/openai/attributes.rb @@ -0,0 +1,60 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# +# This file was autogenerated. Do not edit it by hand. + +module OpenTelemetry + module SemConv + module Incubating + module OPENAI + # @!group Attribute Names + + # The service tier requested. May be a specific tier, default, or auto. + # + # @note Stability Level: development + # + # @example Sample Values + # # auto + # # default + # + OPENAI_REQUEST_SERVICE_TIER = 'openai.request.service_tier' + + # The service tier used for the response. + # + # @note Stability Level: development + # + # @example Sample Values + # # scale + # # default + # + OPENAI_RESPONSE_SERVICE_TIER = 'openai.response.service_tier' + + # A fingerprint to track any eventual change in the Generative AI environment. + # + # @note Stability Level: development + # + # @example Sample Values + # # fp_44709d6fcb + # + OPENAI_RESPONSE_SYSTEM_FINGERPRINT = 'openai.response.system_fingerprint' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb index cdf01714ae..b2a225d66b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb @@ -29,9 +29,9 @@ module OS # @note Stability Level: development # # @example Sample Values - # TQ3C.230805.001.B2 - # 20E247 - # 22621 + # # TQ3C.230805.001.B2 + # # 20E247 + # # 22621 # OS_BUILD_ID = 'os.build_id' @@ -40,8 +40,8 @@ module OS # @note Stability Level: development # # @example Sample Values - # Microsoft Windows [Version 10.0.18363.778] - # Ubuntu 18.04.1 LTS + # # Microsoft Windows [Version 10.0.18363.778] + # # Ubuntu 18.04.1 LTS # OS_DESCRIPTION = 'os.description' @@ -50,9 +50,9 @@ module OS # @note Stability Level: development # # @example Sample Values - # iOS - # Android - # Ubuntu + # # iOS + # # Android + # # Ubuntu # OS_NAME = 'os.name' @@ -66,8 +66,8 @@ module OS # @note Stability Level: development # # @example Sample Values - # 14.2.1 - # 18.04.1 + # # 14.2.1 + # # 18.04.1 # OS_VERSION = 'os.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb index fb7b9338b3..58950eec5a 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb @@ -43,8 +43,8 @@ module OTEL # @note Stability Level: development # # @example Sample Values - # otlp_grpc_span_exporter/0 - # custom-name + # # otlp_grpc_span_exporter/0 + # # custom-name # OTEL_COMPONENT_NAME = 'otel.component.name' @@ -56,8 +56,8 @@ module OTEL # @note Stability Level: development # # @example Sample Values - # batching_span_processor - # com.example.MySpanExporter + # # batching_span_processor + # # com.example.MySpanExporter # OTEL_COMPONENT_TYPE = 'otel.component.type' @@ -66,7 +66,7 @@ module OTEL # @note Stability Level: development # # @example Sample Values - # io.opentelemetry.contrib.mongodb + # # io.opentelemetry.contrib.mongodb # # @deprecated {"note": "Replaced by `otel.scope.name`.", "reason": "renamed", "renamed_to": "otel.scope.name"} OTEL_LIBRARY_NAME = 'otel.library.name' @@ -76,7 +76,7 @@ module OTEL # @note Stability Level: development # # @example Sample Values - # 1.0.0 + # # 1.0.0 # # @deprecated {"note": "Replaced by `otel.scope.version`.", "reason": "renamed", "renamed_to": "otel.scope.version"} OTEL_LIBRARY_VERSION = 'otel.library.version' @@ -86,18 +86,27 @@ module OTEL # @note Stability Level: stable # # @example Sample Values - # io.opentelemetry.contrib.mongodb + # # io.opentelemetry.contrib.mongodb # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_NAME}. OTEL_SCOPE_NAME = 'otel.scope.name' + # The schema URL of the instrumentation scope. + # + # @note Stability Level: development + # + # @example Sample Values + # # https://opentelemetry.io/schemas/1.31.0 + # + OTEL_SCOPE_SCHEMA_URL = 'otel.scope.schema_url' + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). # # @note Stability Level: stable # # @example Sample Values - # 1.0.0 + # # 1.0.0 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_VERSION}. @@ -125,7 +134,7 @@ module OTEL # @note Stability Level: stable # # @example Sample Values - # resource not found + # # resource not found # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_DESCRIPTION}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/metrics.rb index 4f2fcde7c9..584294e44b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/metrics.rb @@ -24,7 +24,7 @@ module Incubating module OTEL # @!group Metrics Names - # The number of log records for which the export has finished, either successful or failed + # The number of log records for which the export has finished, either successful or failed. # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # For exporters with partial success semantics (e.g. OTLP with `rejected_log_records`), rejected log records MUST count as failed and only non-rejected log records count as success. @@ -33,14 +33,14 @@ module OTEL # @note Stability Level: development OTEL_SDK_EXPORTER_LOG_EXPORTED = 'otel.sdk.exporter.log.exported' - # The number of log records which were passed to the exporter, but that have not been exported yet (neither successful, nor failed) + # The number of log records which were passed to the exporter, but that have not been exported yet (neither successful, nor failed). # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # # @note Stability Level: development OTEL_SDK_EXPORTER_LOG_INFLIGHT = 'otel.sdk.exporter.log.inflight' - # The number of metric data points for which the export has finished, either successful or failed + # The number of metric data points for which the export has finished, either successful or failed. # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # For exporters with partial success semantics (e.g. OTLP with `rejected_data_points`), rejected data points MUST count as failed and only non-rejected data points count as success. @@ -49,7 +49,7 @@ module OTEL # @note Stability Level: development OTEL_SDK_EXPORTER_METRIC_DATA_POINT_EXPORTED = 'otel.sdk.exporter.metric_data_point.exported' - # The number of metric data points which were passed to the exporter, but that have not been exported yet (neither successful, nor failed) + # The number of metric data points which were passed to the exporter, but that have not been exported yet (neither successful, nor failed). # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # @@ -65,7 +65,7 @@ module OTEL # @note Stability Level: development OTEL_SDK_EXPORTER_OPERATION_DURATION = 'otel.sdk.exporter.operation.duration' - # The number of spans for which the export has finished, either successful or failed + # The number of spans for which the export has finished, either successful or failed. # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # For exporters with partial success semantics (e.g. OTLP with `rejected_spans`), rejected spans MUST count as failed and only non-rejected spans count as success. @@ -80,7 +80,7 @@ module OTEL # @deprecated {"note": "Replaced by `otel.sdk.exporter.span.exported`.", "reason": "renamed", "renamed_to": "otel.sdk.exporter.span.exported"} OTEL_SDK_EXPORTER_SPAN_EXPORTED_COUNT = 'otel.sdk.exporter.span.exported.count' - # The number of spans which were passed to the exporter, but that have not been exported yet (neither successful, nor failed) + # The number of spans which were passed to the exporter, but that have not been exported yet (neither successful, nor failed). # # For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` MUST contain the failure cause. # @@ -93,7 +93,7 @@ module OTEL # @deprecated {"note": "Replaced by `otel.sdk.exporter.span.inflight`.", "reason": "renamed", "renamed_to": "otel.sdk.exporter.span.inflight"} OTEL_SDK_EXPORTER_SPAN_INFLIGHT_COUNT = 'otel.sdk.exporter.span.inflight.count' - # The number of logs submitted to enabled SDK Loggers + # The number of logs submitted to enabled SDK Loggers. # # @note Stability Level: development OTEL_SDK_LOG_CREATED = 'otel.sdk.log.created' @@ -106,7 +106,7 @@ module OTEL # @note Stability Level: development OTEL_SDK_METRIC_READER_COLLECTION_DURATION = 'otel.sdk.metric_reader.collection.duration' - # The number of log records for which the processing has finished, either successful or failed + # The number of log records for which the processing has finished, either successful or failed. # # For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` MUST contain the failure cause. # For the SDK Simple and Batching Log Record Processor a log record is considered to be processed already when it has been submitted to the exporter, @@ -115,21 +115,21 @@ module OTEL # @note Stability Level: development OTEL_SDK_PROCESSOR_LOG_PROCESSED = 'otel.sdk.processor.log.processed' - # The maximum number of log records the queue of a given instance of an SDK Log Record processor can hold + # The maximum number of log records the queue of a given instance of an SDK Log Record processor can hold. # # Only applies to Log Record processors which use a queue, e.g. the SDK Batching Log Record Processor. # # @note Stability Level: development OTEL_SDK_PROCESSOR_LOG_QUEUE_CAPACITY = 'otel.sdk.processor.log.queue.capacity' - # The number of log records in the queue of a given instance of an SDK log processor + # The number of log records in the queue of a given instance of an SDK log processor. # # Only applies to log record processors which use a queue, e.g. the SDK Batching Log Record Processor. # # @note Stability Level: development OTEL_SDK_PROCESSOR_LOG_QUEUE_SIZE = 'otel.sdk.processor.log.queue.size' - # The number of spans for which the processing has finished, either successful or failed + # The number of spans for which the processing has finished, either successful or failed. # # For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` MUST contain the failure cause. # For the SDK Simple and Batching Span Processor a span is considered to be processed already when it has been submitted to the exporter, not when the corresponding export call has finished. @@ -143,14 +143,14 @@ module OTEL # @deprecated {"note": "Replaced by `otel.sdk.processor.span.processed`.", "reason": "renamed", "renamed_to": "otel.sdk.processor.span.processed"} OTEL_SDK_PROCESSOR_SPAN_PROCESSED_COUNT = 'otel.sdk.processor.span.processed.count' - # The maximum number of spans the queue of a given instance of an SDK span processor can hold + # The maximum number of spans the queue of a given instance of an SDK span processor can hold. # # Only applies to span processors which use a queue, e.g. the SDK Batching Span Processor. # # @note Stability Level: development OTEL_SDK_PROCESSOR_SPAN_QUEUE_CAPACITY = 'otel.sdk.processor.span.queue.capacity' - # The number of spans in the queue of a given instance of an SDK span processor + # The number of spans in the queue of a given instance of an SDK span processor. # # Only applies to span processors which use a queue, e.g. the SDK Batching Span Processor. # @@ -169,7 +169,7 @@ module OTEL # @deprecated {"note": "Obsoleted.", "reason": "obsoleted"} OTEL_SDK_SPAN_ENDED_COUNT = 'otel.sdk.span.ended.count' - # The number of created spans with `recording=true` for which the end operation has not been called yet + # The number of created spans with `recording=true` for which the end operation has not been called yet. # # @note Stability Level: development OTEL_SDK_SPAN_LIVE = 'otel.sdk.span.live' @@ -180,7 +180,7 @@ module OTEL # @deprecated {"note": "Replaced by `otel.sdk.span.live`.", "reason": "renamed", "renamed_to": "otel.sdk.span.live"} OTEL_SDK_SPAN_LIVE_COUNT = 'otel.sdk.span.live.count' - # The number of created spans + # The number of created spans. # # Implementations MUST record this metric for all spans, even for non-recording ones. # diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb index 2288f2383e..83bbf6d535 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb @@ -29,7 +29,7 @@ module OTHER # @note Stability Level: development # # @example Sample Values - # idle + # # idle # # @deprecated {"note": "Replaced by `db.client.connection.state`.", "reason": "renamed", "renamed_to": "db.client.connection.state"} STATE = 'state' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb index 4d9c1c56a3..28dbe7e4c2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb @@ -29,7 +29,7 @@ module POOL # @note Stability Level: development # # @example Sample Values - # myDataSource + # # myDataSource # # @deprecated {"note": "Replaced by `db.client.connection.pool.name`.", "reason": "renamed", "renamed_to": "db.client.connection.pool.name"} POOL_NAME = 'pool.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb index 3bf1e0c4fe..cbe4a1aad1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb @@ -31,7 +31,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 4 + # # 4 # PROCESS_ARGS_COUNT = 'process.args_count' @@ -40,7 +40,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # cmd/otelcol + # # cmd/otelcol # PROCESS_COMMAND = 'process.command' @@ -49,8 +49,8 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # ["cmd/otecol", "--config=config.yaml"] - # + # # cmd/otecol + # --config=config.yaml PROCESS_COMMAND_ARGS = 'process.command_args' # The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data. @@ -58,7 +58,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # C:\cmd\otecol --config="my directory\config.yaml" + # # C:\cmd\otecol --config="my directory\config.yaml" # PROCESS_COMMAND_LINE = 'process.command_line' @@ -78,7 +78,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 2023-11-21T09:25:34.853Z + # # 2023-11-21T09:25:34.853Z # PROCESS_CREATION_TIME = 'process.creation.time' @@ -101,8 +101,8 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # ubuntu - # /usr/local/bin:/usr/bin + # # ubuntu + # # /usr/local/bin:/usr/bin # PROCESS_ENVIRONMENT_VARIABLE_LAMBDA = ->(key) { "process.environment_variable.#{key}" } @@ -111,7 +111,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # c89b11207f6479603b0d49bf291c092c2b719293 + # # c89b11207f6479603b0d49bf291c092c2b719293 # PROCESS_EXECUTABLE_BUILD_ID_GNU = 'process.executable.build_id.gnu' @@ -120,7 +120,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY + # # foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY # PROCESS_EXECUTABLE_BUILD_ID_GO = 'process.executable.build_id.go' @@ -129,7 +129,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 600DCAFE4A110000F2BF38C493F5FB92 + # # 600DCAFE4A110000F2BF38C493F5FB92 # PROCESS_EXECUTABLE_BUILD_ID_HTLHASH = 'process.executable.build_id.htlhash' @@ -138,7 +138,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 600DCAFE4A110000F2BF38C493F5FB92 + # # 600DCAFE4A110000F2BF38C493F5FB92 # # @deprecated {"note": "Replaced by `process.executable.build_id.htlhash`.", "reason": "renamed", "renamed_to": "process.executable.build_id.htlhash"} PROCESS_EXECUTABLE_BUILD_ID_PROFILING = 'process.executable.build_id.profiling' @@ -148,7 +148,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # otelcol + # # otelcol # PROCESS_EXECUTABLE_NAME = 'process.executable.name' @@ -157,7 +157,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # /usr/bin/cmd/otelcol + # # /usr/bin/cmd/otelcol # PROCESS_EXECUTABLE_PATH = 'process.executable.path' @@ -166,7 +166,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 127 + # # 127 # PROCESS_EXIT_CODE = 'process.exit.code' @@ -175,7 +175,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 2023-11-21T09:26:12.315Z + # # 2023-11-21T09:26:12.315Z # PROCESS_EXIT_TIME = 'process.exit.time' @@ -184,7 +184,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 23 + # # 23 # PROCESS_GROUP_LEADER_PID = 'process.group_leader.pid' @@ -200,8 +200,8 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 1:name=systemd:/user.slice/user-1000.slice/session-3.scope - # 0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope + # # 1:name=systemd:/user.slice/user-1000.slice/session-3.scope + # # 0::/user.slice/user-1000.slice/user@1000.service/tmux-spawn-0267755b-4639-4a27-90ed-f19f88e53748.scope # PROCESS_LINUX_CGROUP = 'process.linux.cgroup' @@ -210,7 +210,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # root + # # root # PROCESS_OWNER = 'process.owner' @@ -224,7 +224,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 111 + # # 111 # PROCESS_PARENT_PID = 'process.parent_pid' @@ -233,7 +233,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 1234 + # # 1234 # PROCESS_PID = 'process.pid' @@ -242,7 +242,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 1000 + # # 1000 # PROCESS_REAL_USER_ID = 'process.real_user.id' @@ -251,7 +251,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # operator + # # operator # PROCESS_REAL_USER_NAME = 'process.real_user.name' @@ -269,7 +269,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # OpenJDK Runtime Environment + # # OpenJDK Runtime Environment # PROCESS_RUNTIME_NAME = 'process.runtime.name' @@ -287,7 +287,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 1002 + # # 1002 # PROCESS_SAVED_USER_ID = 'process.saved_user.id' @@ -296,7 +296,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # operator + # # operator # PROCESS_SAVED_USER_NAME = 'process.saved_user.name' @@ -305,7 +305,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 14 + # # 14 # PROCESS_SESSION_LEADER_PID = 'process.session_leader.pid' @@ -316,9 +316,9 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # cat /etc/hostname - # xfce4-session - # bash + # # cat /etc/hostname + # # xfce4-session + # # bash # PROCESS_TITLE = 'process.title' @@ -327,7 +327,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 1001 + # # 1001 # PROCESS_USER_ID = 'process.user.id' @@ -336,7 +336,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # root + # # root # PROCESS_USER_NAME = 'process.user.name' @@ -347,7 +347,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # 12 + # # 12 # PROCESS_VPID = 'process.vpid' @@ -356,7 +356,7 @@ module PROCESS # @note Stability Level: development # # @example Sample Values - # /root + # # /root # PROCESS_WORKING_DIRECTORY = 'process.working_directory' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/profile/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/profile/attributes.rb index ae2d365aa4..0131617153 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/profile/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/profile/attributes.rb @@ -29,7 +29,7 @@ module PROFILE # @note Stability Level: development # # @example Sample Values - # cpython + # # cpython # PROFILE_FRAME_TYPE = 'profile.frame.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb index 4eccd61557..17e8b0c911 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb @@ -46,8 +46,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # ["1.2.3.4", "1.2.3.5"] - # + # # 1.2.3.4 + # 1.2.3.5 RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.request.metadata.#{key}" } # Must be called with a key for the full attribute name. See notes below about the expectations @@ -67,7 +67,7 @@ module RPC # @note Stability Level: development # # @example Sample Values - # ["attribute_value"] + # # attribute_value # RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.response.metadata.#{key}" } @@ -88,8 +88,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # ["1.2.3.4", "1.2.3.5"] - # + # # 1.2.3.4 + # 1.2.3.5 RPC_GRPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.grpc.request.metadata.#{key}" } # Must be called with a key for the full attribute name. See notes below about the expectations @@ -109,7 +109,7 @@ module RPC # @note Stability Level: development # # @example Sample Values - # ["attribute_value"] + # # attribute_value # RPC_GRPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.grpc.response.metadata.#{key}" } @@ -123,8 +123,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # -32700 - # 100 + # # -32700 + # # 100 # RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' @@ -133,8 +133,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # Parse error - # User already exists + # # Parse error + # # User already exists # RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' @@ -143,8 +143,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # 10 - # request-7 + # # 10 + # # request-7 # # RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' @@ -154,8 +154,8 @@ module RPC # @note Stability Level: development # # @example Sample Values - # 2.0 - # 1.0 + # # 2.0 + # # 1.0 # RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb index d14c0dfa96..ed10504c35 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb @@ -29,7 +29,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # Attempted Information Leak + # # Attempted Information Leak # SECURITY_RULE_CATEGORY = 'security_rule.category' @@ -38,7 +38,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # Block requests to public DNS over HTTPS / TLS protocols + # # Block requests to public DNS over HTTPS / TLS protocols # SECURITY_RULE_DESCRIPTION = 'security_rule.description' @@ -47,7 +47,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # Apache 2.0 + # # Apache 2.0 # SECURITY_RULE_LICENSE = 'security_rule.license' @@ -56,7 +56,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # BLOCK_DNS_over_TLS + # # BLOCK_DNS_over_TLS # SECURITY_RULE_NAME = 'security_rule.name' @@ -67,7 +67,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # https://en.wikipedia.org/wiki/DNS_over_TLS + # # https://en.wikipedia.org/wiki/DNS_over_TLS # SECURITY_RULE_REFERENCE = 'security_rule.reference' @@ -76,7 +76,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # Standard_Protocol_Filters + # # Standard_Protocol_Filters # SECURITY_RULE_RULESET_NAME = 'security_rule.ruleset.name' @@ -85,8 +85,8 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # 550e8400-e29b-41d4-a716-446655440000 - # 1100110011 + # # 550e8400-e29b-41d4-a716-446655440000 + # # 1100110011 # SECURITY_RULE_UUID = 'security_rule.uuid' @@ -95,7 +95,7 @@ module SECURITY_RULE # @note Stability Level: development # # @example Sample Values - # 1.0.0 + # # 1.0.0 # SECURITY_RULE_VERSION = 'security_rule.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb index 75c566d4ea..f510247f45 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb @@ -31,9 +31,9 @@ module SERVER # @note Stability Level: stable # # @example Sample Values - # example.com - # 10.1.2.80 - # /tmp/my.sock + # # example.com + # # 10.1.2.80 + # # /tmp/my.sock # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}. @@ -46,9 +46,9 @@ module SERVER # @note Stability Level: stable # # @example Sample Values - # 80 - # 8080 - # 443 + # # 80 + # # 8080 + # # 443 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb index c954d4d7c9..5208376a38 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb @@ -56,7 +56,7 @@ module SERVICE # @note Stability Level: development # # @example Sample Values - # 627cc493-f310-47de-96bd-71410b7dec09 + # # 627cc493-f310-47de-96bd-71410b7dec09 # SERVICE_INSTANCE_ID = 'service.instance.id' @@ -67,7 +67,7 @@ module SERVICE # @note Stability Level: stable # # @example Sample Values - # shoppingcart + # # shoppingcart # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_NAME}. @@ -80,7 +80,7 @@ module SERVICE # @note Stability Level: development # # @example Sample Values - # Shop + # # Shop # SERVICE_NAMESPACE = 'service.namespace' @@ -89,8 +89,8 @@ module SERVICE # @note Stability Level: stable # # @example Sample Values - # 2.0.0 - # a01dbef8a + # # 2.0.0 + # # a01dbef8a # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_VERSION}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb index e4f09941e4..591a2d3839 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb @@ -29,8 +29,8 @@ module SIGNALR # @note Stability Level: stable # # @example Sample Values - # app_shutdown - # timeout + # # app_shutdown + # # timeout # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_CONNECTION_STATUS}. @@ -41,8 +41,8 @@ module SIGNALR # @note Stability Level: stable # # @example Sample Values - # web_sockets - # long_polling + # # web_sockets + # # long_polling # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_TRANSPORT}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb index 370715df99..c87023f7c7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb @@ -31,9 +31,9 @@ module SOURCE # @note Stability Level: development # # @example Sample Values - # source.example.com - # 10.1.2.80 - # /tmp/my.sock + # # source.example.com + # # 10.1.2.80 + # # /tmp/my.sock # SOURCE_ADDRESS = 'source.address' @@ -42,8 +42,8 @@ module SOURCE # @note Stability Level: development # # @example Sample Values - # 3389 - # 2888 + # # 3389 + # # 2888 # SOURCE_PORT = 'source.port' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb index 85de4aa7b3..fc24d035ed 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb @@ -29,7 +29,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # 1 + # # 1 # SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' @@ -38,8 +38,8 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # idle - # interrupt + # # idle + # # interrupt # # @deprecated {"note": "Replaced by `cpu.mode`.", "reason": "renamed", "renamed_to": "cpu.mode"} SYSTEM_CPU_STATE = 'system.cpu.state' @@ -49,7 +49,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # (identifier) + # # (identifier) # SYSTEM_DEVICE = 'system.device' @@ -58,7 +58,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # rw, ro + # # rw, ro # SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode' @@ -67,7 +67,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # /mnt/data + # # /mnt/data # SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint' @@ -76,7 +76,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # used + # # used # SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state' @@ -85,7 +85,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # ext4 + # # ext4 # SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type' @@ -94,8 +94,8 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # free - # cached + # # free + # # cached # SYSTEM_MEMORY_STATE = 'system.memory.state' @@ -104,7 +104,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # close_wait + # # close_wait # # @deprecated {"note": "Replaced by `network.connection.state`.", "reason": "renamed", "renamed_to": "network.connection.state"} SYSTEM_NETWORK_STATE = 'system.network.state' @@ -114,7 +114,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # in + # # in # SYSTEM_PAGING_DIRECTION = 'system.paging.direction' @@ -123,7 +123,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # free + # # free # SYSTEM_PAGING_STATE = 'system.paging.state' @@ -132,7 +132,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # minor + # # minor # SYSTEM_PAGING_TYPE = 'system.paging.type' @@ -141,7 +141,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # running + # # running # SYSTEM_PROCESS_STATUS = 'system.process.status' @@ -150,7 +150,7 @@ module SYSTEM # @note Stability Level: development # # @example Sample Values - # running + # # running # # @deprecated {"note": "Replaced by `system.process.status`.", "reason": "renamed", "renamed_to": "system.process.status"} SYSTEM_PROCESSES_STATUS = 'system.processes.status' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb index 041cea5434..35f2ad261c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb @@ -29,21 +29,21 @@ module SYSTEM # @note Stability Level: development SYSTEM_CPU_FREQUENCY = 'system.cpu.frequency' - # Reports the number of logical (virtual) processor cores created by the operating system to manage multitasking + # Reports the number of logical (virtual) processor cores created by the operating system to manage multitasking. # # Calculated by multiplying the number of sockets by the number of cores per socket, and then by the number of threads per core # # @note Stability Level: development SYSTEM_CPU_LOGICAL_COUNT = 'system.cpu.logical.count' - # Reports the number of actual physical processor cores on the hardware + # Reports the number of actual physical processor cores on the hardware. # # Calculated by multiplying the number of sockets by the number of cores per socket # # @note Stability Level: development SYSTEM_CPU_PHYSICAL_COUNT = 'system.cpu.physical.count' - # Seconds each logical CPU spent on each mode + # Seconds each logical CPU spent on each mode. # # @note Stability Level: development SYSTEM_CPU_TIME = 'system.cpu.time' @@ -53,10 +53,12 @@ module SYSTEM # @note Stability Level: development SYSTEM_CPU_UTILIZATION = 'system.cpu.utilization' + # TODO. + # # @note Stability Level: development SYSTEM_DISK_IO = 'system.disk.io' - # Time disk spent activated + # Time disk spent activated. # # The real elapsed time ("wall clock") used in the I/O path (time from operations running in parallel are not counted). Measured as: # @@ -68,15 +70,17 @@ module SYSTEM # @note Stability Level: development SYSTEM_DISK_IO_TIME = 'system.disk.io_time' - # The total storage capacity of the disk + # The total storage capacity of the disk. # # @note Stability Level: development SYSTEM_DISK_LIMIT = 'system.disk.limit' + # TODO. + # # @note Stability Level: development SYSTEM_DISK_MERGED = 'system.disk.merged' - # Sum of the time each operation took to complete + # Sum of the time each operation took to complete. # # Because it is the sum of time each request took, parallel-issued requests each contribute to make the count grow. Measured as: # @@ -86,10 +90,12 @@ module SYSTEM # @note Stability Level: development SYSTEM_DISK_OPERATION_TIME = 'system.disk.operation_time' + # TODO. + # # @note Stability Level: development SYSTEM_DISK_OPERATIONS = 'system.disk.operations' - # The total storage capacity of the filesystem + # The total storage capacity of the filesystem. # # @note Stability Level: development SYSTEM_FILESYSTEM_LIMIT = 'system.filesystem.limit' @@ -102,10 +108,12 @@ module SYSTEM # @note Stability Level: development SYSTEM_FILESYSTEM_USAGE = 'system.filesystem.usage' + # TODO. + # # @note Stability Level: development SYSTEM_FILESYSTEM_UTILIZATION = 'system.filesystem.utilization' - # An estimate of how much memory is available for starting new applications, without causing swapping + # An estimate of how much memory is available for starting new applications, without causing swapping. # # This is an alternative to `system.memory.usage` metric with `state=free`. # Linux starting from 3.14 exports "available" memory. It takes "free" memory as a baseline, and then factors in kernel-specific values. @@ -125,9 +133,7 @@ module SYSTEM # @note Stability Level: development SYSTEM_LINUX_MEMORY_SLAB_USAGE = 'system.linux.memory.slab.usage' - # Total memory available in the system. - # - # Its value SHOULD equal the sum of `system.memory.state` over all states. + # Total virtual memory available in the system. # # @note Stability Level: development SYSTEM_MEMORY_LIMIT = 'system.memory.limit' @@ -142,77 +148,88 @@ module SYSTEM # Reports memory in use by state. # - # The sum over all `system.memory.state` values SHOULD equal the total memory - # available on the system, that is `system.memory.limit`. - # # @note Stability Level: development SYSTEM_MEMORY_USAGE = 'system.memory.usage' + # TODO. + # # @note Stability Level: development SYSTEM_MEMORY_UTILIZATION = 'system.memory.utilization' + # TODO. + # # @note Stability Level: development SYSTEM_NETWORK_CONNECTION_COUNT = 'system.network.connection.count' - # Deprecated, use `system.network.connection.count` instead + # Deprecated, use `system.network.connection.count` instead. # # @note Stability Level: development # @deprecated {"note": "Replaced by `system.network.connection.count`.", "reason": "renamed", "renamed_to": "system.network.connection.count"} SYSTEM_NETWORK_CONNECTIONS = 'system.network.connections' - # Count of packets that are dropped or discarded even though there was no error + # Count of network errors detected. # # Measured as: # - # - Linux: the `drop` column in `/proc/dev/net` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)) - # - Windows: [`InDiscards`/`OutDiscards`](https://docs.microsoft.com/windows/win32/api/netioapi/ns-netioapi-mib_if_row2) - # from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2) - # - # @note Stability Level: development - SYSTEM_NETWORK_DROPPED = 'system.network.dropped' - - # Count of network errors detected - # - # Measured as: - # - # - Linux: the `errs` column in `/proc/dev/net` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)). + # - Linux: the `errs` column in `/proc/net/dev` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)). # - Windows: [`InErrors`/`OutErrors`](https://docs.microsoft.com/windows/win32/api/netioapi/ns-netioapi-mib_if_row2) # from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2). # # @note Stability Level: development SYSTEM_NETWORK_ERRORS = 'system.network.errors' + # TODO. + # # @note Stability Level: development SYSTEM_NETWORK_IO = 'system.network.io' + # TODO. + # + # @note Stability Level: development + SYSTEM_NETWORK_PACKET_COUNT = 'system.network.packet.count' + + # Count of packets that are dropped or discarded even though there was no error. + # + # Measured as: + # + # - Linux: the `drop` column in `/proc/net/dev` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)) + # - Windows: [`InDiscards`/`OutDiscards`](https://docs.microsoft.com/windows/win32/api/netioapi/ns-netioapi-mib_if_row2) + # from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2) + # # @note Stability Level: development - SYSTEM_NETWORK_PACKETS = 'system.network.packets' + SYSTEM_NETWORK_PACKET_DROPPED = 'system.network.packet.dropped' + # TODO. + # # @note Stability Level: development SYSTEM_PAGING_FAULTS = 'system.paging.faults' + # TODO. + # # @note Stability Level: development SYSTEM_PAGING_OPERATIONS = 'system.paging.operations' - # Unix swap or windows pagefile usage + # Unix swap or windows pagefile usage. # # @note Stability Level: development SYSTEM_PAGING_USAGE = 'system.paging.usage' + # TODO. + # # @note Stability Level: development SYSTEM_PAGING_UTILIZATION = 'system.paging.utilization' - # Total number of processes in each state + # Total number of processes in each state. # # @note Stability Level: development SYSTEM_PROCESS_COUNT = 'system.process.count' - # Total number of processes created over uptime of the host + # Total number of processes created over uptime of the host. # # @note Stability Level: development SYSTEM_PROCESS_CREATED = 'system.process.created' - # The time the system has been running + # The time the system has been running. # # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. # The actual accuracy would depend on the instrumentation and operating system. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb index 594717a6c5..ebbb19a1e7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb @@ -32,7 +32,7 @@ module TELEMETRY # @note Stability Level: development # # @example Sample Values - # parts-unlimited-java + # # parts-unlimited-java # TELEMETRY_DISTRO_NAME = 'telemetry.distro.name' @@ -41,7 +41,7 @@ module TELEMETRY # @note Stability Level: development # # @example Sample Values - # 1.2.3 + # # 1.2.3 # TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version' @@ -64,7 +64,7 @@ module TELEMETRY # @note Stability Level: stable # # @example Sample Values - # opentelemetry + # # opentelemetry # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_NAME}. @@ -75,7 +75,7 @@ module TELEMETRY # @note Stability Level: stable # # @example Sample Values - # 1.2.3 + # # 1.2.3 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_VERSION}. diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/test/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/test/attributes.rb index 0af7eebb77..9ba26232fa 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/test/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/test/attributes.rb @@ -29,9 +29,9 @@ module TEST # @note Stability Level: development # # @example Sample Values - # org.example.TestCase1.test1 - # example/tests/TestCase1.test1 - # ExampleTestCase1_test1 + # # org.example.TestCase1.test1 + # # example/tests/TestCase1.test1 + # # ExampleTestCase1_test1 # TEST_CASE_NAME = 'test.case.name' @@ -40,8 +40,8 @@ module TEST # @note Stability Level: development # # @example Sample Values - # pass - # fail + # # pass + # # fail # TEST_CASE_RESULT_STATUS = 'test.case.result.status' @@ -50,7 +50,7 @@ module TEST # @note Stability Level: development # # @example Sample Values - # TestSuite1 + # # TestSuite1 # TEST_SUITE_NAME = 'test.suite.name' @@ -59,12 +59,12 @@ module TEST # @note Stability Level: development # # @example Sample Values - # success - # failure - # skipped - # aborted - # timed_out - # in_progress + # # success + # # failure + # # skipped + # # aborted + # # timed_out + # # in_progress # TEST_SUITE_RUN_STATUS = 'test.suite.run.status' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb index 5595496e35..b0b19a49e4 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb @@ -31,8 +31,8 @@ module TLS # @note Stability Level: development # # @example Sample Values - # TLS_RSA_WITH_3DES_EDE_CBC_SHA - # TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + # # TLS_RSA_WITH_3DES_EDE_CBC_SHA + # # TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 # TLS_CIPHER = 'tls.cipher' @@ -41,7 +41,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # MII... + # # MII... # TLS_CLIENT_CERTIFICATE = 'tls.client.certificate' @@ -50,8 +50,8 @@ module TLS # @note Stability Level: development # # @example Sample Values - # ["MII...", "MI..."] - # + # # MII... + # MI... TLS_CLIENT_CERTIFICATE_CHAIN = 'tls.client.certificate_chain' # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -59,7 +59,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC + # # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC # TLS_CLIENT_HASH_MD5 = 'tls.client.hash.md5' @@ -68,7 +68,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 9E393D93138888D288266C2D915214D1D1CCEB2A + # # 9E393D93138888D288266C2D915214D1D1CCEB2A # TLS_CLIENT_HASH_SHA1 = 'tls.client.hash.sha1' @@ -77,7 +77,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 + # # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 # TLS_CLIENT_HASH_SHA256 = 'tls.client.hash.sha256' @@ -86,7 +86,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com + # # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com # TLS_CLIENT_ISSUER = 'tls.client.issuer' @@ -95,7 +95,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # d4e5b18d6b55c71272893221c96ba240 + # # d4e5b18d6b55c71272893221c96ba240 # TLS_CLIENT_JA3 = 'tls.client.ja3' @@ -104,7 +104,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 2021-01-01T00:00:00.000Z + # # 2021-01-01T00:00:00.000Z # TLS_CLIENT_NOT_AFTER = 'tls.client.not_after' @@ -113,7 +113,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 1970-01-01T00:00:00.000Z + # # 1970-01-01T00:00:00.000Z # TLS_CLIENT_NOT_BEFORE = 'tls.client.not_before' @@ -122,7 +122,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # opentelemetry.io + # # opentelemetry.io # # @deprecated {"note": "Replaced by `server.address`.", "reason": "renamed", "renamed_to": "server.address"} TLS_CLIENT_SERVER_NAME = 'tls.client.server_name' @@ -132,7 +132,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # CN=myclient, OU=Documentation Team, DC=example, DC=com + # # CN=myclient, OU=Documentation Team, DC=example, DC=com # TLS_CLIENT_SUBJECT = 'tls.client.subject' @@ -141,8 +141,8 @@ module TLS # @note Stability Level: development # # @example Sample Values - # ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"] - # + # # TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + # TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_CLIENT_SUPPORTED_CIPHERS = 'tls.client.supported_ciphers' # String indicating the curve used for the given cipher, when applicable @@ -150,7 +150,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # secp256r1 + # # secp256r1 # TLS_CURVE = 'tls.curve' @@ -159,7 +159,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # true + # # true # TLS_ESTABLISHED = 'tls.established' @@ -168,7 +168,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # http/1.1 + # # http/1.1 # TLS_NEXT_PROTOCOL = 'tls.next_protocol' @@ -182,8 +182,8 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 1.2 - # 3 + # # 1.2 + # # 3 # TLS_PROTOCOL_VERSION = 'tls.protocol.version' @@ -192,7 +192,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # true + # # true # TLS_RESUMED = 'tls.resumed' @@ -201,7 +201,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # MII... + # # MII... # TLS_SERVER_CERTIFICATE = 'tls.server.certificate' @@ -210,8 +210,8 @@ module TLS # @note Stability Level: development # # @example Sample Values - # ["MII...", "MI..."] - # + # # MII... + # MI... TLS_SERVER_CERTIFICATE_CHAIN = 'tls.server.certificate_chain' # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -219,7 +219,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC + # # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC # TLS_SERVER_HASH_MD5 = 'tls.server.hash.md5' @@ -228,7 +228,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 9E393D93138888D288266C2D915214D1D1CCEB2A + # # 9E393D93138888D288266C2D915214D1D1CCEB2A # TLS_SERVER_HASH_SHA1 = 'tls.server.hash.sha1' @@ -237,7 +237,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 + # # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 # TLS_SERVER_HASH_SHA256 = 'tls.server.hash.sha256' @@ -246,7 +246,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com + # # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com # TLS_SERVER_ISSUER = 'tls.server.issuer' @@ -255,7 +255,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # d4e5b18d6b55c71272893221c96ba240 + # # d4e5b18d6b55c71272893221c96ba240 # TLS_SERVER_JA3S = 'tls.server.ja3s' @@ -264,7 +264,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 2021-01-01T00:00:00.000Z + # # 2021-01-01T00:00:00.000Z # TLS_SERVER_NOT_AFTER = 'tls.server.not_after' @@ -273,7 +273,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # 1970-01-01T00:00:00.000Z + # # 1970-01-01T00:00:00.000Z # TLS_SERVER_NOT_BEFORE = 'tls.server.not_before' @@ -282,7 +282,7 @@ module TLS # @note Stability Level: development # # @example Sample Values - # CN=myserver, OU=Documentation Team, DC=example, DC=com + # # CN=myserver, OU=Documentation Team, DC=example, DC=com # TLS_SERVER_SUBJECT = 'tls.server.subject' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb index 63a597f0f5..87501177a0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb @@ -31,10 +31,10 @@ module URL # @note Stability Level: development # # @example Sample Values - # www.foo.bar - # opentelemetry.io - # 3.12.167.2 - # [1080:0:0:0:8:800:200C:417A] + # # www.foo.bar + # # opentelemetry.io + # # 3.12.167.2 + # # [1080:0:0:0:8:800:200C:417A] # URL_DOMAIN = 'url.domain' @@ -45,8 +45,8 @@ module URL # @note Stability Level: development # # @example Sample Values - # png - # gz + # # png + # # gz # URL_EXTENSION = 'url.extension' @@ -55,7 +55,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # SemConv + # # SemConv # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FRAGMENT}. @@ -90,8 +90,8 @@ module URL # @note Stability Level: stable # # @example Sample Values - # https://www.foo.bar/search?q=OpenTelemetry#SemConv - # //localhost + # # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # # //localhost # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FULL}. @@ -105,8 +105,8 @@ module URL # @note Stability Level: development # # @example Sample Values - # https://www.foo.bar/search?q=OpenTelemetry#SemConv - # search?q=OpenTelemetry + # # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # # search?q=OpenTelemetry # URL_ORIGINAL = 'url.original' @@ -117,7 +117,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # /search + # # /search # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_PATH}. @@ -128,7 +128,7 @@ module URL # @note Stability Level: development # # @example Sample Values - # 443 + # # 443 # URL_PORT = 'url.port' @@ -152,7 +152,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # q=OpenTelemetry + # # q=OpenTelemetry # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_QUERY}. @@ -165,8 +165,8 @@ module URL # @note Stability Level: development # # @example Sample Values - # example.com - # foo.co.uk + # # example.com + # # foo.co.uk # URL_REGISTERED_DOMAIN = 'url.registered_domain' @@ -175,9 +175,9 @@ module URL # @note Stability Level: stable # # @example Sample Values - # https - # ftp - # telnet + # # https + # # ftp + # # telnet # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_SCHEME}. @@ -190,8 +190,8 @@ module URL # @note Stability Level: development # # @example Sample Values - # east - # sub2.sub1 + # # east + # # sub2.sub1 # URL_SUBDOMAIN = 'url.subdomain' @@ -200,9 +200,9 @@ module URL # @note Stability Level: development # # @example Sample Values - # /users/{id} - # /users/:id - # /users?id={id} + # # /users/{id} + # # /users/:id + # # /users?id={id} # URL_TEMPLATE = 'url.template' @@ -213,8 +213,8 @@ module URL # @note Stability Level: development # # @example Sample Values - # com - # co.uk + # # com + # # co.uk # URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/user/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user/attributes.rb index 32432944d1..724c2b3e77 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/user/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/user/attributes.rb @@ -29,7 +29,7 @@ module USER # @note Stability Level: development # # @example Sample Values - # a.einstein@example.com + # # a.einstein@example.com # USER_EMAIL = 'user.email' @@ -38,7 +38,7 @@ module USER # @note Stability Level: development # # @example Sample Values - # Albert Einstein + # # Albert Einstein # USER_FULL_NAME = 'user.full_name' @@ -49,7 +49,7 @@ module USER # @note Stability Level: development # # @example Sample Values - # 364fc68eaf4c8acec74a4e52d7d1feaa + # # 364fc68eaf4c8acec74a4e52d7d1feaa # USER_HASH = 'user.hash' @@ -58,7 +58,7 @@ module USER # @note Stability Level: development # # @example Sample Values - # S-1-5-21-202424912787-2692429404-2351956786-1000 + # # S-1-5-21-202424912787-2692429404-2351956786-1000 # USER_ID = 'user.id' @@ -67,7 +67,7 @@ module USER # @note Stability Level: development # # @example Sample Values - # a.einstein + # # a.einstein # USER_NAME = 'user.name' @@ -76,8 +76,8 @@ module USER # @note Stability Level: development # # @example Sample Values - # ["admin", "reporting_user"] - # + # # admin + # reporting_user USER_ROLES = 'user.roles' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb index 25bf4a73bc..cd15451320 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb @@ -31,8 +31,8 @@ module USER_AGENT # @note Stability Level: development # # @example Sample Values - # Safari - # YourApp + # # Safari + # # YourApp # USER_AGENT_NAME = 'user_agent.name' @@ -41,9 +41,9 @@ module USER_AGENT # @note Stability Level: stable # # @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 + # # 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 # # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::USER_AGENT::USER_AGENT_ORIGINAL}. @@ -56,9 +56,9 @@ module USER_AGENT # @note Stability Level: development # # @example Sample Values - # iOS - # Android - # Ubuntu + # # iOS + # # Android + # # Ubuntu # USER_AGENT_OS_NAME = 'user_agent.os.name' @@ -69,8 +69,8 @@ module USER_AGENT # @note Stability Level: development # # @example Sample Values - # 14.2.1 - # 18.04.1 + # # 14.2.1 + # # 18.04.1 # USER_AGENT_OS_VERSION = 'user_agent.os.version' @@ -88,8 +88,8 @@ module USER_AGENT # @note Stability Level: development # # @example Sample Values - # 14.1.2 - # 1.0.0 + # # 14.1.2 + # # 1.0.0 # USER_AGENT_VERSION = 'user_agent.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/attributes.rb index 2daed9e7ae..9b47ea6fab 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/attributes.rb @@ -29,7 +29,7 @@ module VCS # @note Stability Level: development # # @example Sample Values - # 123 + # # 123 # VCS_CHANGE_ID = 'vcs.change.id' @@ -38,9 +38,9 @@ module VCS # @note Stability Level: development # # @example Sample Values - # open - # closed - # merged + # # open + # # closed + # # merged # VCS_CHANGE_STATE = 'vcs.change.state' @@ -49,9 +49,9 @@ module VCS # @note Stability Level: development # # @example Sample Values - # Fixes broken thing - # feat: add my new feature - # [chore] update dependency + # # Fixes broken thing + # # feat: add my new feature + # # [chore] update dependency # VCS_CHANGE_TITLE = 'vcs.change.title' @@ -60,8 +60,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # added - # removed + # # added + # # removed # VCS_LINE_CHANGE_TYPE = 'vcs.line_change.type' @@ -70,9 +70,9 @@ module VCS # @note Stability Level: development # # @example Sample Values - # my-org - # myteam - # business-unit + # # my-org + # # myteam + # # business-unit # VCS_OWNER_NAME = 'vcs.owner.name' @@ -81,10 +81,10 @@ module VCS # @note Stability Level: development # # @example Sample Values - # github - # gitlab - # gitea - # bitbucket + # # github + # # gitlab + # # gitea + # # bitbucket # VCS_PROVIDER_NAME = 'vcs.provider.name' @@ -97,8 +97,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # my-feature-branch - # tag-1-test + # # my-feature-branch + # # tag-1-test # VCS_REF_BASE_NAME = 'vcs.ref.base.name' @@ -121,10 +121,10 @@ module VCS # @note Stability Level: development # # @example Sample Values - # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc - # main - # 123 - # HEAD + # # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc + # # main + # # 123 + # # HEAD # VCS_REF_BASE_REVISION = 'vcs.ref.base.revision' @@ -137,8 +137,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # branch - # tag + # # branch + # # tag # VCS_REF_BASE_TYPE = 'vcs.ref.base.type' @@ -150,8 +150,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # my-feature-branch - # tag-1-test + # # my-feature-branch + # # tag-1-test # VCS_REF_HEAD_NAME = 'vcs.ref.head.name' @@ -172,10 +172,10 @@ module VCS # @note Stability Level: development # # @example Sample Values - # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc - # main - # 123 - # HEAD + # # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc + # # main + # # 123 + # # HEAD # VCS_REF_HEAD_REVISION = 'vcs.ref.head.revision' @@ -187,8 +187,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # branch - # tag + # # branch + # # tag # VCS_REF_HEAD_TYPE = 'vcs.ref.head.type' @@ -197,8 +197,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # branch - # tag + # # branch + # # tag # VCS_REF_TYPE = 'vcs.ref.type' @@ -207,7 +207,7 @@ module VCS # @note Stability Level: development # # @example Sample Values - # 123 + # # 123 # # @deprecated {"note": "Replaced by `vcs.change.id`.", "reason": "renamed", "renamed_to": "vcs.change.id"} VCS_REPOSITORY_CHANGE_ID = 'vcs.repository.change.id' @@ -217,9 +217,9 @@ module VCS # @note Stability Level: development # # @example Sample Values - # Fixes broken thing - # feat: add my new feature - # [chore] update dependency + # # Fixes broken thing + # # feat: add my new feature + # # [chore] update dependency # # @deprecated {"note": "Replaced by `vcs.change.title`.", "reason": "renamed", "renamed_to": "vcs.change.title"} VCS_REPOSITORY_CHANGE_TITLE = 'vcs.repository.change.title' @@ -233,8 +233,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # semantic-conventions - # my-cool-repo + # # semantic-conventions + # # my-cool-repo # VCS_REPOSITORY_NAME = 'vcs.repository.name' @@ -243,8 +243,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # my-feature-branch - # tag-1-test + # # my-feature-branch + # # tag-1-test # # @deprecated {"note": "Replaced by `vcs.ref.head.name`.", "reason": "renamed", "renamed_to": "vcs.ref.head.name"} VCS_REPOSITORY_REF_NAME = 'vcs.repository.ref.name' @@ -254,10 +254,10 @@ module VCS # @note Stability Level: development # # @example Sample Values - # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc - # main - # 123 - # HEAD + # # 9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc + # # main + # # 123 + # # HEAD # # @deprecated {"note": "Replaced by `vcs.ref.head.revision`.", "reason": "renamed", "renamed_to": "vcs.ref.head.revision"} VCS_REPOSITORY_REF_REVISION = 'vcs.repository.ref.revision' @@ -267,8 +267,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # branch - # tag + # # branch + # # tag # # @deprecated {"note": "Replaced by `vcs.ref.head.type`.", "reason": "renamed", "renamed_to": "vcs.ref.head.type"} VCS_REPOSITORY_REF_TYPE = 'vcs.repository.ref.type' @@ -281,8 +281,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # https://github.com/opentelemetry/open-telemetry-collector-contrib - # https://gitlab.com/my-org/my-project/my-projects-project/repo + # # https://github.com/opentelemetry/open-telemetry-collector-contrib + # # https://gitlab.com/my-org/my-project/my-projects-project/repo # VCS_REPOSITORY_URL_FULL = 'vcs.repository.url.full' @@ -291,8 +291,8 @@ module VCS # @note Stability Level: development # # @example Sample Values - # ahead - # behind + # # ahead + # # behind # VCS_REVISION_DELTA_DIRECTION = 'vcs.revision_delta.direction' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/metrics.rb index 2228cf39ab..018c841dc2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/metrics.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/vcs/metrics.rb @@ -24,7 +24,7 @@ module Incubating module VCS # @!group Metrics Names - # The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged) + # The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged). # # @note Stability Level: development VCS_CHANGE_COUNT = 'vcs.change.count' @@ -44,7 +44,7 @@ module VCS # @note Stability Level: development VCS_CHANGE_TIME_TO_MERGE = 'vcs.change.time_to_merge' - # The number of unique contributors to a repository + # The number of unique contributors to a repository. # # @note Stability Level: development VCS_CONTRIBUTOR_COUNT = 'vcs.contributor.count' @@ -63,7 +63,7 @@ module VCS # @note Stability Level: development VCS_REF_LINES_DELTA = 'vcs.ref.lines_delta' - # The number of revisions (commits) a ref (branch) is ahead/behind the branch from the `vcs.ref.base.name` attribute + # The number of revisions (commits) a ref (branch) is ahead/behind the branch from the `vcs.ref.base.name` attribute. # # This metric should be reported for each `vcs.revision_delta.direction` value. For example if branch `a` is 3 commits behind and 2 commits ahead of `trunk`, # instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers) and `vcs.ref.base.name` is set to `trunk`. @@ -71,7 +71,7 @@ module VCS # @note Stability Level: development VCS_REF_REVISIONS_DELTA = 'vcs.ref.revisions_delta' - # Time a ref (branch) created from the default branch (trunk) has existed. The `ref.type` attribute will always be `branch` + # Time a ref (branch) created from the default branch (trunk) has existed. The `ref.type` attribute will always be `branch`. # # @note Stability Level: development VCS_REF_TIME = 'vcs.ref.time' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb index 910a9f8fba..d8c34dae10 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb @@ -29,7 +29,7 @@ module WEBENGINE # @note Stability Level: development # # @example Sample Values - # WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final + # # WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final # WEBENGINE_DESCRIPTION = 'webengine.description' @@ -38,7 +38,7 @@ module WEBENGINE # @note Stability Level: development # # @example Sample Values - # WildFly + # # WildFly # WEBENGINE_NAME = 'webengine.name' @@ -47,7 +47,7 @@ module WEBENGINE # @note Stability Level: development # # @example Sample Values - # 21.0.0 + # # 21.0.0 # WEBENGINE_VERSION = 'webengine.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/zos/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/zos/attributes.rb index d10e28adc5..7f8078c1e1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/zos/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/zos/attributes.rb @@ -29,7 +29,7 @@ module ZOS # @note Stability Level: development # # @example Sample Values - # SYS1 + # # SYS1 # ZOS_SMF_ID = 'zos.smf.id' @@ -38,7 +38,7 @@ module ZOS # @note Stability Level: development # # @example Sample Values - # SYSPLEX1 + # # SYSPLEX1 # ZOS_SYSPLEX_NAME = 'zos.sysplex.name' diff --git a/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb index 5ba812497e..fc6d4d08ca 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb @@ -30,8 +30,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # end of minor GC - # end of major GC + # # end of minor GC + # # end of major GC # JVM_GC_ACTION = 'jvm.gc.action' @@ -42,8 +42,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # G1 Young Generation - # G1 Old Generation + # # G1 Young Generation + # # G1 Old Generation # JVM_GC_NAME = 'jvm.gc.name' @@ -54,9 +54,9 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # G1 Old Gen - # G1 Eden space - # G1 Survivor Space + # # G1 Old Gen + # # G1 Eden space + # # G1 Survivor Space # JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' @@ -65,8 +65,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # heap - # non_heap + # # heap + # # non_heap # JVM_MEMORY_TYPE = 'jvm.memory.type' @@ -80,8 +80,8 @@ module JVM # @note Stability Level: stable # # @example Sample Values - # runnable - # blocked + # # runnable + # # blocked # JVM_THREAD_STATE = 'jvm.thread.state' diff --git a/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb index dea21be769..a3c602ed93 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb @@ -28,8 +28,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 10.1.2.80 - # /tmp/my.sock + # # 10.1.2.80 + # # /tmp/my.sock # NETWORK_LOCAL_ADDRESS = 'network.local.address' @@ -38,7 +38,7 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # NETWORK_LOCAL_PORT = 'network.local.port' @@ -47,8 +47,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 10.1.2.80 - # /tmp/my.sock + # # 10.1.2.80 + # # /tmp/my.sock # NETWORK_PEER_ADDRESS = 'network.peer.address' @@ -57,7 +57,7 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 65123 + # # 65123 # NETWORK_PEER_PORT = 'network.peer.port' @@ -68,9 +68,9 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # amqp - # http - # mqtt + # # amqp + # # http + # # mqtt # NETWORK_PROTOCOL_NAME = 'network.protocol.name' @@ -81,8 +81,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # 1.1 - # 2 + # # 1.1 + # # 2 # NETWORK_PROTOCOL_VERSION = 'network.protocol.version' @@ -97,8 +97,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # tcp - # udp + # # tcp + # # udp # NETWORK_TRANSPORT = 'network.transport' @@ -109,8 +109,8 @@ module NETWORK # @note Stability Level: stable # # @example Sample Values - # ipv4 - # ipv6 + # # ipv4 + # # ipv6 # NETWORK_TYPE = 'network.type' diff --git a/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb index 5b45d36127..2cbef6d909 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb @@ -28,7 +28,7 @@ module OTEL # @note Stability Level: stable # # @example Sample Values - # io.opentelemetry.contrib.mongodb + # # io.opentelemetry.contrib.mongodb # OTEL_SCOPE_NAME = 'otel.scope.name' @@ -37,7 +37,7 @@ module OTEL # @note Stability Level: stable # # @example Sample Values - # 1.0.0 + # # 1.0.0 # OTEL_SCOPE_VERSION = 'otel.scope.version' @@ -51,7 +51,7 @@ module OTEL # @note Stability Level: stable # # @example Sample Values - # resource not found + # # resource not found # OTEL_STATUS_DESCRIPTION = 'otel.status_description' diff --git a/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb index 9820f2254f..b77b8c7807 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb @@ -30,9 +30,9 @@ module SERVER # @note Stability Level: stable # # @example Sample Values - # example.com - # 10.1.2.80 - # /tmp/my.sock + # # example.com + # # 10.1.2.80 + # # /tmp/my.sock # SERVER_ADDRESS = 'server.address' @@ -43,9 +43,9 @@ module SERVER # @note Stability Level: stable # # @example Sample Values - # 80 - # 8080 - # 443 + # # 80 + # # 8080 + # # 443 # SERVER_PORT = 'server.port' diff --git a/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb index b825e90b71..37668a3ab7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb @@ -30,7 +30,7 @@ module SERVICE # @note Stability Level: stable # # @example Sample Values - # shoppingcart + # # shoppingcart # SERVICE_NAME = 'service.name' @@ -39,8 +39,8 @@ module SERVICE # @note Stability Level: stable # # @example Sample Values - # 2.0.0 - # a01dbef8a + # # 2.0.0 + # # a01dbef8a # SERVICE_VERSION = 'service.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb index 134f8fb795..0befe43a75 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb @@ -28,8 +28,8 @@ module SIGNALR # @note Stability Level: stable # # @example Sample Values - # app_shutdown - # timeout + # # app_shutdown + # # timeout # SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' @@ -38,8 +38,8 @@ module SIGNALR # @note Stability Level: stable # # @example Sample Values - # web_sockets - # long_polling + # # web_sockets + # # long_polling # SIGNALR_TRANSPORT = 'signalr.transport' diff --git a/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb index 5cc5fb1323..6a80ef3e54 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb @@ -40,7 +40,7 @@ module TELEMETRY # @note Stability Level: stable # # @example Sample Values - # opentelemetry + # # opentelemetry # TELEMETRY_SDK_NAME = 'telemetry.sdk.name' @@ -49,7 +49,7 @@ module TELEMETRY # @note Stability Level: stable # # @example Sample Values - # 1.2.3 + # # 1.2.3 # TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' diff --git a/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb index 1a96064752..e0c4f4d59b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb @@ -28,7 +28,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # SemConv + # # SemConv # URL_FRAGMENT = 'url.fragment' @@ -61,8 +61,8 @@ module URL # @note Stability Level: stable # # @example Sample Values - # https://www.foo.bar/search?q=OpenTelemetry#SemConv - # //localhost + # # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # # //localhost # URL_FULL = 'url.full' @@ -73,7 +73,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # /search + # # /search # URL_PATH = 'url.path' @@ -97,7 +97,7 @@ module URL # @note Stability Level: stable # # @example Sample Values - # q=OpenTelemetry + # # q=OpenTelemetry # URL_QUERY = 'url.query' @@ -106,9 +106,9 @@ module URL # @note Stability Level: stable # # @example Sample Values - # https - # ftp - # telnet + # # https + # # ftp + # # telnet # URL_SCHEME = 'url.scheme' diff --git a/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb b/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb index fd36e28425..ba1d4ece25 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb @@ -28,9 +28,9 @@ module USER_AGENT # @note Stability Level: stable # # @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 + # # 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 # USER_AGENT_ORIGINAL = 'user_agent.original' diff --git a/semantic_conventions/templates/registry/ruby/attributes.j2 b/semantic_conventions/templates/registry/ruby/attributes.j2 index 6320d204e5..9bb0ab0268 100644 --- a/semantic_conventions/templates/registry/ruby/attributes.j2 +++ b/semantic_conventions/templates/registry/ruby/attributes.j2 @@ -44,7 +44,7 @@ module OpenTelemetry # @example Sample Values {%- if attribute.examples is sequence %} {%- for example in attribute.examples %} - # {{ example }} + # {{ example | comment }} {%- endfor %} {%- else %} # {{ attribute.examples }} From 5b425487ebe5600edf5e48c84ebfadece1e778ee Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Fri, 31 Oct 2025 13:10:50 -0700 Subject: [PATCH 2/2] chore: attempt rubocop fix error on CI "missing panolint", which is not one of our dependencies --- semantic_conventions/.rubocop.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/semantic_conventions/.rubocop.yml b/semantic_conventions/.rubocop.yml index 7489c561a4..c6fd506cb8 100644 --- a/semantic_conventions/.rubocop.yml +++ b/semantic_conventions/.rubocop.yml @@ -4,6 +4,7 @@ AllCops: NewCops: enable Exclude: - 'tmp/semconvrepo/**/*' + - 'vendor/**/*' Bundler/OrderedGems: Exclude: