Skip to content

Commit 0092d99

Browse files
authored
chore(resource-detector-gcp): update semconv usage to ATTR_ exports (#3060)
Refs: #2377
1 parent 3f8b5cd commit 0092d99

File tree

3 files changed

+281
-61
lines changed

3 files changed

+281
-61
lines changed

packages/resource-detector-gcp/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@
6464
"dependencies": {
6565
"@opentelemetry/core": "^2.0.0",
6666
"@opentelemetry/resources": "^2.0.0",
67-
"@opentelemetry/semantic-conventions": "^1.27.0",
6867
"gcp-metadata": "^6.0.0"
6968
},
7069
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/resource-detector-gcp#readme",

packages/resource-detector-gcp/src/detectors/GcpDetector.ts

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,25 @@
1818
import { context } from '@opentelemetry/api';
1919
import { suppressTracing } from '@opentelemetry/core';
2020
import {
21-
CLOUDPLATFORMVALUES_GCP_APP_ENGINE,
22-
CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,
23-
CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
24-
CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,
25-
CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,
26-
CLOUDPROVIDERVALUES_GCP,
27-
SEMRESATTRS_CLOUD_ACCOUNT_ID,
28-
SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
29-
SEMRESATTRS_CLOUD_PLATFORM,
30-
SEMRESATTRS_CLOUD_PROVIDER,
31-
SEMRESATTRS_CLOUD_REGION,
32-
SEMRESATTRS_FAAS_INSTANCE,
33-
SEMRESATTRS_FAAS_NAME,
34-
SEMRESATTRS_FAAS_VERSION,
35-
SEMRESATTRS_HOST_ID,
36-
SEMRESATTRS_HOST_NAME,
37-
SEMRESATTRS_HOST_TYPE,
38-
SEMRESATTRS_K8S_CLUSTER_NAME,
39-
} from '@opentelemetry/semantic-conventions';
21+
CLOUD_PLATFORM_VALUE_GCP_APP_ENGINE,
22+
CLOUD_PLATFORM_VALUE_GCP_CLOUD_FUNCTIONS,
23+
CLOUD_PLATFORM_VALUE_GCP_CLOUD_RUN,
24+
CLOUD_PLATFORM_VALUE_GCP_COMPUTE_ENGINE,
25+
CLOUD_PLATFORM_VALUE_GCP_KUBERNETES_ENGINE,
26+
CLOUD_PROVIDER_VALUE_GCP,
27+
ATTR_CLOUD_ACCOUNT_ID,
28+
ATTR_CLOUD_AVAILABILITY_ZONE,
29+
ATTR_CLOUD_PLATFORM,
30+
ATTR_CLOUD_PROVIDER,
31+
ATTR_CLOUD_REGION,
32+
ATTR_FAAS_INSTANCE,
33+
ATTR_FAAS_NAME,
34+
ATTR_FAAS_VERSION,
35+
ATTR_HOST_ID,
36+
ATTR_HOST_NAME,
37+
ATTR_HOST_TYPE,
38+
ATTR_K8S_CLUSTER_NAME,
39+
} from '../semconv';
4040

4141
import { AttributeValue, Attributes } from '@opentelemetry/api';
4242
import {
@@ -54,18 +54,18 @@ import * as gce from './gce';
5454
import * as gke from './gke';
5555

5656
const ATTRIBUTE_NAMES = [
57-
SEMRESATTRS_CLOUD_PLATFORM,
58-
SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
59-
SEMRESATTRS_CLOUD_REGION,
60-
SEMRESATTRS_K8S_CLUSTER_NAME,
61-
SEMRESATTRS_HOST_TYPE,
62-
SEMRESATTRS_HOST_ID,
63-
SEMRESATTRS_HOST_NAME,
64-
SEMRESATTRS_CLOUD_PROVIDER,
65-
SEMRESATTRS_CLOUD_ACCOUNT_ID,
66-
SEMRESATTRS_FAAS_NAME,
67-
SEMRESATTRS_FAAS_VERSION,
68-
SEMRESATTRS_FAAS_INSTANCE,
57+
ATTR_CLOUD_PLATFORM,
58+
ATTR_CLOUD_AVAILABILITY_ZONE,
59+
ATTR_CLOUD_REGION,
60+
ATTR_K8S_CLUSTER_NAME,
61+
ATTR_HOST_TYPE,
62+
ATTR_HOST_ID,
63+
ATTR_HOST_NAME,
64+
ATTR_CLOUD_PROVIDER,
65+
ATTR_CLOUD_ACCOUNT_ID,
66+
ATTR_FAAS_NAME,
67+
ATTR_FAAS_VERSION,
68+
ATTR_FAAS_INSTANCE,
6969
] as const;
7070

7171
// Ensure that all resource keys are accounted for in ATTRIBUTE_NAMES
@@ -104,12 +104,12 @@ async function gkeResource(): Promise<Resource> {
104104
]);
105105

106106
return await makeResource({
107-
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,
107+
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_GCP_KUBERNETES_ENGINE,
108108
[zoneOrRegion.type === 'zone'
109-
? SEMRESATTRS_CLOUD_AVAILABILITY_ZONE
110-
: SEMRESATTRS_CLOUD_REGION]: zoneOrRegion.value,
111-
[SEMRESATTRS_K8S_CLUSTER_NAME]: k8sClusterName,
112-
[SEMRESATTRS_HOST_ID]: hostId,
109+
? ATTR_CLOUD_AVAILABILITY_ZONE
110+
: ATTR_CLOUD_REGION]: zoneOrRegion.value,
111+
[ATTR_K8S_CLUSTER_NAME]: k8sClusterName,
112+
[ATTR_HOST_ID]: hostId,
113113
});
114114
}
115115

@@ -123,11 +123,11 @@ async function cloudRunResource(): Promise<Resource> {
123123
]);
124124

125125
return await makeResource({
126-
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
127-
[SEMRESATTRS_FAAS_NAME]: faasName,
128-
[SEMRESATTRS_FAAS_VERSION]: faasVersion,
129-
[SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
130-
[SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,
126+
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_GCP_CLOUD_RUN,
127+
[ATTR_FAAS_NAME]: faasName,
128+
[ATTR_FAAS_VERSION]: faasVersion,
129+
[ATTR_FAAS_INSTANCE]: faasInstance,
130+
[ATTR_CLOUD_REGION]: faasCloudRegion,
131131
});
132132
}
133133

@@ -141,11 +141,11 @@ async function cloudFunctionsResource(): Promise<Resource> {
141141
]);
142142

143143
return await makeResource({
144-
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,
145-
[SEMRESATTRS_FAAS_NAME]: faasName,
146-
[SEMRESATTRS_FAAS_VERSION]: faasVersion,
147-
[SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
148-
[SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,
144+
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_GCP_CLOUD_FUNCTIONS,
145+
[ATTR_FAAS_NAME]: faasName,
146+
[ATTR_FAAS_VERSION]: faasVersion,
147+
[ATTR_FAAS_INSTANCE]: faasInstance,
148+
[ATTR_CLOUD_REGION]: faasCloudRegion,
149149
});
150150
}
151151

@@ -166,12 +166,12 @@ async function gaeResource(): Promise<Resource> {
166166
]);
167167

168168
return await makeResource({
169-
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_APP_ENGINE,
170-
[SEMRESATTRS_FAAS_NAME]: faasName,
171-
[SEMRESATTRS_FAAS_VERSION]: faasVersion,
172-
[SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
173-
[SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zone,
174-
[SEMRESATTRS_CLOUD_REGION]: region,
169+
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_GCP_APP_ENGINE,
170+
[ATTR_FAAS_NAME]: faasName,
171+
[ATTR_FAAS_VERSION]: faasVersion,
172+
[ATTR_FAAS_INSTANCE]: faasInstance,
173+
[ATTR_CLOUD_AVAILABILITY_ZONE]: zone,
174+
[ATTR_CLOUD_REGION]: region,
175175
});
176176
}
177177

@@ -184,21 +184,21 @@ async function gceResource(): Promise<Resource> {
184184
]);
185185

186186
return await makeResource({
187-
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,
188-
[SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zoneAndRegion.zone,
189-
[SEMRESATTRS_CLOUD_REGION]: zoneAndRegion.region,
190-
[SEMRESATTRS_HOST_TYPE]: hostType,
191-
[SEMRESATTRS_HOST_ID]: hostId,
192-
[SEMRESATTRS_HOST_NAME]: hostName,
187+
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_GCP_COMPUTE_ENGINE,
188+
[ATTR_CLOUD_AVAILABILITY_ZONE]: zoneAndRegion.zone,
189+
[ATTR_CLOUD_REGION]: zoneAndRegion.region,
190+
[ATTR_HOST_TYPE]: hostType,
191+
[ATTR_HOST_ID]: hostId,
192+
[ATTR_HOST_NAME]: hostName,
193193
});
194194
}
195195

196196
async function makeResource(attrs: GcpResourceAttributes): Promise<Resource> {
197197
const project = await metadata.project<string>('project-id');
198198

199199
return resourceFromAttributes({
200-
[SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_GCP,
201-
[SEMRESATTRS_CLOUD_ACCOUNT_ID]: project,
200+
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_GCP,
201+
[ATTR_CLOUD_ACCOUNT_ID]: project,
202202
...attrs,
203203
} satisfies GcpResourceAttributes);
204204
}

0 commit comments

Comments
 (0)