Merge branch 'main' of github.com:open-telemetry/opentelemetry-js-contrib

Author: sudarshan12s

.github/component_owners.yml

@@ -87,6 +87,7 @@ components:
   plugins/node/opentelemetry-instrumentation-express:
     - JamieDanielson
     - pkanal
+    - raphael-theriault-swi
   plugins/node/opentelemetry-instrumentation-fastify: []
     # Unmaintained
   plugins/node/opentelemetry-instrumentation-generic-pool: []
@@ -104,12 +105,12 @@ components:
     # Unmaintained
   plugins/node/opentelemetry-instrumentation-memcached: []
     # Unmaintained
-  plugins/node/opentelemetry-instrumentation-mongodb: []
-    # Unmaintained
+  plugins/node/opentelemetry-instrumentation-mongodb:
+    - onurtemizkan
   plugins/node/opentelemetry-instrumentation-mysql: []
     # Unmaintained
-  plugins/node/opentelemetry-instrumentation-mysql2: []
-    # Unmaintained
+  plugins/node/opentelemetry-instrumentation-mysql2:
+    - raphael-theriault-swi
   plugins/node/opentelemetry-instrumentation-nestjs-core: []
     # Unmaintained
   plugins/node/opentelemetry-instrumentation-net:

.github/workflows/unit-test.yml

@@ -44,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       memcached:
-        image: memcached:1.6.34-alpine
+        image: memcached:1.6.36-alpine
         ports:
         - 11211:11211
       mongo:

CONTRIBUTING.md

@@ -238,7 +238,7 @@ features for unmaintained components. At least one sponsor is needed to lift the
 adding the requested feature. Sponsors are expected to provide reviews for that feature and be responsive on the issue.
 
 Components marked as unmaintained still receive semantic conventions updates and bugfixes where possible.
-[@open-telemetry/javascript-triagers](https://github.com/orgs/open-telemetry/teams/javascript-triagers) may add the
+[@open-telemetry/javascript-contrib-triagers](https://github.com/orgs/open-telemetry/teams/javascript-contrib-triagers) may add the
 `type:semconv-update` or `bug` label to mark them as exempt from being auto-closed within two weeks.
 
 A component which is unmaintained may be deprecated if there is a problem that is not fixed in a timely manner.

detectors/node/opentelemetry-resource-detector-aws/package.json

@@ -44,7 +44,7 @@
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/contrib-test-utils": "^0.45.0",
     "@opentelemetry/instrumentation-fs": "^0.19.0",
-    "@opentelemetry/instrumentation-http": "^0.57.0",
+    "@opentelemetry/instrumentation-http": "^0.57.1",
     "@types/mocha": "8.2.3",
     "@types/node": "18.18.14",
     "@types/sinon": "10.0.20",

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetector.ts

@@ -15,7 +15,6 @@
  */
 
 import { Detector, IResource } from '@opentelemetry/resources';
-
 import { awsEcsDetectorSync } from './AwsEcsDetectorSync';
 
 /**

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts

@@ -23,33 +23,31 @@ import {
   ResourceAttributes,
 } from '@opentelemetry/resources';
 import {
-  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_CONTAINER_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_GROUP_NAMES,
   ATTR_AWS_LOG_STREAM_ARNS,
+  ATTR_AWS_LOG_STREAM_NAMES,
+  ATTR_CLOUD_ACCOUNT_ID,
+  ATTR_CLOUD_AVAILABILITY_ZONE,
+  ATTR_CLOUD_PLATFORM,
+  ATTR_CLOUD_PROVIDER,
+  ATTR_CLOUD_REGION,
+  ATTR_CLOUD_RESOURCE_ID,
+  ATTR_CONTAINER_ID,
+  ATTR_CONTAINER_NAME,
   CLOUD_PROVIDER_VALUE_AWS,
   CLOUD_PLATFORM_VALUE_AWS_ECS,
 } from '../semconv';
-// Patch until the OpenTelemetry SDK is updated to ship this attribute
-import { SemanticResourceAttributes as AdditionalSemanticResourceAttributes } from './SemanticResourceAttributes';
 import * as http from 'http';
 import * as util from 'util';
 import * as fs from 'fs';
 import * as os from 'os';
-import { getEnv } from '@opentelemetry/core';
 
 const HTTP_TIMEOUT_IN_MS = 1000;
 
@@ -78,8 +76,10 @@ export class AwsEcsDetectorSync implements DetectorSync {
   }
 
   private async _getAttributes(): Promise<ResourceAttributes> {
-    const env = getEnv();
-    if (!env.ECS_CONTAINER_METADATA_URI_V4 && !env.ECS_CONTAINER_METADATA_URI) {
+    if (
+      !process.env.ECS_CONTAINER_METADATA_URI_V4 &&
+      !process.env.ECS_CONTAINER_METADATA_URI
+    ) {
       diag.debug('AwsEcsDetector failed: Process is not on ECS');
       return {};
     }
@@ -90,7 +90,7 @@ export class AwsEcsDetectorSync implements DetectorSync {
         [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_ECS,
       }).merge(await AwsEcsDetectorSync._getContainerIdAndHostnameResource());
 
-      const metadataUrl = getEnv().ECS_CONTAINER_METADATA_URI_V4;
+      const metadataUrl = process.env.ECS_CONTAINER_METADATA_URI_V4;
       if (metadataUrl) {
         const [containerMetadata, taskMetadata] = await Promise.all([
           AwsEcsDetectorSync._getUrlAsJson(metadataUrl),
@@ -185,7 +185,7 @@ export class AwsEcsDetectorSync implements DetectorSync {
 
       [ATTR_CLOUD_ACCOUNT_ID]: accountId,
       [ATTR_CLOUD_REGION]: region,
-      [AdditionalSemanticResourceAttributes.CLOUD_RESOURCE_ID]: containerArn,
+      [ATTR_CLOUD_RESOURCE_ID]: containerArn,
     };
 
     // The availability zone is not available in all Fargate runtimes

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsLambdaDetectorSync.ts

@@ -22,11 +22,14 @@ import {
   ResourceDetectionConfig,
 } from '@opentelemetry/resources';
 import {
-  ATTR_CLOUD_PROVIDER,
+  ATTR_AWS_LOG_GROUP_NAMES,
   ATTR_CLOUD_PLATFORM,
+  ATTR_CLOUD_PROVIDER,
   ATTR_CLOUD_REGION,
-  ATTR_FAAS_VERSION,
+  ATTR_FAAS_INSTANCE,
   ATTR_FAAS_NAME,
+  ATTR_FAAS_MAX_MEMORY,
+  ATTR_FAAS_VERSION,
   CLOUD_PROVIDER_VALUE_AWS,
   CLOUD_PLATFORM_VALUE_AWS_LAMBDA,
 } from '../semconv';
@@ -38,27 +41,37 @@ import {
  */
 export class AwsLambdaDetectorSync implements DetectorSync {
   detect(_config?: ResourceDetectionConfig): IResource {
-    const functionName = process.env.AWS_LAMBDA_FUNCTION_NAME;
-    if (!functionName) {
+    // Check if running inside AWS Lambda environment
+    const executionEnv = process.env.AWS_EXECUTION_ENV;
+    if (!executionEnv?.startsWith('AWS_Lambda_')) {
       return Resource.empty();
     }
 
-    const functionVersion = process.env.AWS_LAMBDA_FUNCTION_VERSION;
+    // These environment variables are guaranteed to be present in Lambda environment
+    // https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
     const region = process.env.AWS_REGION;
+    const functionName = process.env.AWS_LAMBDA_FUNCTION_NAME;
+    const functionVersion = process.env.AWS_LAMBDA_FUNCTION_VERSION;
+    const memorySize = process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE;
+
+    // These environment variables are not available in Lambda SnapStart functions
+    const logGroupName = process.env.AWS_LAMBDA_LOG_GROUP_NAME;
+    const logStreamName = process.env.AWS_LAMBDA_LOG_STREAM_NAME;
 
     const attributes: ResourceAttributes = {
-      [ATTR_CLOUD_PROVIDER]: String(CLOUD_PROVIDER_VALUE_AWS),
-      [ATTR_CLOUD_PLATFORM]: String(CLOUD_PLATFORM_VALUE_AWS_LAMBDA),
+      [ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
+      [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_LAMBDA,
+      [ATTR_CLOUD_REGION]: region,
+      [ATTR_FAAS_NAME]: functionName,
+      [ATTR_FAAS_VERSION]: functionVersion,
+      [ATTR_FAAS_MAX_MEMORY]: parseInt(memorySize!) * 1024 * 1024,
     };
-    if (region) {
-      attributes[ATTR_CLOUD_REGION] = region;
-    }
 
-    if (functionName) {
-      attributes[ATTR_FAAS_NAME] = functionName;
+    if (logGroupName) {
+      attributes[ATTR_AWS_LOG_GROUP_NAMES] = [logGroupName];
     }
-    if (functionVersion) {
-      attributes[ATTR_FAAS_VERSION] = functionVersion;
+    if (logStreamName) {
+      attributes[ATTR_FAAS_INSTANCE] = logStreamName;
     }
 
     return new Resource(attributes);

detectors/node/opentelemetry-resource-detector-aws/src/detectors/SemanticResourceAttributes.ts

@@ -165,6 +165,35 @@ export const ATTR_CLOUD_PROVIDER = 'cloud.provider';
  */
 export const ATTR_CLOUD_REGION = 'cloud.region';
 
+/**
+ * Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP)
+ *
+ * @example arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function
+ * @example //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID
+ * @example /subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>
+ *
+ * @note On some cloud providers, it may not be possible to determine the full ID at startup,
+ * so it may be necessary to set `cloud.resource_id` as a span attribute instead.
+ *
+ * The exact value to use for `cloud.resource_id` depends on the cloud provider.
+ * The following well-known definitions **MUST** be used if you set this attribute and they apply:
+ *
+ *   - **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
+ *     Take care not to use the "invoked ARN" directly but replace any
+ *     [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
+ *     with the resolved function version, as the same runtime instance may be invocable with
+ *     multiple different aliases.
+ *   - **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
+ *   - **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
+ *     *not* the function app, having the form
+ *     `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
+ *     This means that a span attribute **MUST** be used, as an Azure function app can host multiple functions that would usually share
+ *     a TracerProvider.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_RESOURCE_ID = 'cloud.resource_id';
+
 /**
  * Container ID. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/containers/run/#container-identification). The UUID might be abbreviated.
  *
@@ -210,6 +239,28 @@ export const ATTR_CONTAINER_NAME = 'container.name';
  */
 export const ATTR_FAAS_NAME = 'faas.name';
 
+/**
+ * The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.
+ *
+ * @example 2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de
+ *
+ * @note * **AWS Lambda:** Use the (full) log stream name.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_FAAS_INSTANCE = 'faas.instance';
+
+/**
+ * The amount of memory available to the serverless function converted to Bytes.
+ *
+ * @example 134217728
+ *
+ * @note It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` provides this information (which must be multiplied by 1,048,576).
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_FAAS_MAX_MEMORY = 'faas.max_memory';
+
 /**
  * The immutable version of the function being executed.
  *