Debian Codegraph @

semconv/v1.28.0/MIGRATION.md

raw
1 # Semantic Convention Changes
2
3 The `go.opentelemetry.io/otel/semconv/v1.28.0` should be a drop-in replacement for `go.opentelemetry.io/otel/semconv/v1.27.0` with the following exceptions.
4
5 ## Dropped deprecations
6
7 The following declarations have been deprecated in the [OpenTelemetry Semantic Conventions].
8 Refer to the respective documentation in that repository for deprecation instructions for each type.
9
10 - `AndroidStateBackground`
11 - `AndroidStateCreated`
12 - `AndroidStateForeground`
13 - `AndroidStateKey`
14 - `DBCosmosDBStatusCode`
15 - `DBCosmosDBStatusCodeKey`
16 - `GenAICompletion`
17 - `GenAICompletionKey`
18 - `GenAIPrompt`
19 - `GenAIPromptKey`
20
21 ### Dropping the `aspnetcore` namespace
22
23 The following declarations have been dropped in `go.opentelemetry.io/otel/semconv/v1.28.0`.
24 These semantic conventions were determined to have not have use in Go applications.
25
26 - `ASPNETCoreDiagnosticsExceptionResultAborted`
27 - `ASPNETCoreDiagnosticsExceptionResultHandled`
28 - `ASPNETCoreDiagnosticsExceptionResultKey`
29 - `ASPNETCoreDiagnosticsExceptionResultSkipped`
30 - `ASPNETCoreDiagnosticsExceptionResultUnhandled`
31 - `ASPNETCoreDiagnosticsHandlerType`
32 - `ASPNETCoreDiagnosticsHandlerTypeKey`
33 - `ASPNETCoreRateLimitingPolicy`
34 - `ASPNETCoreRateLimitingPolicyKey`
35 - `ASPNETCoreRateLimitingResultAcquired`
36 - `ASPNETCoreRateLimitingResultEndpointLimiter`
37 - `ASPNETCoreRateLimitingResultGlobalLimiter`
38 - `ASPNETCoreRateLimitingResultKey`
39 - `ASPNETCoreRateLimitingResultRequestCanceled`
40 - `ASPNETCoreRequestIsUnhandled`
41 - `ASPNETCoreRequestIsUnhandledKey`
42 - `ASPNETCoreRoutingIsFallback`
43 - `ASPNETCoreRoutingIsFallbackKey`
44 - `ASPNETCoreRoutingMatchStatusFailure`
45 - `ASPNETCoreRoutingMatchStatusKey`
46 - `ASPNETCoreRoutingMatchStatusSuccess`
47 - `AspnetcoreDiagnosticsExceptionsDescription`
48 - `AspnetcoreDiagnosticsExceptionsName`
49 - `AspnetcoreDiagnosticsExceptionsUnit`
50 - `AspnetcoreRateLimitingActiveRequestLeasesDescription`
51 - `AspnetcoreRateLimitingActiveRequestLeasesName`
52 - `AspnetcoreRateLimitingActiveRequestLeasesUnit`
53 - `AspnetcoreRateLimitingQueuedRequestsDescription`
54 - `AspnetcoreRateLimitingQueuedRequestsName`
55 - `AspnetcoreRateLimitingQueuedRequestsUnit`
56 - `AspnetcoreRateLimitingRequestLeaseDurationDescription`
57 - `AspnetcoreRateLimitingRequestLeaseDurationName`
58 - `AspnetcoreRateLimitingRequestLeaseDurationUnit`
59 - `AspnetcoreRateLimitingRequestTimeInQueueDescription`
60 - `AspnetcoreRateLimitingRequestTimeInQueueName`
61 - `AspnetcoreRateLimitingRequestTimeInQueueUnit`
62 - `AspnetcoreRateLimitingRequestsDescription`
63 - `AspnetcoreRateLimitingRequestsName`
64 - `AspnetcoreRateLimitingRequestsUnit`
65 - `AspnetcoreRoutingMatchAttemptsDescription`
66 - `AspnetcoreRoutingMatchAttemptsName`
67 - `AspnetcoreRoutingMatchAttemptsUnit`
68
69 If you use any of these declarations in your Go application, please [open an issue] describing your use-case.
70
71 ### Dropping the `jvm` namespace
72
73 The following declarations have been dropped in `go.opentelemetry.io/otel/semconv/v1.28.0`.
74 These semantic conventions were determined to have not have use in Go applications.
75
76 - `JVMBufferPoolName`
77 - `JVMBufferPoolNameKey`
78 - `JVMGCAction`
79 - `JVMGCActionKey`
80 - `JVMGCName`
81 - `JVMGCNameKey`
82 - `JVMMemoryPoolName`
83 - `JVMMemoryPoolNameKey`
84 - `JVMMemoryTypeHeap`
85 - `JVMMemoryTypeKey`
86 - `JVMMemoryTypeNonHeap`
87 - `JVMThreadDaemon`
88 - `JVMThreadDaemonKey`
89 - `JVMThreadStateBlocked`
90 - `JVMThreadStateKey`
91 - `JVMThreadStateNew`
92 - `JVMThreadStateRunnable`
93 - `JVMThreadStateTerminated`
94 - `JVMThreadStateTimedWaiting`
95 - `JVMThreadStateWaiting`
96 - `JvmBufferCountDescription`
97 - `JvmBufferCountName`
98 - `JvmBufferCountUnit`
99 - `JvmBufferMemoryLimitDescription`
100 - `JvmBufferMemoryLimitName`
101 - `JvmBufferMemoryLimitUnit`
102 - `JvmBufferMemoryUsageDescription`
103 - `JvmBufferMemoryUsageName`
104 - `JvmBufferMemoryUsageUnit`
105 - `JvmBufferMemoryUsedDescription`
106 - `JvmBufferMemoryUsedName`
107 - `JvmBufferMemoryUsedUnit`
108 - `JvmCPUCountDescription`
109 - `JvmCPUCountName`
110 - `JvmCPUCountUnit`
111 - `JvmCPURecentUtilizationDescription`
112 - `JvmCPURecentUtilizationName`
113 - `JvmCPURecentUtilizationUnit`
114 - `JvmCPUTimeDescription`
115 - `JvmCPUTimeName`
116 - `JvmCPUTimeUnit`
117 - `JvmClassCountDescription`
118 - `JvmClassCountName`
119 - `JvmClassCountUnit`
120 - `JvmClassLoadedDescription`
121 - `JvmClassLoadedName`
122 - `JvmClassLoadedUnit`
123 - `JvmClassUnloadedDescription`
124 - `JvmClassUnloadedName`
125 - `JvmClassUnloadedUnit`
126 - `JvmGcDurationDescription`
127 - `JvmGcDurationName`
128 - `JvmGcDurationUnit`
129 - `JvmMemoryCommittedDescription`
130 - `JvmMemoryCommittedName`
131 - `JvmMemoryCommittedUnit`
132 - `JvmMemoryInitDescription`
133 - `JvmMemoryInitName`
134 - `JvmMemoryInitUnit`
135 - `JvmMemoryLimitDescription`
136 - `JvmMemoryLimitName`
137 - `JvmMemoryLimitUnit`
138 - `JvmMemoryUsedAfterLastGcDescription`
139 - `JvmMemoryUsedAfterLastGcName`
140 - `JvmMemoryUsedAfterLastGcUnit`
141 - `JvmMemoryUsedDescription`
142 - `JvmMemoryUsedName`
143 - `JvmMemoryUsedUnit`
144 - `JvmSystemCPULoad1mDescription`
145 - `JvmSystemCPULoad1mName`
146 - `JvmSystemCPULoad1mUnit`
147 - `JvmSystemCPUUtilizationDescription`
148 - `JvmSystemCPUUtilizationName`
149 - `JvmSystemCPUUtilizationUnit`
150 - `JvmThreadCountDescription`
151 - `JvmThreadCountName`
152 - `JvmThreadCountUnit`
153
154 If you use any of these declarations in your Go application, please [open an issue] describing your use-case.
155
156 ### Dropping the `nodejs` namespace
157
158 The following declarations have been dropped in `go.opentelemetry.io/otel/semconv/v1.28.0`.
159 These semantic conventions were determined to have not have use in Go applications.
160
161 - `NodejsEventloopDelayMaxDescription`
162 - `NodejsEventloopDelayMaxName`
163 - `NodejsEventloopDelayMaxUnit`
164 - `NodejsEventloopDelayMeanDescription`
165 - `NodejsEventloopDelayMeanName`
166 - `NodejsEventloopDelayMeanUnit`
167 - `NodejsEventloopDelayMinDescription`
168 - `NodejsEventloopDelayMinName`
169 - `NodejsEventloopDelayMinUnit`
170 - `NodejsEventloopDelayP50Description`
171 - `NodejsEventloopDelayP50Name`
172 - `NodejsEventloopDelayP50Unit`
173 - `NodejsEventloopDelayP90Description`
174 - `NodejsEventloopDelayP90Name`
175 - `NodejsEventloopDelayP90Unit`
176 - `NodejsEventloopDelayP99Description`
177 - `NodejsEventloopDelayP99Name`
178 - `NodejsEventloopDelayP99Unit`
179 - `NodejsEventloopDelayStddevDescription`
180 - `NodejsEventloopDelayStddevName`
181 - `NodejsEventloopDelayStddevUnit`
182 - `NodejsEventloopUtilizationDescription`
183 - `NodejsEventloopUtilizationName`
184 - `NodejsEventloopUtilizationUnit`
185
186 If you use any of these declarations in your Go application, please [open an issue] describing your use-case.
187
188 ### Dropping the `v8js` namespace
189
190 The following declarations have been dropped in `go.opentelemetry.io/otel/semconv/v1.28.0`.
191 These semantic conventions were determined to have not have use in Go applications.
192
193 - `V8JSGCTypeIncremental`
194 - `V8JSGCTypeKey`
195 - `V8JSGCTypeMajor`
196 - `V8JSGCTypeMinor`
197 - `V8JSGCTypeWeakcb`
198 - `V8JSHeapSpaceNameCodeSpace`
199 - `V8JSHeapSpaceNameKey`
200 - `V8JSHeapSpaceNameLargeObjectSpace`
201 - `V8JSHeapSpaceNameMapSpace`
202 - `V8JSHeapSpaceNameNewSpace`
203 - `V8JSHeapSpaceNameOldSpace`
204 - `V8jsGcDurationDescription`
205 - `V8jsGcDurationName`
206 - `V8jsGcDurationUnit`
207 - `V8jsHeapSpaceAvailableSizeDescription`
208 - `V8jsHeapSpaceAvailableSizeName`
209 - `V8jsHeapSpaceAvailableSizeUnit`
210 - `V8jsHeapSpacePhysicalSizeDescription`
211 - `V8jsHeapSpacePhysicalSizeName`
212 - `V8jsHeapSpacePhysicalSizeUnit`
213 - `V8jsMemoryHeapLimitDescription`
214 - `V8jsMemoryHeapLimitName`
215 - `V8jsMemoryHeapLimitUnit`
216 - `V8jsMemoryHeapUsedDescription`
217 - `V8jsMemoryHeapUsedName`
218 - `V8jsMemoryHeapUsedUnit`
219
220 If you use any of these declarations in your Go application, please [open an issue] describing your use-case.
221
222 ### Renames
223
224 The following renames have been introduced to better match Go and industry naming standards.
225 Be sure to update any use from `go.opentelemetry.io/otel/semconv/v1.27.0` with the equivalent in `go.opentelemetry.io/otel/semconv/v1.28.0`.
226
227 | `v1.28.0` | `v1.27.0` |
228 | --- | --- |
229 | DBSystemDb2 | DBSystemDB2|
230 | GenAIClientOperationDurationDescription | GenAiClientOperationDurationDescription|
231 | GenAIClientOperationDurationName | GenAiClientOperationDurationName|
232 | GenAIClientOperationDurationUnit | GenAiClientOperationDurationUnit|
233 | GenAIClientTokenUsageDescription | GenAiClientTokenUsageDescription|
234 | GenAIClientTokenUsageName | GenAiClientTokenUsageName|
235 | GenAIClientTokenUsageUnit | GenAiClientTokenUsageUnit|
236 | GenAIServerRequestDurationDescription | GenAiServerRequestDurationDescription|
237 | GenAIServerRequestDurationName | GenAiServerRequestDurationName|
238 | GenAIServerRequestDurationUnit | GenAiServerRequestDurationUnit|
239 | GenAIServerTimePerOutputTokenDescription | GenAiServerTimePerOutputTokenDescription|
240 | GenAIServerTimePerOutputTokenName | GenAiServerTimePerOutputTokenName|
241 | GenAIServerTimePerOutputTokenUnit | GenAiServerTimePerOutputTokenUnit|
242 | GenAIServerTimeToFirstTokenDescription | GenAiServerTimeToFirstTokenDescription|
243 | GenAIServerTimeToFirstTokenName | GenAiServerTimeToFirstTokenName|
244 | GenAIServerTimeToFirstTokenUnit | GenAiServerTimeToFirstTokenUnit|
245 | GoMemoryGCGoalDescription | GoMemoryGcGoalDescription|
246 | GoMemoryGCGoalName | GoMemoryGcGoalName|
247 | GoMemoryGCGoalUnit | GoMemoryGcGoalUnit|
248
249 [OpenTelemetry Semantic Conventions]: https://github.com/open-telemetry/semantic-conventions
250 [open an issue]: https://github.com/open-telemetry/opentelemetry-go/issues/new?template=Blank+issue