opentelemetry-semantic_conventions 1.36.0 → 1.37.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +0 -1
  3. data/CHANGELOG.md +11 -0
  4. data/README.md +79 -12
  5. data/lib/opentelemetry/semantic_conventions/resource.rb +0 -1
  6. data/lib/opentelemetry/semantic_conventions/trace.rb +0 -1
  7. data/lib/opentelemetry/semantic_conventions/version.rb +4 -1
  8. data/lib/opentelemetry/semconv/aspnetcore/attributes.rb +15 -43
  9. data/lib/opentelemetry/semconv/aspnetcore/metrics.rb +9 -9
  10. data/lib/opentelemetry/semconv/client/attributes.rb +4 -14
  11. data/lib/opentelemetry/semconv/code/attributes.rb +7 -29
  12. data/lib/opentelemetry/semconv/db/attributes.rb +11 -55
  13. data/lib/opentelemetry/semconv/db/metrics.rb +3 -3
  14. data/lib/opentelemetry/semconv/dotnet/attributes.rb +3 -9
  15. data/lib/opentelemetry/semconv/dotnet/metrics.rb +21 -21
  16. data/lib/opentelemetry/semconv/error/attributes.rb +3 -10
  17. data/lib/opentelemetry/semconv/exception/attributes.rb +7 -21
  18. data/lib/opentelemetry/semconv/http/attributes.rb +9 -44
  19. data/lib/opentelemetry/semconv/http/metrics.rb +4 -4
  20. data/lib/opentelemetry/semconv/incubating/android/attributes.rb +8 -17
  21. data/lib/opentelemetry/semconv/incubating/app/attributes.rb +28 -31
  22. data/lib/opentelemetry/semconv/incubating/artifact/attributes.rb +9 -46
  23. data/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb +91 -42
  24. data/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb +163 -9
  25. data/lib/opentelemetry/semconv/incubating/aws/attributes.rb +55 -261
  26. data/lib/opentelemetry/semconv/incubating/az/attributes.rb +6 -16
  27. data/lib/opentelemetry/semconv/incubating/azure/attributes.rb +11 -48
  28. data/lib/opentelemetry/semconv/incubating/azure/metrics.rb +6 -6
  29. data/lib/opentelemetry/semconv/incubating/browser/attributes.rb +6 -23
  30. data/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb +8 -25
  31. data/lib/opentelemetry/semconv/incubating/cicd/attributes.rb +18 -108
  32. data/lib/opentelemetry/semconv/incubating/cicd/metrics.rb +7 -7
  33. data/lib/opentelemetry/semconv/incubating/client/attributes.rb +4 -14
  34. data/lib/opentelemetry/semconv/incubating/cloud/attributes.rb +8 -28
  35. data/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb +7 -31
  36. data/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb +13 -58
  37. data/lib/opentelemetry/semconv/incubating/code/attributes.rb +17 -60
  38. data/lib/opentelemetry/semconv/incubating/container/attributes.rb +34 -81
  39. data/lib/opentelemetry/semconv/incubating/container/metrics.rb +43 -11
  40. data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +4 -13
  41. data/lib/opentelemetry/semconv/incubating/cpu/metrics.rb +8 -8
  42. data/lib/opentelemetry/semconv/incubating/cpython/attributes.rb +3 -9
  43. data/lib/opentelemetry/semconv/incubating/cpython/metrics.rb +5 -5
  44. data/lib/opentelemetry/semconv/incubating/db/attributes.rb +84 -281
  45. data/lib/opentelemetry/semconv/incubating/db/metrics.rb +44 -44
  46. data/lib/opentelemetry/semconv/incubating/deployment/attributes.rb +9 -28
  47. data/lib/opentelemetry/semconv/incubating/destination/attributes.rb +4 -15
  48. data/lib/opentelemetry/semconv/incubating/device/attributes.rb +7 -27
  49. data/lib/opentelemetry/semconv/incubating/disk/attributes.rb +3 -7
  50. data/lib/opentelemetry/semconv/incubating/dns/attributes.rb +4 -13
  51. data/lib/opentelemetry/semconv/incubating/dns/metrics.rb +3 -3
  52. data/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb +3 -9
  53. data/lib/opentelemetry/semconv/incubating/dotnet/metrics.rb +21 -21
  54. data/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb +3 -7
  55. data/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +8 -24
  56. data/lib/opentelemetry/semconv/incubating/error/attributes.rb +4 -16
  57. data/lib/opentelemetry/semconv/incubating/event/attributes.rb +4 -9
  58. data/lib/opentelemetry/semconv/incubating/exception/attributes.rb +7 -22
  59. data/lib/opentelemetry/semconv/incubating/faas/attributes.rb +18 -70
  60. data/lib/opentelemetry/semconv/incubating/faas/metrics.rb +20 -20
  61. data/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb +16 -75
  62. data/lib/opentelemetry/semconv/incubating/file/attributes.rb +20 -91
  63. data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +16 -64
  64. data/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb +143 -205
  65. data/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb +12 -12
  66. data/lib/opentelemetry/semconv/incubating/geo/attributes.rb +9 -34
  67. data/lib/opentelemetry/semconv/incubating/go/attributes.rb +3 -8
  68. data/lib/opentelemetry/semconv/incubating/go/metrics.rb +11 -11
  69. data/lib/opentelemetry/semconv/incubating/graphql/attributes.rb +5 -19
  70. data/lib/opentelemetry/semconv/incubating/heroku/attributes.rb +5 -17
  71. data/lib/opentelemetry/semconv/incubating/host/attributes.rb +17 -77
  72. data/lib/opentelemetry/semconv/incubating/http/attributes.rb +42 -154
  73. data/lib/opentelemetry/semconv/incubating/http/metrics.rb +12 -12
  74. data/lib/opentelemetry/semconv/incubating/hw/attributes.rb +114 -16
  75. data/lib/opentelemetry/semconv/incubating/hw/metrics.rb +188 -18
  76. data/lib/opentelemetry/semconv/incubating/ios/attributes.rb +7 -5
  77. data/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +10 -46
  78. data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +23 -23
  79. data/lib/opentelemetry/semconv/incubating/k8s/attributes.rb +64 -344
  80. data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +263 -135
  81. data/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb +10 -10
  82. data/lib/opentelemetry/semconv/incubating/linux/attributes.rb +3 -8
  83. data/lib/opentelemetry/semconv/incubating/log/attributes.rb +9 -34
  84. data/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb +3 -7
  85. data/lib/opentelemetry/semconv/incubating/message/attributes.rb +10 -10
  86. data/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +57 -215
  87. data/lib/opentelemetry/semconv/incubating/messaging/metrics.rb +18 -18
  88. data/lib/opentelemetry/semconv/incubating/net/attributes.rb +32 -86
  89. data/lib/opentelemetry/semconv/incubating/network/attributes.rb +19 -95
  90. data/lib/opentelemetry/semconv/incubating/nodejs/attributes.rb +3 -3
  91. data/lib/opentelemetry/semconv/incubating/nodejs/metrics.rb +11 -11
  92. data/lib/opentelemetry/semconv/incubating/oci/attributes.rb +3 -7
  93. data/lib/opentelemetry/semconv/incubating/openai/attributes.rb +46 -0
  94. data/lib/opentelemetry/semconv/incubating/openai.rb +21 -0
  95. data/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb +3 -3
  96. data/lib/opentelemetry/semconv/incubating/os/attributes.rb +7 -29
  97. data/lib/opentelemetry/semconv/incubating/otel/attributes.rb +19 -44
  98. data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +46 -46
  99. data/lib/opentelemetry/semconv/incubating/other/attributes.rb +4 -8
  100. data/lib/opentelemetry/semconv/incubating/peer/attributes.rb +3 -7
  101. data/lib/opentelemetry/semconv/incubating/pool/attributes.rb +4 -8
  102. data/lib/opentelemetry/semconv/incubating/process/attributes.rb +40 -172
  103. data/lib/opentelemetry/semconv/incubating/process/metrics.rb +13 -13
  104. data/lib/opentelemetry/semconv/incubating/profile/attributes.rb +3 -7
  105. data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +19 -64
  106. data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +12 -12
  107. data/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb +10 -43
  108. data/lib/opentelemetry/semconv/incubating/server/attributes.rb +4 -16
  109. data/lib/opentelemetry/semconv/incubating/service/attributes.rb +6 -23
  110. data/lib/opentelemetry/semconv/incubating/session/attributes.rb +4 -12
  111. data/lib/opentelemetry/semconv/incubating/signalr/attributes.rb +4 -14
  112. data/lib/opentelemetry/semconv/incubating/signalr/metrics.rb +4 -4
  113. data/lib/opentelemetry/semconv/incubating/source/attributes.rb +4 -15
  114. data/lib/opentelemetry/semconv/incubating/system/attributes.rb +19 -77
  115. data/lib/opentelemetry/semconv/incubating/system/metrics.rb +85 -68
  116. data/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb +7 -23
  117. data/lib/opentelemetry/semconv/incubating/test/attributes.rb +6 -30
  118. data/lib/opentelemetry/semconv/incubating/thread/attributes.rb +4 -12
  119. data/lib/opentelemetry/semconv/incubating/tls/attributes.rb +32 -146
  120. data/lib/opentelemetry/semconv/incubating/url/attributes.rb +15 -80
  121. data/lib/opentelemetry/semconv/incubating/user/attributes.rb +8 -32
  122. data/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb +8 -35
  123. data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb +4 -4
  124. data/lib/opentelemetry/semconv/incubating/v8js/metrics.rb +7 -7
  125. data/lib/opentelemetry/semconv/incubating/vcs/attributes.rb +28 -143
  126. data/lib/opentelemetry/semconv/incubating/vcs/metrics.rb +16 -16
  127. data/lib/opentelemetry/semconv/incubating/webengine/attributes.rb +5 -17
  128. data/lib/opentelemetry/semconv/incubating/zos/attributes.rb +4 -12
  129. data/lib/opentelemetry/semconv/jvm/attributes.rb +8 -34
  130. data/lib/opentelemetry/semconv/jvm/metrics.rb +14 -14
  131. data/lib/opentelemetry/semconv/kestrel/metrics.rb +10 -10
  132. data/lib/opentelemetry/semconv/network/attributes.rb +10 -49
  133. data/lib/opentelemetry/semconv/otel/attributes.rb +6 -18
  134. data/lib/opentelemetry/semconv/server/attributes.rb +4 -16
  135. data/lib/opentelemetry/semconv/service/attributes.rb +4 -13
  136. data/lib/opentelemetry/semconv/signalr/attributes.rb +4 -14
  137. data/lib/opentelemetry/semconv/signalr/metrics.rb +4 -4
  138. data/lib/opentelemetry/semconv/telemetry/attributes.rb +5 -13
  139. data/lib/opentelemetry/semconv/url/attributes.rb +7 -30
  140. data/lib/opentelemetry/semconv/user_agent/attributes.rb +3 -9
  141. metadata +11 -40
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5b1d56cd309c3dbd3418c4999d97dcfc7807aa56da86f17e99407b280fb8ad7b
4
- data.tar.gz: e58c43ddccb57d4c2fa9e2717fdf26a379cd24be1fa829eb9bb5aa546dc27663
3
+ metadata.gz: 266fdf2702c166bf304d39da3add16b30935c97c0645386ab508abd5d210d787
4
+ data.tar.gz: 5120eadf8c2749f70e15299a4ee5668fc92efd4e330934f45346e8a603e17a7a
5
5
  SHA512:
6
- metadata.gz: 13b293e3a8dd9676d7b4dd6a4578bf8fc1ecbbc3df8450dde6084301ee198db93b930f14670d45525ab2955ab30a56d9a63fc3a5476666a0c484229931492370
7
- data.tar.gz: 8a71e44ef0d3157c5b29b4d84352b29acb4e0f8660ba80e82d459ea422fc6866722c9dc19ceea6f05297d114fa6ae6ba3518fca81013a53591787ae8c613b213
6
+ metadata.gz: b04705a2d24ff643c8df644e1bc009ddc0f05e258d2c8ec16430c71b87ab1689d4dc6b7a58768672ab16ab270219f9a4e56654a31384a81574e0f0fba36124aa
7
+ data.tar.gz: 7cd6d2c314df1bd86a9a0e63f88747d98b946aa753e8ca6f35fe718f49c31010adeb078b5c71464a4db9da21446133aff8503f861cfdba85bd4fd198dd865c3c
data/.yardopts CHANGED
@@ -1,7 +1,6 @@
1
1
  --no-private
2
2
  --title=OpenTelemetry Semantic Conventions
3
3
  --markup=markdown
4
- --markup-provider=kramdown
5
4
  --main=README.md
6
5
  ./lib/opentelemetry/**/*.rb
7
6
  -
data/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Release History: opentelemetry-semantic_conventions
2
2
 
3
+ ### v1.37.1 / 2026-05-12
4
+
5
+ * ADDED: Add git tag to source URI in gemspec (#2101)
6
+
7
+ ### v1.37.0 / 2026-04-07
8
+
9
+ * ADDED: Bump semantic conventions to version 1.37.0 (#1952)
10
+ * ADDED: Min Ruby Version 3.3 (#2070)
11
+ * FIXED: Correct & simplify codegen templates (#2059)
12
+ * FIXED: Tweak weaver generation to include new line (#2071)
13
+
3
14
  ### v1.36.0 / 2025-09-16
4
15
 
5
16
  * ADDED: Update to v1.36 in a non-breaking way
data/README.md CHANGED
@@ -1,16 +1,25 @@
1
- # Opentelemetry::SemanticConventions
1
+ # OpenTelemetry::SemanticConventions
2
2
 
3
- The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry [Semantic Conventions][semantic-conventions].
3
+ The `opentelemetry-semantic_conventions` gem provides auto-generated constants
4
+ that represent the OpenTelemetry [Semantic Conventions][semantic-conventions].
4
5
 
5
6
  ## What is OpenTelemetry?
6
7
 
7
- OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
8
+ OpenTelemetry is an open source observability framework, providing a
9
+ general-purpose API, SDK, and related tools required for the instrumentation of
10
+ cloud-native software, frameworks, and libraries.
8
11
 
9
- OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
12
+ OpenTelemetry provides a single set of APIs, libraries, agents, and collector
13
+ services to capture distributed traces and metrics from your application. You
14
+ can analyze them using Prometheus, Jaeger, and other observability tools.
10
15
 
11
16
  ## How does this gem fit in?
12
17
 
13
- The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry Semantic Conventions. They may be referenced in instrumentation or end-user code in place of hard-coding the names of the conventions. Because they are generated from the YAML models in the specification, they are kept up-to-date for you.
18
+ The `opentelemetry-semantic_conventions` gem provides auto-generated constants
19
+ that represent the OpenTelemetry Semantic Conventions. They may be referenced
20
+ in instrumentation or end-user code in place of hard-coding the names of the
21
+ conventions. Because they are generated from the YAML models in the
22
+ specification, they are kept up-to-date for you.
14
23
 
15
24
  ## How do I get started?
16
25
 
@@ -20,29 +29,87 @@ Install the gem using:
20
29
  gem install opentelemetry-semantic_conventions
21
30
  ```
22
31
 
23
- Or, if you use Bundler, include `opentelemetry-semantic_conventions` in your `Gemfile`.
32
+ Or, if you use Bundler, include `opentelemetry-semantic_conventions` in your
33
+ `Gemfile`.
34
+
35
+ ## How do I use the gem?
36
+
37
+ The gem's versions match the corresponding
38
+ [OpenTelemetry Semantic Convention versions][semconv].
39
+
40
+ In version 1.36.0, we established a new pattern for naming the constants:
41
+
42
+ * `OpenTelemetry::SemConv::Incubating::#{CATEGORY_NAME}` is the prefix for
43
+ experimental, development, or deprecated constants
44
+ * `OpenTelemetry::SemConv::#{CATEGORY_NAME}` is the prefix for stable constants
45
+
46
+ Incubating constants will never be removed. If an incubating constant becomes
47
+ stable, it will be copied into the stable namespace and the value will be
48
+ available from two constants. The new constant's name will be the same, except
49
+ the `Incubating` namespace will be removed.
50
+
51
+ Prior to 1.36.0 (last version 1.11.0), constants follow a different naming
52
+ pattern: `OpenTelemetry::SemanticConventions::#{CATEGORY_NAME}`
53
+
54
+ These constants will be preserved to avoid breaking changes for users who rely
55
+ on the old constants. These constants do not differentiate between stable and
56
+ unstable constants. New constants will not be added to this namespace.
57
+
58
+ We recommend you require only the files that contain the constants you are going
59
+ to use. For example, if you were creating instrumentation for an HTTP Client
60
+ that emits only stable conventions, you would likely require:
61
+
62
+ ```rb
63
+ require 'opentelemetry/semconv/http'
64
+ ```
65
+
66
+ If you want to require all of the 1.11.0 constants, you can use:
24
67
 
25
68
  ```rb
26
69
  require 'opentelemetry/semantic_conventions'
27
70
 
28
71
  # Use the constants however you feel necessary, eg:
29
72
 
30
- puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::CODE_LINENO}"
73
+ puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::DB_USER}"
74
+ ```
75
+
76
+ The constant names can be very long. You can consider aliasing the long bit in
77
+ another constant to save your fingertips some trouble.
78
+
79
+ ```rb
80
+ SEMCONV_HTTP_INC = OpenTelemetry::SemConv::Incubating::HTTP
81
+
82
+ SEMCONV_HTTP_INC::HTTP_REQUEST_METHOD # which would return 'http.request.method'
31
83
  ```
32
84
 
85
+ ## What's up with the gem's versions?
86
+
87
+ This gem doesn't follow semantic versioning. Instead, the version matches the
88
+ upstream [OpenTelemetry Semantic Conventions version][semconv].
89
+
33
90
  ## How do I rebuild the conventions?
34
91
 
35
- Bump the version number in the Rakefile, and then run `rake generate`.
92
+ To build the library against a new version of the semantic conventions, update SPEC_VERSION in the Rakefile, and then run `rake generate`.
93
+
94
+ Do not update the library's VERSION in version.rb.
95
+ That will be handled by the automation for releasing the gem.
36
96
 
37
97
  ## How can I get involved?
38
98
 
39
- The `opentelemetry-semantic_conventions` gem source is on github, along with related gems.
99
+ The `opentelemetry-semantic_conventions` gem source is on GitHub, along with
100
+ related gems.
40
101
 
41
- The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
102
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special
103
+ interest group (SIG). You can get involved by joining us in
104
+ [GitHub Discussions][discussions-url] or attending our weekly meeting. See the
105
+ meeting calendar for dates and times. For more information on this and other
106
+ language SIGs, see the OpenTelemetry community page.
42
107
 
43
108
  ## License
44
109
 
45
- The `opentelemetry-semantic_conventions` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
110
+ The `opentelemetry-semantic_conventions` gem is distributed under the Apache 2.0
111
+ license. See LICENSE for more information.
46
112
 
47
113
  [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
48
- [semantic-conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.20.0/semantic_conventions
114
+ [semantic-conventions]: https://github.com/open-telemetry/semantic-conventions
115
+ [semconv]: https://opentelemetry.io/docs/specs/semconv/
@@ -548,7 +548,6 @@ module OpenTelemetry
548
548
  # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated.
549
549
  # See {OpenTelemetry::SemConv::Incubating::WEBENGINE::WEBENGINE_DESCRIPTION} for its replacement.
550
550
  WEBENGINE_DESCRIPTION = 'webengine.description'
551
-
552
551
  end
553
552
  end
554
553
  end
@@ -908,7 +908,6 @@ module OpenTelemetry
908
908
  # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated.
909
909
  # See {OpenTelemetry::SemConv::Incubating::MESSAGE::MESSAGE_UNCOMPRESSED_SIZE} for its replacement.
910
910
  MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size'
911
-
912
911
  end
913
912
  end
914
913
  end
@@ -6,6 +6,9 @@
6
6
 
7
7
  module OpenTelemetry
8
8
  module SemanticConventions
9
- VERSION = '1.36.0'
9
+ # Version of the OpenTelemetry Semantic Conventions from which this library was generated.
10
+ SPEC_VERSION = '1.37.0'
11
+ # Release version of this gem. May not match SPEC_VERSION until gem is released after a spec update.
12
+ VERSION = '1.37.1'
10
13
  end
11
14
  end
@@ -22,76 +22,48 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module ASPNETCORE
24
24
  # @!group Attribute Names
25
-
26
- # ASP.NET Core exception middleware handling result
25
+
26
+ # ASP.NET Core exception middleware handling result.
27
27
  #
28
28
  # @note Stability Level: stable
29
- #
30
- # @example Sample Values
31
- # handled
32
- # unhandled
33
- #
34
29
  ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result'
35
-
30
+
36
31
  # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception.
37
32
  #
38
33
  # @note Stability Level: stable
39
- #
40
- # @example Sample Values
41
- # Contoso.MyHandler
42
- #
43
34
  ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type'
44
-
35
+
45
36
  # Rate limiting policy name.
46
37
  #
47
38
  # @note Stability Level: stable
48
- #
49
- # @example Sample Values
50
- # fixed
51
- # sliding
52
- # token
53
- #
54
39
  ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy'
55
-
40
+
56
41
  # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason
57
42
  #
58
43
  # @note Stability Level: stable
59
- #
60
- # @example Sample Values
61
- # acquired
62
- # request_canceled
63
- #
64
44
  ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result'
65
-
45
+
66
46
  # Flag indicating if request was handled by the application pipeline.
67
47
  #
68
48
  # @note Stability Level: stable
69
- #
70
- # @example Sample Values
71
- # true
72
- #
73
49
  ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled'
74
-
50
+
75
51
  # A value that indicates whether the matched route is a fallback route.
76
52
  #
77
53
  # @note Stability Level: stable
78
- #
79
- # @example Sample Values
80
- # true
81
- #
82
54
  ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback'
83
-
55
+
84
56
  # Match result - success or failure
85
57
  #
86
58
  # @note Stability Level: stable
87
- #
88
- # @example Sample Values
89
- # success
90
- # failure
91
- #
92
59
  ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status'
93
-
60
+
61
+ # A value that indicates whether the user is authenticated.
62
+ #
63
+ # @note Stability Level: stable
64
+ ASPNETCORE_USER_IS_AUTHENTICATED = 'aspnetcore.user.is_authenticated'
65
+
94
66
  # @!endgroup
95
67
  end
96
68
  end
97
- end
69
+ end
@@ -22,42 +22,42 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module ASPNETCORE
24
24
  # @!group Metrics Names
25
-
25
+
26
26
  # Number of exceptions caught by exception handling middleware.
27
27
  #
28
28
  # Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0
29
29
  #
30
30
  # @note Stability Level: stable
31
31
  ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions'
32
-
32
+
33
33
  # Number of requests that are currently active on the server that hold a rate limiting lease.
34
34
  #
35
35
  # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
36
36
  #
37
37
  # @note Stability Level: stable
38
38
  ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases'
39
-
39
+
40
40
  # Number of requests that are currently queued, waiting to acquire a rate limiting lease.
41
41
  #
42
42
  # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
43
43
  #
44
44
  # @note Stability Level: stable
45
45
  ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests'
46
-
46
+
47
47
  # The time the request spent in a queue waiting to acquire a rate limiting lease.
48
48
  #
49
49
  # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
50
50
  #
51
51
  # @note Stability Level: stable
52
52
  ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue'
53
-
53
+
54
54
  # The duration of rate limiting lease held by requests on the server.
55
55
  #
56
56
  # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
57
57
  #
58
58
  # @note Stability Level: stable
59
59
  ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration'
60
-
60
+
61
61
  # Number of requests that tried to acquire a rate limiting lease.
62
62
  #
63
63
  # Requests could be:
@@ -69,15 +69,15 @@ module OpenTelemetry
69
69
  #
70
70
  # @note Stability Level: stable
71
71
  ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests'
72
-
72
+
73
73
  # Number of requests that were attempted to be matched to an endpoint.
74
74
  #
75
75
  # Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0
76
76
  #
77
77
  # @note Stability Level: stable
78
78
  ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts'
79
-
79
+
80
80
  # @!endgroup
81
81
  end
82
82
  end
83
- end
83
+ end
@@ -22,32 +22,22 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module CLIENT
24
24
  # @!group Attribute Names
25
-
25
+
26
26
  # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
27
27
  #
28
28
  # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
29
29
  #
30
30
  # @note Stability Level: stable
31
- #
32
- # @example Sample Values
33
- # client.example.com
34
- # 10.1.2.80
35
- # /tmp/my.sock
36
- #
37
31
  CLIENT_ADDRESS = 'client.address'
38
-
32
+
39
33
  # Client port number.
40
34
  #
41
35
  # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.
42
36
  #
43
37
  # @note Stability Level: stable
44
- #
45
- # @example Sample Values
46
- # 65123
47
- #
48
38
  CLIENT_PORT = 'client.port'
49
-
39
+
50
40
  # @!endgroup
51
41
  end
52
42
  end
53
- end
43
+ end
@@ -22,25 +22,17 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module CODE
24
24
  # @!group Attribute Names
25
-
25
+
26
26
  # The column number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.
27
27
  #
28
28
  # @note Stability Level: stable
29
- #
30
- # @example Sample Values
31
- # 16
32
- #
33
29
  CODE_COLUMN_NUMBER = 'code.column.number'
34
-
30
+
35
31
  # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
36
32
  #
37
33
  # @note Stability Level: stable
38
- #
39
- # @example Sample Values
40
- # /usr/local/MyApplication/content_root/app/index.php
41
- #
42
34
  CODE_FILE_PATH = 'code.file.path'
43
-
35
+
44
36
  # The method or function fully-qualified name without arguments. The value should fit the natural representation of the language runtime, which is also likely the same used within `code.stacktrace` attribute value. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
45
37
  #
46
38
  # Values and format depends on each language runtime, thus it is impossible to provide an exhaustive list of examples.
@@ -60,33 +52,19 @@ module OpenTelemetry
60
52
  # - C function: `fopen`
61
53
  #
62
54
  # @note Stability Level: stable
63
- #
64
- # @example Sample Values
65
- # com.example.MyHttpService.serveRequest
66
- # GuzzleHttp\Client::transfer
67
- # fopen
68
- #
69
55
  CODE_FUNCTION_NAME = 'code.function.name'
70
-
56
+
71
57
  # The line number in `code.file.path` best representing the operation. It SHOULD point within the code unit named in `code.function.name`. This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Line'. This constraint is imposed to prevent redundancy and maintain data integrity.
72
58
  #
73
59
  # @note Stability Level: stable
74
- #
75
- # @example Sample Values
76
- # 42
77
- #
78
60
  CODE_LINE_NUMBER = 'code.line.number'
79
-
61
+
80
62
  # A stacktrace as a string in the natural representation for the language runtime. The representation is identical to [`exception.stacktrace`](/docs/exceptions/exceptions-spans.md#stacktrace-representation). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain data integrity.
81
63
  #
82
64
  # @note Stability Level: stable
83
- #
84
- # @example Sample Values
85
- # at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)
86
-
87
65
  CODE_STACKTRACE = 'code.stacktrace'
88
-
66
+
89
67
  # @!endgroup
90
68
  end
91
69
  end
92
- end
70
+ end
@@ -22,7 +22,7 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module DB
24
24
  # @!group Attribute Names
25
-
25
+
26
26
  # The name of a collection (table, container) within the database.
27
27
  #
28
28
  # It is RECOMMENDED to capture the value as provided by the application
@@ -36,13 +36,8 @@ module OpenTelemetry
36
36
  # collection name then that collection name SHOULD be used.
37
37
  #
38
38
  # @note Stability Level: stable
39
- #
40
- # @example Sample Values
41
- # public.users
42
- # customers
43
- #
44
39
  DB_COLLECTION_NAME = 'db.collection.name'
45
-
40
+
46
41
  # The name of the database, fully qualified within the server address and port.
47
42
  #
48
43
  # If a database system has multiple namespace components, they SHOULD be concatenated from the most general to the most specific namespace component, using `|` as a separator between the components. Any missing components (and their associated separators) SHOULD be omitted.
@@ -50,26 +45,15 @@ module OpenTelemetry
50
45
  # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
51
46
  #
52
47
  # @note Stability Level: stable
53
- #
54
- # @example Sample Values
55
- # customers
56
- # test.users
57
- #
58
48
  DB_NAMESPACE = 'db.namespace'
59
-
49
+
60
50
  # The number of queries included in a batch operation.
61
51
  #
62
52
  # Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
63
53
  #
64
54
  # @note Stability Level: stable
65
- #
66
- # @example Sample Values
67
- # 2
68
- # 3
69
- # 4
70
- #
71
55
  DB_OPERATION_BATCH_SIZE = 'db.operation.batch.size'
72
-
56
+
73
57
  # The name of the operation or command being executed.
74
58
  #
75
59
  # It is RECOMMENDED to capture the value as provided by the application
@@ -88,14 +72,8 @@ module OpenTelemetry
88
72
  # system specific term if more applicable.
89
73
  #
90
74
  # @note Stability Level: stable
91
- #
92
- # @example Sample Values
93
- # findAndModify
94
- # HMSET
95
- # SELECT
96
- #
97
75
  DB_OPERATION_NAME = 'db.operation.name'
98
-
76
+
99
77
  # Low cardinality summary of a database query.
100
78
  #
101
79
  # The query summary describes a class of database queries and is useful
@@ -109,14 +87,8 @@ module OpenTelemetry
109
87
  # section.
110
88
  #
111
89
  # @note Stability Level: stable
112
- #
113
- # @example Sample Values
114
- # SELECT wuser_table
115
- # INSERT shipping_details SELECT orders
116
- # get user by id
117
- #
118
90
  DB_QUERY_SUMMARY = 'db.query.summary'
119
-
91
+
120
92
  # The database query being executed.
121
93
  #
122
94
  # For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
@@ -124,28 +96,16 @@ module OpenTelemetry
124
96
  # Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
125
97
  #
126
98
  # @note Stability Level: stable
127
- #
128
- # @example Sample Values
129
- # SELECT * FROM wuser_table where username = ?
130
- # SET mykey ?
131
- #
132
99
  DB_QUERY_TEXT = 'db.query.text'
133
-
100
+
134
101
  # Database response status code.
135
102
  #
136
103
  # The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
137
104
  # Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system.
138
105
  #
139
106
  # @note Stability Level: stable
140
- #
141
- # @example Sample Values
142
- # 102
143
- # ORA-17002
144
- # 08P01
145
- # 404
146
- #
147
107
  DB_RESPONSE_STATUS_CODE = 'db.response.status_code'
148
-
108
+
149
109
  # The name of a stored procedure within the database.
150
110
  #
151
111
  # It is RECOMMENDED to capture the value as provided by the application
@@ -155,20 +115,16 @@ module OpenTelemetry
155
115
  # stored procedure name then that stored procedure name SHOULD be used.
156
116
  #
157
117
  # @note Stability Level: stable
158
- #
159
- # @example Sample Values
160
- # GetCustomer
161
- #
162
118
  DB_STORED_PROCEDURE_NAME = 'db.stored_procedure.name'
163
-
119
+
164
120
  # The database management system (DBMS) product as identified by the client instrumentation.
165
121
  #
166
122
  # The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system.name` is set to `postgresql` based on the instrumentation's best knowledge.
167
123
  #
168
124
  # @note Stability Level: stable
169
125
  DB_SYSTEM_NAME = 'db.system.name'
170
-
126
+
171
127
  # @!endgroup
172
128
  end
173
129
  end
174
- end
130
+ end
@@ -22,15 +22,15 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module DB
24
24
  # @!group Metrics Names
25
-
25
+
26
26
  # Duration of database client operations.
27
27
  #
28
28
  # Batch operations SHOULD be recorded as a single operation.
29
29
  #
30
30
  # @note Stability Level: stable
31
31
  DB_CLIENT_OPERATION_DURATION = 'db.client.operation.duration'
32
-
32
+
33
33
  # @!endgroup
34
34
  end
35
35
  end
36
- end
36
+ end
@@ -22,19 +22,13 @@ module OpenTelemetry
22
22
  module SemConv
23
23
  module DOTNET
24
24
  # @!group Attribute Names
25
-
25
+
26
26
  # Name of the garbage collector managed heap generation.
27
27
  #
28
28
  # @note Stability Level: stable
29
- #
30
- # @example Sample Values
31
- # gen0
32
- # gen1
33
- # gen2
34
- #
35
29
  DOTNET_GC_HEAP_GENERATION = 'dotnet.gc.heap.generation'
36
-
30
+
37
31
  # @!endgroup
38
32
  end
39
33
  end
40
- end
34
+ end