Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(detector-aws): remove all deprecation warnings #2642

Merged
merged 11 commits into from
Jan 17, 2025
Merged

fix(detector-aws): remove all deprecation warnings #2642

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
320fefe
fix lambda
garysassano Jan 13, 2025
7b60056
fix beanstalk
garysassano Jan 13, 2025
dd7aa29
fix ec2
garysassano Jan 13, 2025
693a09e
fix ecs
garysassano Jan 13, 2025
cb6a45d
fix eks
garysassano Jan 13, 2025
107efcc
remove lockfile
garysassano Jan 13, 2025
91ce6be
revert package.json
garysassano Jan 15, 2025
7d08d73
Merge branch 'main' into fix-deprecated-aws
garysassano Jan 15, 2025
4e9dcbd
Merge branch 'main' into fix-deprecated-aws
garysassano Jan 16, 2025
444254c
Merge branch 'main' into fix-deprecated-aws
garysassano Jan 16, 2025
29e169c
Merge branch 'main' into fix-deprecated-aws
garysassano Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions detectors/node/opentelemetry-resource-detector-aws/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,26 @@
"access": "public"
},
"devDependencies": {
"@opentelemetry/api": "^1.0.0",
"@opentelemetry/api": "^1.9.0",
garysassano marked this conversation as resolved.
Show resolved Hide resolved
"@opentelemetry/contrib-test-utils": "^0.45.0",
"@opentelemetry/instrumentation-fs": "^0.19.0",
"@opentelemetry/instrumentation-http": "^0.57.0",
"@types/mocha": "8.2.3",
"@types/node": "18.18.14",
"@types/sinon": "10.0.20",
"nock": "13.3.3",
"nyc": "15.1.0",
"rimraf": "5.0.10",
"sinon": "15.2.0",
"typescript": "4.4.4"
"@types/mocha": "10.0.10",
"@types/node": "22.10.6",
"@types/sinon": "17.0.3",
"nock": "13.5.6",
"nyc": "17.1.0",
"rimraf": "6.0.1",
"sinon": "19.0.2",
"typescript": "5.7.3"
garysassano marked this conversation as resolved.
Show resolved Hide resolved
},
"peerDependencies": {
"@opentelemetry/api": "^1.0.0"
},
"dependencies": {
"@opentelemetry/core": "^1.0.0",
"@opentelemetry/resources": "^1.10.0",
"@opentelemetry/semantic-conventions": "^1.27.0"
"@opentelemetry/core": "^1.30.0",
"@opentelemetry/resources": "^1.30.0",
"@opentelemetry/semantic-conventions": "^1.28.0"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-aws#readme"
}
30 changes: 15 additions & 15 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsBeanstalkDetectorSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ import {
ResourceDetectionConfig,
} from '@opentelemetry/resources';
import {
SEMRESATTRS_CLOUD_PROVIDER,
SEMRESATTRS_CLOUD_PLATFORM,
SEMRESATTRS_SERVICE_NAME,
SEMRESATTRS_SERVICE_NAMESPACE,
SEMRESATTRS_SERVICE_VERSION,
SEMRESATTRS_SERVICE_INSTANCE_ID,
CLOUDPROVIDERVALUES_AWS,
CLOUDPLATFORMVALUES_AWS_ELASTIC_BEANSTALK,
} from '@opentelemetry/semantic-conventions';
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_SERVICE_NAME,
ATTR_SERVICE_NAMESPACE,
ATTR_SERVICE_VERSION,
ATTR_SERVICE_INSTANCE_ID,
CLOUD_PROVIDER_VALUE_AWS,
CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
} from '@opentelemetry/semantic-conventions/incubating';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I didn't review this soon enough. We decided not to use incubating directly in runtime code.
https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for bringing this to my attention. I've opened a new PR to address the issue: #2668

import * as fs from 'fs';
import * as util from 'util';

Expand Down Expand Up @@ -95,12 +95,12 @@ export class AwsBeanstalkDetectorSync implements DetectorSync {
const parsedData = JSON.parse(rawData);

return {
[SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AWS,
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AWS_ELASTIC_BEANSTALK,
[SEMRESATTRS_SERVICE_NAME]: CLOUDPLATFORMVALUES_AWS_ELASTIC_BEANSTALK,
[SEMRESATTRS_SERVICE_NAMESPACE]: parsedData.environment_name,
[SEMRESATTRS_SERVICE_VERSION]: parsedData.version_label,
[SEMRESATTRS_SERVICE_INSTANCE_ID]: parsedData.deployment_id,
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
[ATTR_SERVICE_NAME]: CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
[ATTR_SERVICE_NAMESPACE]: parsedData.environment_name,
[ATTR_SERVICE_VERSION]: parsedData.version_label,
[ATTR_SERVICE_INSTANCE_ID]: parsedData.deployment_id,
};
} catch (e: any) {
diag.debug(`AwsBeanstalkDetectorSync failed: ${e.message}`);
Expand Down
38 changes: 19 additions & 19 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEc2DetectorSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ import {
ResourceDetectionConfig,
} from '@opentelemetry/resources';
import {
SEMRESATTRS_CLOUD_PROVIDER,
SEMRESATTRS_CLOUD_PLATFORM,
SEMRESATTRS_CLOUD_REGION,
SEMRESATTRS_CLOUD_ACCOUNT_ID,
SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
SEMRESATTRS_HOST_ID,
SEMRESATTRS_HOST_TYPE,
SEMRESATTRS_HOST_NAME,
CLOUDPROVIDERVALUES_AWS,
CLOUDPLATFORMVALUES_AWS_EC2,
} from '@opentelemetry/semantic-conventions';
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_CLOUD_REGION,
ATTR_CLOUD_ACCOUNT_ID,
ATTR_CLOUD_AVAILABILITY_ZONE,
ATTR_HOST_ID,
ATTR_HOST_TYPE,
ATTR_HOST_NAME,
CLOUD_PROVIDER_VALUE_AWS,
CLOUD_PLATFORM_VALUE_AWS_EC2,
} from '@opentelemetry/semantic-conventions/incubating';
import * as http from 'http';

/**
Expand Down Expand Up @@ -79,14 +79,14 @@ class AwsEc2DetectorSync implements DetectorSync {
const hostname = await this._fetchHost(token);

return {
[SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AWS,
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AWS_EC2,
[SEMRESATTRS_CLOUD_ACCOUNT_ID]: accountId,
[SEMRESATTRS_CLOUD_REGION]: region,
[SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
[SEMRESATTRS_HOST_ID]: instanceId,
[SEMRESATTRS_HOST_TYPE]: instanceType,
[SEMRESATTRS_HOST_NAME]: hostname,
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_EC2,
[ATTR_CLOUD_ACCOUNT_ID]: accountId,
[ATTR_CLOUD_REGION]: region,
[ATTR_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
[ATTR_HOST_ID]: instanceId,
[ATTR_HOST_TYPE]: instanceType,
[ATTR_HOST_NAME]: hostname,
};
} catch {
return {};
Expand Down
76 changes: 38 additions & 38 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,26 @@ import {
ResourceAttributes,
} from '@opentelemetry/resources';
import {
SEMRESATTRS_CLOUD_PROVIDER,
SEMRESATTRS_CLOUD_PLATFORM,
SEMRESATTRS_CONTAINER_ID,
SEMRESATTRS_CONTAINER_NAME,
SEMRESATTRS_AWS_ECS_CONTAINER_ARN,
SEMRESATTRS_AWS_ECS_CLUSTER_ARN,
SEMRESATTRS_AWS_ECS_LAUNCHTYPE,
SEMRESATTRS_AWS_ECS_TASK_ARN,
SEMRESATTRS_AWS_ECS_TASK_FAMILY,
SEMRESATTRS_AWS_ECS_TASK_REVISION,
SEMRESATTRS_CLOUD_ACCOUNT_ID,
SEMRESATTRS_CLOUD_REGION,
SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
SEMRESATTRS_AWS_LOG_GROUP_NAMES,
SEMRESATTRS_AWS_LOG_GROUP_ARNS,
SEMRESATTRS_AWS_LOG_STREAM_NAMES,
SEMRESATTRS_AWS_LOG_STREAM_ARNS,
CLOUDPROVIDERVALUES_AWS,
CLOUDPLATFORMVALUES_AWS_ECS,
} from '@opentelemetry/semantic-conventions';
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_CONTAINER_ID,
ATTR_CONTAINER_NAME,
ATTR_AWS_ECS_CONTAINER_ARN,
ATTR_AWS_ECS_CLUSTER_ARN,
ATTR_AWS_ECS_LAUNCHTYPE,
ATTR_AWS_ECS_TASK_ARN,
ATTR_AWS_ECS_TASK_FAMILY,
ATTR_AWS_ECS_TASK_REVISION,
ATTR_CLOUD_ACCOUNT_ID,
ATTR_CLOUD_REGION,
ATTR_CLOUD_AVAILABILITY_ZONE,
ATTR_AWS_LOG_GROUP_NAMES,
ATTR_AWS_LOG_GROUP_ARNS,
ATTR_AWS_LOG_STREAM_NAMES,
ATTR_AWS_LOG_STREAM_ARNS,
CLOUD_PROVIDER_VALUE_AWS,
CLOUD_PLATFORM_VALUE_AWS_ECS,
} from '@opentelemetry/semantic-conventions/incubating';
// Patch until the OpenTelemetry SDK is updated to ship this attribute
import { SemanticResourceAttributes as AdditionalSemanticResourceAttributes } from './SemanticResourceAttributes';
import * as http from 'http';
Expand Down Expand Up @@ -86,8 +86,8 @@ export class AwsEcsDetectorSync implements DetectorSync {

try {
let resource = new Resource({
[SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AWS,
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AWS_ECS,
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_ECS,
}).merge(await AwsEcsDetectorSync._getContainerIdAndHostnameResource());

const metadataUrl = getEnv().ECS_CONTAINER_METADATA_URI_V4;
Expand Down Expand Up @@ -146,8 +146,8 @@ export class AwsEcsDetectorSync implements DetectorSync {

if (hostName || containerId) {
return new Resource({
[SEMRESATTRS_CONTAINER_NAME]: hostName || '',
[SEMRESATTRS_CONTAINER_ID]: containerId || '',
[ATTR_CONTAINER_NAME]: hostName || '',
[ATTR_CONTAINER_ID]: containerId || '',
});
}

Expand Down Expand Up @@ -177,21 +177,21 @@ export class AwsEcsDetectorSync implements DetectorSync {

// https://github.com/open-telemetry/semantic-conventions/blob/main/semantic_conventions/resource/cloud_provider/aws/ecs.yaml
const attributes: ResourceAttributes = {
[SEMRESATTRS_AWS_ECS_CONTAINER_ARN]: containerArn,
[SEMRESATTRS_AWS_ECS_CLUSTER_ARN]: clusterArn,
[SEMRESATTRS_AWS_ECS_LAUNCHTYPE]: launchType?.toLowerCase(),
[SEMRESATTRS_AWS_ECS_TASK_ARN]: taskArn,
[SEMRESATTRS_AWS_ECS_TASK_FAMILY]: taskMetadata['Family'],
[SEMRESATTRS_AWS_ECS_TASK_REVISION]: taskMetadata['Revision'],

[SEMRESATTRS_CLOUD_ACCOUNT_ID]: accountId,
[SEMRESATTRS_CLOUD_REGION]: region,
[ATTR_AWS_ECS_CONTAINER_ARN]: containerArn,
[ATTR_AWS_ECS_CLUSTER_ARN]: clusterArn,
[ATTR_AWS_ECS_LAUNCHTYPE]: launchType?.toLowerCase(),
[ATTR_AWS_ECS_TASK_ARN]: taskArn,
[ATTR_AWS_ECS_TASK_FAMILY]: taskMetadata['Family'],
[ATTR_AWS_ECS_TASK_REVISION]: taskMetadata['Revision'],

[ATTR_CLOUD_ACCOUNT_ID]: accountId,
[ATTR_CLOUD_REGION]: region,
[AdditionalSemanticResourceAttributes.CLOUD_RESOURCE_ID]: containerArn,
};

// The availability zone is not available in all Fargate runtimes
if (availabilityZone) {
attributes[SEMRESATTRS_CLOUD_AVAILABILITY_ZONE] = availabilityZone;
attributes[ATTR_CLOUD_AVAILABILITY_ZONE] = availabilityZone;
}

return new Resource(attributes);
Expand Down Expand Up @@ -222,10 +222,10 @@ export class AwsEcsDetectorSync implements DetectorSync {
const logsStreamArn = `arn:aws:logs:${logsRegion}:${awsAccount}:log-group:${logsGroupName}:log-stream:${logsStreamName}`;

return new Resource({
[SEMRESATTRS_AWS_LOG_GROUP_NAMES]: [logsGroupName],
[SEMRESATTRS_AWS_LOG_GROUP_ARNS]: [logsGroupArn],
[SEMRESATTRS_AWS_LOG_STREAM_NAMES]: [logsStreamName],
[SEMRESATTRS_AWS_LOG_STREAM_ARNS]: [logsStreamArn],
[ATTR_AWS_LOG_GROUP_NAMES]: [logsGroupName],
[ATTR_AWS_LOG_GROUP_ARNS]: [logsGroupArn],
[ATTR_AWS_LOG_STREAM_NAMES]: [logsStreamName],
[ATTR_AWS_LOG_STREAM_ARNS]: [logsStreamArn],
});
}

Expand Down
22 changes: 11 additions & 11 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEksDetectorSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ import {
ResourceDetectionConfig,
} from '@opentelemetry/resources';
import {
SEMRESATTRS_CLOUD_PROVIDER,
SEMRESATTRS_CLOUD_PLATFORM,
SEMRESATTRS_K8S_CLUSTER_NAME,
SEMRESATTRS_CONTAINER_ID,
CLOUDPROVIDERVALUES_AWS,
CLOUDPLATFORMVALUES_AWS_EKS,
} from '@opentelemetry/semantic-conventions';
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_K8S_CLUSTER_NAME,
ATTR_CONTAINER_ID,
CLOUD_PROVIDER_VALUE_AWS,
CLOUD_PLATFORM_VALUE_AWS_EKS,
} from '@opentelemetry/semantic-conventions/incubating';
import * as https from 'https';
import * as fs from 'fs';
import * as util from 'util';
Expand Down Expand Up @@ -94,10 +94,10 @@ export class AwsEksDetectorSync implements DetectorSync {
return !containerId && !clusterName
? {}
: {
[SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AWS,
[SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AWS_EKS,
[SEMRESATTRS_K8S_CLUSTER_NAME]: clusterName || '',
[SEMRESATTRS_CONTAINER_ID]: containerId || '',
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_EKS,
[ATTR_K8S_CLUSTER_NAME]: clusterName || '',
[ATTR_CONTAINER_ID]: containerId || '',
};
} catch (e) {
diag.debug('Process is not running on K8S', e);
Expand Down
26 changes: 13 additions & 13 deletions detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsLambdaDetectorSync.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ import {
ResourceDetectionConfig,
} from '@opentelemetry/resources';
import {
SEMRESATTRS_CLOUD_PROVIDER,
SEMRESATTRS_CLOUD_PLATFORM,
SEMRESATTRS_CLOUD_REGION,
SEMRESATTRS_FAAS_VERSION,
SEMRESATTRS_FAAS_NAME,
CLOUDPROVIDERVALUES_AWS,
CLOUDPLATFORMVALUES_AWS_LAMBDA,
} from '@opentelemetry/semantic-conventions';
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_CLOUD_REGION,
ATTR_FAAS_VERSION,
ATTR_FAAS_NAME,
CLOUD_PROVIDER_VALUE_AWS,
CLOUD_PLATFORM_VALUE_AWS_LAMBDA,
} from '@opentelemetry/semantic-conventions/incubating';

/**
* The AwsLambdaDetector can be used to detect if a process is running in AWS Lambda
Expand All @@ -47,18 +47,18 @@ export class AwsLambdaDetectorSync implements DetectorSync {
const region = process.env.AWS_REGION;

const attributes: ResourceAttributes = {
[SEMRESATTRS_CLOUD_PROVIDER]: String(CLOUDPROVIDERVALUES_AWS),
[SEMRESATTRS_CLOUD_PLATFORM]: String(CLOUDPLATFORMVALUES_AWS_LAMBDA),
[ATTR_CLOUD_PROVIDER]: String(CLOUD_PROVIDER_VALUE_AWS),
[ATTR_CLOUD_PLATFORM]: String(CLOUD_PLATFORM_VALUE_AWS_LAMBDA),
};
if (region) {
attributes[SEMRESATTRS_CLOUD_REGION] = region;
attributes[ATTR_CLOUD_REGION] = region;
}

if (functionName) {
attributes[SEMRESATTRS_FAAS_NAME] = functionName;
attributes[ATTR_FAAS_NAME] = functionName;
}
if (functionVersion) {
attributes[SEMRESATTRS_FAAS_VERSION] = functionVersion;
attributes[ATTR_FAAS_VERSION] = functionVersion;
}

return new Resource(attributes);
Expand Down
Loading