File tree 3 files changed +10
-8
lines changed
3 files changed +10
-8
lines changed Original file line number Diff line number Diff line change @@ -116,6 +116,8 @@ This object contains aliases for the main `appInfo` properties that correspond t
116
116
* ` appInfo.semanticConventions.service.version ` aliases ` appInfo.releaseVersion `
117
117
* ` appInfo.semanticConventions.service.instance.id ` aliases ` appInfo.instanceId `
118
118
119
+ > [ !WARNING]
120
+ > While all other properties default to ` null ` if they can't be calculated, the semantic conventions properties default to ` undefined ` . This is to ensure better compatibility with OpenTelemetry SDKs.
119
121
120
122
## Migrating
121
123
Original file line number Diff line number Diff line change @@ -163,15 +163,15 @@ exports.instanceId = process.env.HEROKU_DYNO_ID || randomUUID();
163
163
*/
164
164
exports . semanticConventions = {
165
165
cloud : {
166
- provider : exports . cloudProvider ,
167
- region : exports . region
166
+ provider : exports . cloudProvider || undefined ,
167
+ region : exports . region || undefined
168
168
} ,
169
169
deployment : {
170
170
environment : exports . environment
171
171
} ,
172
172
service : {
173
- name : exports . systemCode ,
174
- version : exports . releaseVersion ,
173
+ name : exports . systemCode || undefined ,
174
+ version : exports . releaseVersion || undefined ,
175
175
instance : {
176
176
id : exports . instanceId
177
177
}
Original file line number Diff line number Diff line change @@ -13,15 +13,15 @@ declare module '@dotcom-reliability-kit/app-info' {
13
13
14
14
export type SemanticConventions = {
15
15
cloud : {
16
- provider : string | null ,
17
- region : string | null
16
+ provider ? : string ,
17
+ region ? : string
18
18
} ,
19
19
deployment : {
20
20
environment : string
21
21
} ,
22
22
service : {
23
- name : string | null
24
- version : string | null ,
23
+ name ? : string
24
+ version ? : string ,
25
25
instance : {
26
26
id : string
27
27
}
You can’t perform that action at this time.
0 commit comments