chore(instrumentation-amqplib): update semconv usage to ATTR_ exports (#3066)

Author: trentm

packages/instrumentation-amqplib/README.md

@@ -89,7 +89,7 @@ By default, the tests that connect to RabbitMQ are skipped. To make sure these t
 
 ## Semantic Conventions
 
-This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+This package emits telemetry using Semantic Convention [version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
 
 Attributes collected:
 

packages/instrumentation-amqplib/package.json

@@ -52,8 +52,7 @@
   },
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
-    "@opentelemetry/instrumentation": "^0.205.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/instrumentation": "^0.205.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.3.0",

packages/instrumentation-amqplib/src/amqplib.ts

@@ -37,16 +37,16 @@ import {
   isWrapped,
   safeExecuteInTheMiddle,
 } from '@opentelemetry/instrumentation';
+import { ATTR_MESSAGING_OPERATION } from './semconv';
 import {
-  SEMATTRS_MESSAGING_DESTINATION,
-  SEMATTRS_MESSAGING_DESTINATION_KIND,
-  MESSAGINGDESTINATIONKINDVALUES_TOPIC,
-  SEMATTRS_MESSAGING_RABBITMQ_ROUTING_KEY,
-  SEMATTRS_MESSAGING_OPERATION,
-  MESSAGINGOPERATIONVALUES_PROCESS,
-  SEMATTRS_MESSAGING_MESSAGE_ID,
-  SEMATTRS_MESSAGING_CONVERSATION_ID,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_MESSAGING_DESTINATION,
+  ATTR_MESSAGING_DESTINATION_KIND,
+  ATTR_MESSAGING_RABBITMQ_ROUTING_KEY,
+  MESSAGING_DESTINATION_KIND_VALUE_TOPIC,
+  MESSAGING_OPERATION_VALUE_PROCESS,
+  OLD_ATTR_MESSAGING_MESSAGE_ID,
+  ATTR_MESSAGING_CONVERSATION_ID,
+} from '../src/semconv-obsolete';
 import type {
   Connection,
   ConsumeMessage,
@@ -432,14 +432,13 @@ export class AmqplibInstrumentation extends InstrumentationBase<AmqplibInstrumen
             kind: SpanKind.CONSUMER,
             attributes: {
               ...channel?.connection?.[CONNECTION_ATTRIBUTES],
-              [SEMATTRS_MESSAGING_DESTINATION]: exchange,
-              [SEMATTRS_MESSAGING_DESTINATION_KIND]:
-                MESSAGINGDESTINATIONKINDVALUES_TOPIC,
-              [SEMATTRS_MESSAGING_RABBITMQ_ROUTING_KEY]: msg.fields?.routingKey,
-              [SEMATTRS_MESSAGING_OPERATION]: MESSAGINGOPERATIONVALUES_PROCESS,
-              [SEMATTRS_MESSAGING_MESSAGE_ID]: msg?.properties.messageId,
-              [SEMATTRS_MESSAGING_CONVERSATION_ID]:
-                msg?.properties.correlationId,
+              [ATTR_MESSAGING_DESTINATION]: exchange,
+              [ATTR_MESSAGING_DESTINATION_KIND]:
+                MESSAGING_DESTINATION_KIND_VALUE_TOPIC,
+              [ATTR_MESSAGING_RABBITMQ_ROUTING_KEY]: msg.fields?.routingKey,
+              [ATTR_MESSAGING_OPERATION]: MESSAGING_OPERATION_VALUE_PROCESS,
+              [OLD_ATTR_MESSAGING_MESSAGE_ID]: msg?.properties.messageId,
+              [ATTR_MESSAGING_CONVERSATION_ID]: msg?.properties.correlationId,
             },
             links,
           },
@@ -655,12 +654,13 @@ export class AmqplibInstrumentation extends InstrumentationBase<AmqplibInstrumen
       kind: SpanKind.PRODUCER,
       attributes: {
         ...channel.connection[CONNECTION_ATTRIBUTES],
-        [SEMATTRS_MESSAGING_DESTINATION]: exchange,
-        [SEMATTRS_MESSAGING_DESTINATION_KIND]:
-          MESSAGINGDESTINATIONKINDVALUES_TOPIC,
-        [SEMATTRS_MESSAGING_RABBITMQ_ROUTING_KEY]: routingKey,
-        [SEMATTRS_MESSAGING_MESSAGE_ID]: options?.messageId,
-        [SEMATTRS_MESSAGING_CONVERSATION_ID]: options?.correlationId,
+        [ATTR_MESSAGING_DESTINATION]: exchange,
+        [ATTR_MESSAGING_DESTINATION_KIND]:
+          MESSAGING_DESTINATION_KIND_VALUE_TOPIC,
+
+        [ATTR_MESSAGING_RABBITMQ_ROUTING_KEY]: routingKey,
+        [OLD_ATTR_MESSAGING_MESSAGE_ID]: options?.messageId,
+        [ATTR_MESSAGING_CONVERSATION_ID]: options?.correlationId,
       },
     });
     const modifiedOptions = options ?? {};

packages/instrumentation-amqplib/src/semconv-obsolete.ts

@@ -0,0 +1,100 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * This file contains constants for values that where replaced/removed from
+ * Semantic Conventions long enough ago that they do not have `ATTR_*`
+ * constants in the `@opentelemetry/semantic-conventions` package. Eventually
+ * it is expected that this instrumention will be updated to emit telemetry
+ * using modern Semantic Conventions, dropping the need for the constants in
+ * this file.
+ */
+
+/**
+ * The message destination name. This might be equal to the span name but is required nevertheless.
+ *
+ * @deprecated Use ATTR_MESSAGING_DESTINATION_NAME in [incubating entry-point]({@link https://github.com/open-telemetry/opentelemetry-js/blob/main/semantic-conventions/README.md#unstable-semconv}).
+ */
+export const ATTR_MESSAGING_DESTINATION = 'messaging.destination' as const;
+
+/**
+ * The kind of message destination.
+ *
+ * @deprecated Removed in semconv v1.20.0.
+ */
+export const ATTR_MESSAGING_DESTINATION_KIND =
+  'messaging.destination_kind' as const;
+
+/**
+ * RabbitMQ message routing key.
+ *
+ * @deprecated Use ATTR_MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY in [incubating entry-point]({@link https://github.com/open-telemetry/opentelemetry-js/blob/main/semantic-conventions/README.md#unstable-semconv}).
+ */
+export const ATTR_MESSAGING_RABBITMQ_ROUTING_KEY =
+  'messaging.rabbitmq.routing_key' as const;
+
+/**
+ * A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above. If the operation is "send", this attribute MUST NOT be set, since the operation can be inferred from the span kind in that case.
+ *
+ * @deprecated Use MESSAGING_OPERATION_TYPE_VALUE_PROCESS in [incubating entry-point]({@link https://github.com/open-telemetry/opentelemetry-js/blob/main/semantic-conventions/README.md#unstable-semconv}).
+ */
+export const MESSAGING_OPERATION_VALUE_PROCESS = 'process' as const;
+
+/**
+ * The name of the transport protocol.
+ *
+ * @deprecated Use ATTR_NETWORK_PROTOCOL_NAME.
+ */
+export const ATTR_MESSAGING_PROTOCOL = 'messaging.protocol' as const;
+
+/**
+ * The version of the transport protocol.
+ *
+ * @deprecated Use ATTR_NETWORK_PROTOCOL_VERSION.
+ */
+export const ATTR_MESSAGING_PROTOCOL_VERSION =
+  'messaging.protocol_version' as const;
+
+/**
+ * Connection string.
+ *
+ * @deprecated Removed in semconv v1.17.0.
+ */
+export const ATTR_MESSAGING_URL = 'messaging.url' as const;
+
+/**
+ * The kind of message destination.
+ *
+ * @deprecated Removed in semconv v1.20.0.
+ */
+export const MESSAGING_DESTINATION_KIND_VALUE_TOPIC = 'topic' as const;
+
+/**
+ * A value used by the messaging system as an identifier for the message, represented as a string.
+ *
+ * @deprecated Use ATTR_MESSAGING_MESSAGE_ID in [incubating entry-point]({@link https://github.com/open-telemetry/opentelemetry-js/blob/main/semantic-conventions/README.md#unstable-semconv}).
+ *
+ * Note: changing to `ATTR_MESSAGING_MESSAGE_ID` means a change in value from `messaging.message_id` to `messaging.message.id`.
+ */
+export const OLD_ATTR_MESSAGING_MESSAGE_ID = 'messaging.message_id' as const;
+
+/**
+ * The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
+ *
+ * @deprecated Use ATTR_MESSAGING_MESSAGE_CONVERSATION_ID in [incubating entry-point]({@link https://github.com/open-telemetry/opentelemetry-js/blob/main/semantic-conventions/README.md#unstable-semconv}).
+ */
+export const ATTR_MESSAGING_CONVERSATION_ID =
+  'messaging.conversation_id' as const;

packages/instrumentation-amqplib/src/semconv.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * This file contains a copy of unstable semantic convention definitions
+ * used by this package.
+ * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv
+ */
+
+/**
+ * Deprecated, use `messaging.operation.type` instead.
+ *
+ * @example publish
+ * @example create
+ * @example process
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `messaging.operation.type`.
+ */
+export const ATTR_MESSAGING_OPERATION = 'messaging.operation' as const;
+
+/**
+ * The messaging system as identified by the client instrumentation.
+ *
+ * @note The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_MESSAGING_SYSTEM = 'messaging.system' as const;
+
+/**
+ * Deprecated, use `server.address` on client spans and `client.address` on server spans.
+ *
+ * @example example.com
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `server.address` on client spans and `client.address` on server spans.
+ */
+export const ATTR_NET_PEER_NAME = 'net.peer.name' as const;
+
+/**
+ * Deprecated, use `server.port` on client spans and `client.port` on server spans.
+ *
+ * @example 8080
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ *
+ * @deprecated Replaced by `server.port` on client spans and `client.port` on server spans.
+ */
+export const ATTR_NET_PEER_PORT = 'net.peer.port' as const;

packages/instrumentation-amqplib/src/utils.ts

@@ -23,13 +23,15 @@ import {
   AttributeValue,
 } from '@opentelemetry/api';
 import {
-  SEMATTRS_MESSAGING_PROTOCOL,
-  SEMATTRS_MESSAGING_PROTOCOL_VERSION,
-  SEMATTRS_MESSAGING_SYSTEM,
-  SEMATTRS_MESSAGING_URL,
-  SEMATTRS_NET_PEER_NAME,
-  SEMATTRS_NET_PEER_PORT,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_MESSAGING_SYSTEM,
+  ATTR_NET_PEER_NAME,
+  ATTR_NET_PEER_PORT,
+} from './semconv';
+import {
+  ATTR_MESSAGING_PROTOCOL,
+  ATTR_MESSAGING_PROTOCOL_VERSION,
+  ATTR_MESSAGING_URL,
+} from '../src/semconv-obsolete';
 import type * as amqp from 'amqplib';
 
 export const MESSAGE_STORED_SPAN: unique symbol = Symbol(
@@ -128,7 +130,7 @@ export const getConnectionAttributesFromServer = (
   const product = conn.serverProperties.product?.toLowerCase?.();
   if (product) {
     return {
-      [SEMATTRS_MESSAGING_SYSTEM]: product,
+      [ATTR_MESSAGING_SYSTEM]: product,
     };
   } else {
     return {};
@@ -139,7 +141,7 @@ export const getConnectionAttributesFromUrl = (
   url: string | amqp.Options.Connect
 ): Attributes => {
   const attributes: Attributes = {
-    [SEMATTRS_MESSAGING_PROTOCOL_VERSION]: '0.9.1', // this is the only protocol supported by the instrumented library
+    [ATTR_MESSAGING_PROTOCOL_VERSION]: '0.9.1', // this is the only protocol supported by the instrumented library
   };
 
   url = url || 'amqp://localhost';
@@ -150,7 +152,7 @@ export const getConnectionAttributesFromUrl = (
     Object.assign(attributes, {
       ...extractConnectionAttributeOrLog(
         url,
-        SEMATTRS_MESSAGING_PROTOCOL,
+        ATTR_MESSAGING_PROTOCOL,
         protocol,
         'protocol'
       ),
@@ -160,32 +162,27 @@ export const getConnectionAttributesFromUrl = (
     Object.assign(attributes, {
       ...extractConnectionAttributeOrLog(
         url,
-        SEMATTRS_NET_PEER_NAME,
+        ATTR_NET_PEER_NAME,
         hostname,
         'hostname'
       ),
     });
 
     const port = getPort(connectOptions.port, protocol);
     Object.assign(attributes, {
-      ...extractConnectionAttributeOrLog(
-        url,
-        SEMATTRS_NET_PEER_PORT,
-        port,
-        'port'
-      ),
+      ...extractConnectionAttributeOrLog(url, ATTR_NET_PEER_PORT, port, 'port'),
     });
   } else {
     const censoredUrl = censorPassword(url);
-    attributes[SEMATTRS_MESSAGING_URL] = censoredUrl;
+    attributes[ATTR_MESSAGING_URL] = censoredUrl;
     try {
       const urlParts = new URL(censoredUrl);
 
       const protocol = getProtocol(urlParts.protocol);
       Object.assign(attributes, {
         ...extractConnectionAttributeOrLog(
           censoredUrl,
-          SEMATTRS_MESSAGING_PROTOCOL,
+          ATTR_MESSAGING_PROTOCOL,
           protocol,
           'protocol'
         ),
@@ -195,7 +192,7 @@ export const getConnectionAttributesFromUrl = (
       Object.assign(attributes, {
         ...extractConnectionAttributeOrLog(
           censoredUrl,
-          SEMATTRS_NET_PEER_NAME,
+          ATTR_NET_PEER_NAME,
           hostname,
           'hostname'
         ),
@@ -208,7 +205,7 @@ export const getConnectionAttributesFromUrl = (
       Object.assign(attributes, {
         ...extractConnectionAttributeOrLog(
           censoredUrl,
-          SEMATTRS_NET_PEER_PORT,
+          ATTR_NET_PEER_PORT,
           port,
           'port'
         ),