update pg to stable semantic conventions

Author: maryliag

package-lock.json

@@ -71,7 +71,7 @@
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
     "@opentelemetry/instrumentation": "^0.202.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0",
+    "@opentelemetry/semantic-conventions": "^1.34.0",
     "@opentelemetry/sql-common": "^0.41.0",
     "@types/pg": "8.15.1",
     "@types/pg-pool": "2.0.6"

plugins/node/opentelemetry-instrumentation-pg/package.json

@@ -19,6 +19,8 @@ import {
   InstrumentationNodeModuleDefinition,
   safeExecuteInTheMiddle,
   InstrumentationNodeModuleFile,
+  SemconvStability,
+  semconvStabilityFromStr,
 } from '@opentelemetry/instrumentation';
 import {
   context,
@@ -59,6 +61,7 @@ import {
   ATTR_ERROR_TYPE,
   ATTR_SERVER_PORT,
   ATTR_SERVER_ADDRESS,
+  ATTR_DB_SYSTEM_NAME,
 } from '@opentelemetry/semantic-conventions';
 import {
   METRIC_DB_CLIENT_CONNECTION_COUNT,
@@ -88,9 +91,14 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
     idle: 0,
     pending: 0,
   };
+  private _semconvStability: SemconvStability = SemconvStability.OLD;
 
   constructor(config: PgInstrumentationConfig = {}) {
     super(PACKAGE_NAME, PACKAGE_VERSION, config);
+    this._semconvStability = semconvStabilityFromStr(
+      'databases',
+      process.env.OTEL_SEMCONV_STABILITY_OPT_IN
+    );
   }
 
   override _updateMetricInstruments() {
@@ -247,7 +255,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
 
         const span = plugin.tracer.startSpan(SpanNames.CONNECT, {
           kind: SpanKind.CLIENT,
-          attributes: utils.getSemanticAttributesFromConnection(this),
+          attributes: utils.getSemanticAttributesFromConnection(this, plugin._semconvStability),
         });
 
         if (callback) {
@@ -272,14 +280,19 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
 
   private recordOperationDuration(attributes: Attributes, startTime: HrTime) {
     const metricsAttributes: Attributes = {};
-    const keysToCopy = [
-      SEMATTRS_DB_SYSTEM,
+    let keysToCopy = [
       ATTR_DB_NAMESPACE,
       ATTR_ERROR_TYPE,
       ATTR_SERVER_PORT,
       ATTR_SERVER_ADDRESS,
       ATTR_DB_OPERATION_NAME,
     ];
+    if (this._semconvStability & SemconvStability.OLD) {
+      keysToCopy.push(SEMATTRS_DB_SYSTEM);
+    }
+    if (this._semconvStability & SemconvStability.STABLE) {
+      keysToCopy.push(ATTR_DB_SYSTEM_NAME);
+    }
 
     keysToCopy.forEach(key => {
       if (key in attributes) {
@@ -348,6 +361,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
           this,
           plugin.tracer,
           instrumentationConfig,
+          plugin._semconvStability,
           queryConfig
         );
 
@@ -548,7 +562,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
         // setup span
         const span = plugin.tracer.startSpan(SpanNames.POOL_CONNECT, {
           kind: SpanKind.CLIENT,
-          attributes: utils.getSemanticAttributesFromPool(this.options),
+          attributes: utils.getSemanticAttributesFromPool(this.options, plugin._semconvStability),
         });
 
         plugin._setPoolConnectEventListeners(this);

plugins/node/opentelemetry-instrumentation-pg/src/instrumentation.ts

@@ -32,6 +32,7 @@ export type PostgresCallback = (err: Error, res: object) => unknown;
 export interface PgParsedConnectionParams {
   database?: string;
   host?: string;
+  namespace?: string;
   port?: number;
   user?: string;
 }
@@ -47,17 +48,18 @@ export type PgPoolCallback = (
 ) => void;
 
 export interface PgPoolOptionsParams {
+  allowExitOnIdle: boolean;
+  connectionString?: string; // connection string if provided directly
   database: string;
   host: string;
-  port: number;
-  user: string;
   idleTimeoutMillis: number; // the minimum amount of time that an object may sit idle in the pool before it is eligible for eviction due to idle time
-  maxClient: number; // maximum size of the pool
-  connectionString?: string; // connection string if provided directly
   max: number;
-  maxUses: number;
-  allowExitOnIdle: boolean;
+  maxClient: number; // maximum size of the pool
   maxLifetimeSeconds: number;
+  maxUses: number;
+  namespace: string;
+  port: number;
+  user: string;
 }
 
 export const EVENT_LISTENERS_SET = Symbol(

plugins/node/opentelemetry-instrumentation-pg/src/internal-types.ts

@@ -28,6 +28,8 @@ import {
 import { AttributeNames } from './enums/AttributeNames';
 import {
   ATTR_ERROR_TYPE,
+  ATTR_DB_SYSTEM_NAME,
+  ATTR_DB_NAMESPACE,
   SEMATTRS_DB_SYSTEM,
   SEMATTRS_DB_NAME,
   SEMATTRS_DB_CONNECTION_STRING,
@@ -36,6 +38,9 @@ import {
   SEMATTRS_DB_USER,
   SEMATTRS_DB_STATEMENT,
   DBSYSTEMVALUES_POSTGRESQL,
+  ATTR_NETWORK_PEER_ADDRESS,
+  ATTR_NETWORK_PEER_PORT,
+  ATTR_DB_QUERY_TEXT,
 } from '@opentelemetry/semantic-conventions';
 import {
   ATTR_DB_CLIENT_CONNECTION_POOL_NAME,
@@ -53,7 +58,7 @@ import {
 } from './internal-types';
 import { PgInstrumentationConfig } from './types';
 import type * as pgTypes from 'pg';
-import { safeExecuteInTheMiddle } from '@opentelemetry/instrumentation';
+import { safeExecuteInTheMiddle, SemconvStability, semconvStabilityFromStr } from '@opentelemetry/instrumentation';
 import { SpanNames } from './enums/SpanNames';
 
 /**
@@ -146,19 +151,39 @@ function getPort(port: number | undefined): number | undefined {
 }
 
 export function getSemanticAttributesFromConnection(
-  params: PgParsedConnectionParams
+  params: PgParsedConnectionParams,
+  semconvStability: SemconvStability,
 ) {
-  return {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_POSTGRESQL,
-    [SEMATTRS_DB_NAME]: params.database, // required
-    [SEMATTRS_DB_CONNECTION_STRING]: getConnectionString(params), // required
-    [SEMATTRS_NET_PEER_NAME]: params.host, // required
-    [SEMATTRS_NET_PEER_PORT]: getPort(params.port),
-    [SEMATTRS_DB_USER]: params.user,
-  };
+  let attributes: Attributes = {};
+
+  if (semconvStability & SemconvStability.OLD) {
+    attributes = {
+      ...attributes,
+      [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_POSTGRESQL,
+      [SEMATTRS_DB_NAME]: params.database,
+      [SEMATTRS_DB_CONNECTION_STRING]: getConnectionString(params),
+      [SEMATTRS_DB_USER]: params.user,
+      [SEMATTRS_NET_PEER_NAME]: params.host, // required
+      [SEMATTRS_NET_PEER_PORT]: getPort(params.port),
+    }
+  }
+  if (semconvStability & SemconvStability.STABLE) {
+    attributes = {
+      ...attributes,
+      [ATTR_DB_SYSTEM_NAME]: DBSYSTEMVALUES_POSTGRESQL,
+      [ATTR_DB_NAMESPACE]: params.namespace,
+      [ATTR_NETWORK_PEER_ADDRESS]: params.host,
+      [ATTR_NETWORK_PEER_PORT]: getPort(params.port),
+    }
+  }
+
+  return attributes;
 }
 
-export function getSemanticAttributesFromPool(params: PgPoolOptionsParams) {
+export function getSemanticAttributesFromPool(
+  params: PgPoolOptionsParams,
+  semconvStability: SemconvStability,
+) {
   let url: URL | undefined;
   try {
     url = params.connectionString
@@ -167,17 +192,33 @@ export function getSemanticAttributesFromPool(params: PgPoolOptionsParams) {
   } catch (e) {
     url = undefined;
   }
-
-  return {
-    [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_POSTGRESQL,
-    [SEMATTRS_DB_NAME]: url?.pathname.slice(1) ?? params.database, // required
-    [SEMATTRS_DB_CONNECTION_STRING]: getConnectionString(params), // required
-    [SEMATTRS_NET_PEER_NAME]: url?.hostname ?? params.host, // required
-    [SEMATTRS_NET_PEER_PORT]: Number(url?.port) || getPort(params.port),
-    [SEMATTRS_DB_USER]: url?.username ?? params.user,
+  let attributes: Attributes = {
     [AttributeNames.IDLE_TIMEOUT_MILLIS]: params.idleTimeoutMillis,
     [AttributeNames.MAX_CLIENT]: params.maxClient,
   };
+
+  if (semconvStability & SemconvStability.OLD) {
+    attributes = {
+      ...attributes,
+      [SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_POSTGRESQL,
+      [SEMATTRS_DB_NAME]: url?.pathname.slice(1) ?? params.database,
+      [SEMATTRS_DB_CONNECTION_STRING]: getConnectionString(params),
+      [SEMATTRS_NET_PEER_NAME]: url?.hostname ?? params.host,
+      [SEMATTRS_NET_PEER_PORT]: Number(url?.port) || getPort(params.port),
+      [SEMATTRS_DB_USER]: url?.username ?? params.user,
+    }
+  }
+  if (semconvStability & SemconvStability.STABLE) {
+    attributes = {
+      ...attributes,
+      [ATTR_DB_SYSTEM_NAME]: DBSYSTEMVALUES_POSTGRESQL,
+      [ATTR_DB_NAMESPACE]: params.namespace,
+      [ATTR_NETWORK_PEER_ADDRESS]: url?.hostname ?? params.host,
+      [ATTR_NETWORK_PEER_PORT]: Number(url?.port) || getPort(params.port),
+    }
+  }
+
+  return attributes;
 }
 
 export function shouldSkipInstrumentation(
@@ -195,6 +236,7 @@ export function handleConfigQuery(
   this: PgClientExtended,
   tracer: Tracer,
   instrumentationConfig: PgInstrumentationConfig,
+  semconvStability: SemconvStability,
   queryConfig?: { text: string; values?: unknown; name?: unknown }
 ) {
   // Create child span.
@@ -204,7 +246,7 @@ export function handleConfigQuery(
   const spanName = getQuerySpanName(dbName, queryConfig);
   const span = tracer.startSpan(spanName, {
     kind: SpanKind.CLIENT,
-    attributes: getSemanticAttributesFromConnection(connectionParameters),
+    attributes: getSemanticAttributesFromConnection(connectionParameters, semconvStability),
   });
 
   if (!queryConfig) {
@@ -213,7 +255,12 @@ export function handleConfigQuery(
 
   // Set attributes
   if (queryConfig.text) {
-    span.setAttribute(SEMATTRS_DB_STATEMENT, queryConfig.text);
+    if (semconvStability & SemconvStability.OLD) {
+      span.setAttribute(SEMATTRS_DB_STATEMENT, queryConfig.text);
+    }
+    if (semconvStability & SemconvStability.STABLE) {
+      span.setAttribute(ATTR_DB_QUERY_TEXT, queryConfig.text);
+    }
   }
 
   if (