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

chore(aws-sdk): migrate SEMATTRS_* to ATTR_* #2550

Closed
wants to merge 2 commits into from
Closed

chore(aws-sdk): migrate SEMATTRS_* to ATTR_* #2550

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3626c52
chore(aws-sdk): migrate 'SEMATTRS_*' to 'ATTR_*'
trivikr Nov 26, 2024
6333ee3
fix(aws-sdk): reintroduce `SEMATTRS_*` which were changed
trivikr Nov 26, 2024
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
14 changes: 4 additions & 10 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/aws-sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ import {
} from './utils';
import { propwrap } from './propwrap';
import { RequestMetadata } from './services/ServiceExtension';
import { SEMATTRS_HTTP_STATUS_CODE } from '@opentelemetry/semantic-conventions';
import { ATTR_HTTP_STATUS_CODE } from '@opentelemetry/semantic-conventions/incubating';

const V3_CLIENT_CONFIG_KEY = Symbol(
'opentelemetry.instrumentation.aws-sdk.client.config'
Expand Down Expand Up @@ -348,7 +348,7 @@ export class AwsInstrumentation extends InstrumentationBase<AwsSdkInstrumentatio

const httpStatusCode = response.httpResponse?.statusCode;
if (httpStatusCode) {
span.setAttribute(SEMATTRS_HTTP_STATUS_CODE, httpStatusCode);
span.setAttribute(ATTR_HTTP_STATUS_CODE, httpStatusCode);
}
span.end();
});
Expand Down Expand Up @@ -501,10 +501,7 @@ export class AwsInstrumentation extends InstrumentationBase<AwsSdkInstrumentatio
const httpStatusCode =
response.output?.$metadata?.httpStatusCode;
if (httpStatusCode) {
span.setAttribute(
SEMATTRS_HTTP_STATUS_CODE,
httpStatusCode
);
span.setAttribute(ATTR_HTTP_STATUS_CODE, httpStatusCode);
}

const extendedRequestId =
Expand Down Expand Up @@ -538,10 +535,7 @@ export class AwsInstrumentation extends InstrumentationBase<AwsSdkInstrumentatio

const httpStatusCode = err?.$metadata?.httpStatusCode;
if (httpStatusCode) {
span.setAttribute(
SEMATTRS_HTTP_STATUS_CODE,
httpStatusCode
);
span.setAttribute(ATTR_HTTP_STATUS_CODE, httpStatusCode);
}

const extendedRequestId = err?.extendedRequestId;
Expand Down
115 changes: 57 additions & 58 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/dynamodb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,33 +22,33 @@ import {
} from '@opentelemetry/api';
import { RequestMetadata, ServiceExtension } from './ServiceExtension';
import {
DBSYSTEMVALUES_DYNAMODB,
SEMATTRS_AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS,
SEMATTRS_AWS_DYNAMODB_CONSISTENT_READ,
SEMATTRS_AWS_DYNAMODB_CONSUMED_CAPACITY,
SEMATTRS_AWS_DYNAMODB_COUNT,
SEMATTRS_AWS_DYNAMODB_EXCLUSIVE_START_TABLE,
SEMATTRS_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES,
SEMATTRS_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES,
SEMATTRS_AWS_DYNAMODB_INDEX_NAME,
SEMATTRS_AWS_DYNAMODB_ITEM_COLLECTION_METRICS,
SEMATTRS_AWS_DYNAMODB_LIMIT,
SEMATTRS_AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES,
SEMATTRS_AWS_DYNAMODB_PROJECTION,
SEMATTRS_AWS_DYNAMODB_PROVISIONED_READ_CAPACITY,
SEMATTRS_AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY,
SEMATTRS_AWS_DYNAMODB_SCAN_FORWARD,
SEMATTRS_AWS_DYNAMODB_SCANNED_COUNT,
SEMATTRS_AWS_DYNAMODB_SEGMENT,
SEMATTRS_AWS_DYNAMODB_SELECT,
SEMATTRS_AWS_DYNAMODB_TABLE_COUNT,
SEMATTRS_AWS_DYNAMODB_TABLE_NAMES,
SEMATTRS_AWS_DYNAMODB_TOTAL_SEGMENTS,
SEMATTRS_DB_NAME,
SEMATTRS_DB_OPERATION,
SEMATTRS_DB_STATEMENT,
SEMATTRS_DB_SYSTEM,
} from '@opentelemetry/semantic-conventions';
ATTR_AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS,
ATTR_AWS_DYNAMODB_CONSISTENT_READ,
ATTR_AWS_DYNAMODB_CONSUMED_CAPACITY,
ATTR_AWS_DYNAMODB_COUNT,
ATTR_AWS_DYNAMODB_EXCLUSIVE_START_TABLE,
ATTR_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES,
ATTR_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES,
ATTR_AWS_DYNAMODB_INDEX_NAME,
ATTR_AWS_DYNAMODB_ITEM_COLLECTION_METRICS,
ATTR_AWS_DYNAMODB_LIMIT,
ATTR_AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES,
ATTR_AWS_DYNAMODB_PROJECTION,
ATTR_AWS_DYNAMODB_PROVISIONED_READ_CAPACITY,
ATTR_AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY,
ATTR_AWS_DYNAMODB_SCAN_FORWARD,
ATTR_AWS_DYNAMODB_SCANNED_COUNT,
ATTR_AWS_DYNAMODB_SEGMENT,
ATTR_AWS_DYNAMODB_SELECT,
ATTR_AWS_DYNAMODB_TABLE_COUNT,
ATTR_AWS_DYNAMODB_TABLE_NAMES,
ATTR_AWS_DYNAMODB_TOTAL_SEGMENTS,
ATTR_DB_NAME,
ATTR_DB_OPERATION,
ATTR_DB_STATEMENT,
ATTR_DB_SYSTEM,
DB_SYSTEM_VALUE_DYNAMODB,
} from '@opentelemetry/semantic-conventions/incubating';
import {
AwsSdkInstrumentationConfig,
NormalizedRequest,
Expand All @@ -71,9 +71,9 @@ export class DynamodbServiceExtension implements ServiceExtension {
const operation = normalizedRequest.commandName;

const spanAttributes: Attributes = {
[SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_DYNAMODB,
[SEMATTRS_DB_NAME]: normalizedRequest.commandInput?.TableName,
[SEMATTRS_DB_OPERATION]: operation,
[ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_DYNAMODB,
[ATTR_DB_NAME]: normalizedRequest.commandInput?.TableName,
[ATTR_DB_OPERATION]: operation,
};

if (config.dynamoDBStatementSerializer) {
Expand All @@ -84,7 +84,7 @@ export class DynamodbServiceExtension implements ServiceExtension {
);

if (typeof sanitizedStatement === 'string') {
spanAttributes[SEMATTRS_DB_STATEMENT] = sanitizedStatement;
spanAttributes[ATTR_DB_STATEMENT] = sanitizedStatement;
}
} catch (err) {
diag.error('failed to sanitize DynamoDB statement', err);
Expand All @@ -96,21 +96,21 @@ export class DynamodbServiceExtension implements ServiceExtension {
if (normalizedRequest.commandInput?.TableName) {
// Necessary for commands with only 1 table name (example: CreateTable). Attribute is TableName not keys of RequestItems
// single table name returned for operations like CreateTable
spanAttributes[SEMATTRS_AWS_DYNAMODB_TABLE_NAMES] = [
spanAttributes[ATTR_AWS_DYNAMODB_TABLE_NAMES] = [
normalizedRequest.commandInput.TableName,
];
} else if (normalizedRequest.commandInput?.RequestItems) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_TABLE_NAMES] = Object.keys(
spanAttributes[ATTR_AWS_DYNAMODB_TABLE_NAMES] = Object.keys(
normalizedRequest.commandInput.RequestItems
);
}

if (operation === 'CreateTable' || operation === 'UpdateTable') {
// only check for ProvisionedThroughput since ReadCapacityUnits and WriteCapacity units are required attributes
if (normalizedRequest.commandInput?.ProvisionedThroughput) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_PROVISIONED_READ_CAPACITY] =
spanAttributes[ATTR_AWS_DYNAMODB_PROVISIONED_READ_CAPACITY] =
normalizedRequest.commandInput.ProvisionedThroughput.ReadCapacityUnits;
spanAttributes[SEMATTRS_AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY] =
spanAttributes[ATTR_AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY] =
normalizedRequest.commandInput.ProvisionedThroughput.WriteCapacityUnits;
}
}
Expand All @@ -121,28 +121,28 @@ export class DynamodbServiceExtension implements ServiceExtension {
operation === 'Query'
) {
if (normalizedRequest.commandInput?.ConsistentRead) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_CONSISTENT_READ] =
spanAttributes[ATTR_AWS_DYNAMODB_CONSISTENT_READ] =
normalizedRequest.commandInput.ConsistentRead;
}
}

if (operation === 'Query' || operation === 'Scan') {
if (normalizedRequest.commandInput?.ProjectionExpression) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_PROJECTION] =
spanAttributes[ATTR_AWS_DYNAMODB_PROJECTION] =
normalizedRequest.commandInput.ProjectionExpression;
}
}

if (operation === 'CreateTable') {
if (normalizedRequest.commandInput?.GlobalSecondaryIndexes) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES] =
spanAttributes[ATTR_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES] =
this.toArray(
normalizedRequest.commandInput.GlobalSecondaryIndexes
).map((x: { [DictionaryKey: string]: any }) => JSON.stringify(x));
}

if (normalizedRequest.commandInput?.LocalSecondaryIndexes) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES] =
spanAttributes[ATTR_AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES] =
this.toArray(
normalizedRequest.commandInput.LocalSecondaryIndexes
).map((x: { [DictionaryKey: string]: any }) => JSON.stringify(x));
Expand All @@ -155,67 +155,66 @@ export class DynamodbServiceExtension implements ServiceExtension {
operation === 'Scan'
) {
if (normalizedRequest.commandInput?.Limit) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_LIMIT] =
spanAttributes[ATTR_AWS_DYNAMODB_LIMIT] =
normalizedRequest.commandInput.Limit;
}
}

if (operation === 'ListTables') {
if (normalizedRequest.commandInput?.ExclusiveStartTableName) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_EXCLUSIVE_START_TABLE] =
spanAttributes[ATTR_AWS_DYNAMODB_EXCLUSIVE_START_TABLE] =
normalizedRequest.commandInput.ExclusiveStartTableName;
}
}

if (operation === 'Query') {
if (normalizedRequest.commandInput?.ScanIndexForward) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_SCAN_FORWARD] =
spanAttributes[ATTR_AWS_DYNAMODB_SCAN_FORWARD] =
normalizedRequest.commandInput.ScanIndexForward;
}

if (normalizedRequest.commandInput?.IndexName) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_INDEX_NAME] =
spanAttributes[ATTR_AWS_DYNAMODB_INDEX_NAME] =
normalizedRequest.commandInput.IndexName;
}

if (normalizedRequest.commandInput?.Select) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_SELECT] =
spanAttributes[ATTR_AWS_DYNAMODB_SELECT] =
normalizedRequest.commandInput.Select;
}
}

if (operation === 'Scan') {
if (normalizedRequest.commandInput?.Segment) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_SEGMENT] =
spanAttributes[ATTR_AWS_DYNAMODB_SEGMENT] =
normalizedRequest.commandInput?.Segment;
}

if (normalizedRequest.commandInput?.TotalSegments) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_TOTAL_SEGMENTS] =
spanAttributes[ATTR_AWS_DYNAMODB_TOTAL_SEGMENTS] =
normalizedRequest.commandInput?.TotalSegments;
}

if (normalizedRequest.commandInput?.IndexName) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_INDEX_NAME] =
spanAttributes[ATTR_AWS_DYNAMODB_INDEX_NAME] =
normalizedRequest.commandInput.IndexName;
}

if (normalizedRequest.commandInput?.Select) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_SELECT] =
spanAttributes[ATTR_AWS_DYNAMODB_SELECT] =
normalizedRequest.commandInput.Select;
}
}

if (operation === 'UpdateTable') {
if (normalizedRequest.commandInput?.AttributeDefinitions) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS] =
this.toArray(normalizedRequest.commandInput.AttributeDefinitions).map(
(x: { [DictionaryKey: string]: any }) => JSON.stringify(x)
);
spanAttributes[ATTR_AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS] = this.toArray(
normalizedRequest.commandInput.AttributeDefinitions
).map((x: { [DictionaryKey: string]: any }) => JSON.stringify(x));
}

if (normalizedRequest.commandInput?.GlobalSecondaryIndexUpdates) {
spanAttributes[SEMATTRS_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES] =
spanAttributes[ATTR_AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES] =
this.toArray(
normalizedRequest.commandInput.GlobalSecondaryIndexUpdates
).map((x: { [DictionaryKey: string]: any }) => JSON.stringify(x));
Expand All @@ -238,7 +237,7 @@ export class DynamodbServiceExtension implements ServiceExtension {
) {
if (response.data?.ConsumedCapacity) {
span.setAttribute(
SEMATTRS_AWS_DYNAMODB_CONSUMED_CAPACITY,
ATTR_AWS_DYNAMODB_CONSUMED_CAPACITY,
toArray(response.data.ConsumedCapacity).map(
(x: { [DictionaryKey: string]: any }) => JSON.stringify(x)
)
Expand All @@ -247,7 +246,7 @@ export class DynamodbServiceExtension implements ServiceExtension {

if (response.data?.ItemCollectionMetrics) {
span.setAttribute(
SEMATTRS_AWS_DYNAMODB_ITEM_COLLECTION_METRICS,
ATTR_AWS_DYNAMODB_ITEM_COLLECTION_METRICS,
this.toArray(response.data.ItemCollectionMetrics).map(
(x: { [DictionaryKey: string]: any }) => JSON.stringify(x)
)
Expand All @@ -256,18 +255,18 @@ export class DynamodbServiceExtension implements ServiceExtension {

if (response.data?.TableNames) {
span.setAttribute(
SEMATTRS_AWS_DYNAMODB_TABLE_COUNT,
ATTR_AWS_DYNAMODB_TABLE_COUNT,
response.data?.TableNames.length
);
}

if (response.data?.Count) {
span.setAttribute(SEMATTRS_AWS_DYNAMODB_COUNT, response.data?.Count);
span.setAttribute(ATTR_AWS_DYNAMODB_COUNT, response.data?.Count);
}

if (response.data?.ScannedCount) {
span.setAttribute(
SEMATTRS_AWS_DYNAMODB_SCANNED_COUNT,
ATTR_AWS_DYNAMODB_SCANNED_COUNT,
response.data?.ScannedCount
);
}
Expand Down
18 changes: 9 additions & 9 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/lambda.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
*/
import { Span, SpanKind, Tracer, diag, Attributes } from '@opentelemetry/api';
import {
SEMATTRS_FAAS_EXECUTION,
SEMATTRS_FAAS_INVOKED_NAME,
SEMATTRS_FAAS_INVOKED_PROVIDER,
SEMATTRS_FAAS_INVOKED_REGION,
} from '@opentelemetry/semantic-conventions';
ATTR_FAAS_INVOCATION_ID,
ATTR_FAAS_INVOKED_NAME,
ATTR_FAAS_INVOKED_PROVIDER,
ATTR_FAAS_INVOKED_REGION,
} from '@opentelemetry/semantic-conventions/incubating';
import {
AwsSdkInstrumentationConfig,
NormalizedRequest,
Expand All @@ -45,11 +45,11 @@
switch (request.commandName) {
case 'Invoke':
spanAttributes = {
[SEMATTRS_FAAS_INVOKED_NAME]: functionName,
[SEMATTRS_FAAS_INVOKED_PROVIDER]: 'aws',
[ATTR_FAAS_INVOKED_NAME]: functionName,
[ATTR_FAAS_INVOKED_PROVIDER]: 'aws',
};
if (request.region) {
spanAttributes[SEMATTRS_FAAS_INVOKED_REGION] = request.region;
spanAttributes[ATTR_FAAS_INVOKED_REGION] = request.region;

Check warning on line 52 in plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/lambda.ts

View check run for this annotation

Codecov / codecov/patch

plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/lambda.ts#L52 

Added line #L52 was not covered by tests
}
spanName = `${functionName} ${LambdaCommands.Invoke}`;
break;
Expand Down Expand Up @@ -85,7 +85,7 @@
switch (response.request.commandName) {
case LambdaCommands.Invoke:
{
span.setAttribute(SEMATTRS_FAAS_EXECUTION, response.requestId);
span.setAttribute(ATTR_FAAS_INVOCATION_ID, response.requestId);
trivikr marked this conversation as resolved.
Show resolved Hide resolved
}
break;
}
Expand Down
15 changes: 7 additions & 8 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/sns.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@
import { Span, Tracer, SpanKind, Attributes } from '@opentelemetry/api';
import {
MESSAGINGDESTINATIONKINDVALUES_TOPIC,
SEMATTRS_MESSAGING_DESTINATION,
SEMATTRS_MESSAGING_DESTINATION_KIND,
SEMATTRS_MESSAGING_SYSTEM,
} from '@opentelemetry/semantic-conventions';
import {
ATTR_MESSAGING_DESTINATION_NAME,
ATTR_MESSAGING_SYSTEM,
} from '@opentelemetry/semantic-conventions/incubating';
import {
NormalizedRequest,
NormalizedResponse,
Expand All @@ -36,7 +38,7 @@ export class SnsServiceExtension implements ServiceExtension {
let spanKind: SpanKind = SpanKind.CLIENT;
let spanName = `SNS ${request.commandName}`;
const spanAttributes: Attributes = {
[SEMATTRS_MESSAGING_SYSTEM]: 'aws.sns',
[ATTR_MESSAGING_SYSTEM]: 'aws.sns',
};

if (request.commandName === 'Publish') {
Expand All @@ -45,16 +47,13 @@ export class SnsServiceExtension implements ServiceExtension {
spanAttributes[SEMATTRS_MESSAGING_DESTINATION_KIND] =
MESSAGINGDESTINATIONKINDVALUES_TOPIC;
const { TopicArn, TargetArn, PhoneNumber } = request.commandInput;
spanAttributes[SEMATTRS_MESSAGING_DESTINATION] =
spanAttributes[ATTR_MESSAGING_DESTINATION_NAME] =
trivikr marked this conversation as resolved.
Show resolved Hide resolved
this.extractDestinationName(TopicArn, TargetArn, PhoneNumber);
// ToDO: Use SEMATTRS_MESSAGING_DESTINATION_NAME when implemented
spanAttributes['messaging.destination.name'] =
TopicArn || TargetArn || PhoneNumber || 'unknown';

spanName = `${
PhoneNumber
? 'phone_number'
: spanAttributes[SEMATTRS_MESSAGING_DESTINATION]
: spanAttributes[ATTR_MESSAGING_DESTINATION_NAME]
} send`;
}

Expand Down
Loading