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

Author: maryliag

detectors/node/opentelemetry-resource-detector-container/src/detectors/ContainerDetector.ts

@@ -35,7 +35,7 @@ export class ContainerDetector implements DetectorSync {
   readonly DEFAULT_CGROUP_V2_PATH = '/proc/self/mountinfo';
   readonly UTF8_UNICODE = 'utf8';
   readonly HOSTNAME = 'hostname';
-  readonly MARKING_PREFIX = 'containers';
+  readonly MARKING_PREFIX = ['containers', 'overlay-containers'];
   readonly CRIO = 'crio-';
   readonly CRI_CONTAINERD = 'cri-containerd-';
   readonly DOCKER = 'docker-';
@@ -105,7 +105,7 @@ export class ContainerDetector implements DetectorSync {
     const strArray = str?.split('/') ?? [];
     for (let i = 0; i < strArray.length - 1; i++) {
       if (
-        strArray[i] === this.MARKING_PREFIX &&
+        this.MARKING_PREFIX.includes(strArray[i]) &&
         strArray[i + 1]?.length === this.CONTAINER_ID_LENGTH
       ) {
         return strArray[i + 1];

detectors/node/opentelemetry-resource-detector-container/src/detectors/utils.ts

@@ -18,7 +18,7 @@ export const DEFAULT_CGROUP_V1_PATH = '/proc/self/cgroup';
 export const DEFAULT_CGROUP_V2_PATH = '/proc/self/mountinfo';
 export const UTF8_UNICODE = 'utf8';
 export const HOSTNAME = 'hostname';
-export const MARKING_PREFIX = 'containers';
+export const MARKING_PREFIX = ['containers', 'overlay-containers'];
 export const CRIO = 'crio-';
 export const CRI_CONTAINERD = 'cri-containerd-';
 export const DOCKER = 'docker-';

detectors/node/opentelemetry-resource-detector-container/test/ContainerDetector.test.ts

@@ -32,6 +32,8 @@ describe('ContainerDetector', () => {
   const correctCgroupV2Data = `containers/tmhdefghijklmnopqrstuvwxyzafgrefghiugkmnopqrstuvwxyzabcdefghijkl/hostname
     fhkjdshgfhsdfjhdsfkjhfkdshkjhfd/host
     sahfhfjkhjhfhjdhfjkdhfkjdhfjkhhdsjfhdfhjdhfkj/somethingelse`;
+  const correctCgroupV2PodmanData =
+    '4245 4237 0:94 /containers/overlay-containers/4e9dc37d00ebd2daea029d84bb37764ce12d746a6f3a33c5969cee15c4fc4418/userdata/hostname /etc/hostname rw - tmpfs tmpfs rw';
 
   const wrongCgroupV2Data =
     'bcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklm/wrongkeyword';
@@ -85,6 +87,22 @@ describe('ContainerDetector', () => {
       });
     });
 
+    it('should return a resource with container ID with a valid container ID present for v2 (Podman)', async () => {
+      readStub = sinon.stub(ContainerDetector, 'readFileAsync' as any);
+
+      readStub.onFirstCall().resolves('');
+      readStub.onSecondCall().resolves(correctCgroupV2PodmanData);
+
+      const resource = containerDetector.detect();
+      await resource.waitForAsyncAttributes?.();
+      sinon.assert.calledTwice(readStub);
+
+      assert.ok(resource);
+      assertContainerResource(resource, {
+        id: '4e9dc37d00ebd2daea029d84bb37764ce12d746a6f3a33c5969cee15c4fc4418',
+      });
+    });
+
     it('should return a empty resource with failed hostname check for v2', async () => {
       readStub = sinon.stub(ContainerDetector, 'readFileAsync' as any);
 

examples/mysql/README.md

@@ -1,6 +1,6 @@
 # Overview
 
-OpenTelemetry MySQL Instrumentation allows the user to automatically collect trace data and metrics and export them to the backend of choice (we can use Zipkin, Jaeger or Grafana for this example), to give observability to distributed systems.
+OpenTelemetry MySQL Instrumentation allows the user to automatically collect trace data and metrics and export them to the backend of choice (we can use Zipkin or Grafana for this example), to give observability to distributed systems.
 
 This is a modification of the HTTP example that executes multiple parallel requests that interact with a MySQL server backend using the `mysql` npm module. The example displays traces using multiple connection methods.
 
@@ -20,13 +20,11 @@ npm install
 ```
 
 Setup [Zipkin Tracing](https://zipkin.io/pages/quickstart.html)
-or
-Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one)
 
 In case you want to see also metrics:
 
 1. Go to `docker` folder
-2. Run `docker compose up`. This will set up Zipkin, Jaeger, otel collector, Prometheus and Grafana.
+2. Run `docker compose up`. This will set up Zipkin, otel collector, Prometheus and Grafana.
 3. To see your metrics, go to `http://localhost:3000/`.
 
 ## Run the Application
@@ -54,29 +52,6 @@ Go to Zipkin with your browser <http://localhost:9411/zipkin/traces/(your-trace-
 
 <p align="center"><img alt="Zipkin UI with trace" src="./images/zipkin-ui.png?raw=true"/></p>
 
-### Jaeger
-
-- Run the server
-
-   ```sh
-   # from this directory
-   npm run jaeger:server
-   ```
-
-- Run the client
-
-   ```sh
-   # from this directory
-   npm run jaeger:client
-   ```
-
-#### Jaeger UI
-
-The `jaeger:server` script should output the `traceid` in the terminal (e.g `traceid: 4815c3d576d930189725f1f1d1bdfcc6`).
-Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e.g <http://localhost:16686/trace/4815c3d576d930189725f1f1d1bdfcc6>)
-
-<p align="center"><img alt="Jaeger UI with trace" src="images/jaeger-ui.png?raw=true"/></p>
-
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

examples/mysql/docker/collector/otel-collector-config.yaml

@@ -9,18 +9,13 @@ exporters:
     const_labels:
       label1: value1
 
-  logging:
-    loglevel: debug
+  debug:
+    verbosity: detailed
 
   zipkin:
     endpoint: "http://zipkin-all-in-one:9411/api/v2/spans"
     format: proto
 
-  jaeger:
-    endpoint: jaeger-all-in-one:14250
-    tls:
-      insecure: true
-
 processors:
   batch:
 
@@ -37,8 +32,8 @@ service:
     traces:
       receivers: [otlp]
       processors: [batch]
-      exporters: [logging]
+      exporters: [debug]
     metrics:
       receivers: [otlp]
       processors: [batch]
-      exporters: [logging, prometheus]
+      exporters: [debug, prometheus]

examples/mysql/docker/docker-compose.yaml

@@ -1,9 +1,9 @@
-version: "2"
 services:
 
 # mysql
   mysql:
     image: mysql:5.7
+    platform: linux/amd64
     command: --init-file /etc/mysql/init.sql
     volumes:
         - ./mysql/init.sql:/etc/mysql/init.sql
@@ -12,15 +12,6 @@ services:
     ports:
       - "3306:3306"
 
-# Jaeger
-
-  jaeger-all-in-one:
-    image: jaegertracing/all-in-one:latest
-    ports:
-      - "16686:16686"
-      - "14268"
-      - "14250"
-
 # Zipkin
 
   zipkin-all-in-one:
@@ -31,7 +22,7 @@ services:
 # Collector
 
   otel-collector:
-    image: otel/opentelemetry-collector-contrib:0.61.0
+    image: otel/opentelemetry-collector-contrib:0.111.0
     command: ["--config=/etc/otel-collector-config.yaml", ""]
     volumes:
       - ./collector/otel-collector-config.yaml:/etc/otel-collector-config.yaml
@@ -43,7 +34,6 @@ services:
       - "4317:4317"   # OTLP gRPC receiver
       - "55679:55679" # zpages extension
     depends_on:
-      - jaeger-all-in-one
       - zipkin-all-in-one
 
 # Prometheus

examples/mysql/package.json

@@ -9,8 +9,6 @@
     "docker:stop": "docker stop example-mysql && docker rm example-mysql",
     "zipkin:server": "cross-env EXPORTER=zipkin ts-node src/server.ts",
     "zipkin:client": "cross-env EXPORTER=zipkin ts-node src/client.ts",
-    "jaeger:server": "cross-env EXPORTER=jaeger ts-node src/server.ts",
-    "jaeger:client": "cross-env EXPORTER=jaeger ts-node src/client.ts",
     "compile": "tsc -p ."
   },
   "repository": {
@@ -32,15 +30,15 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.0.0",
-    "@opentelemetry/exporter-jaeger": "^1.0.0",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.48.0",
     "@opentelemetry/exporter-zipkin": "^1.0.0",
     "@opentelemetry/instrumentation": "^0.48.0",
     "@opentelemetry/instrumentation-http": "^0.48.0",
     "@opentelemetry/instrumentation-mysql": "^0.31.0",
     "@opentelemetry/sdk-trace-base": "^1.0.0",
     "@opentelemetry/sdk-trace-node": "^1.0.0",
     "@opentelemetry/semantic-conventions": "^1.27.0",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.48.0",
+    "@types/node": "^18.18.14",
     "mysql": "^2.18.1"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/mysql#readme",

examples/mysql/src/server.ts

@@ -52,7 +52,6 @@ function handleRequest(request: any, response: any) {
   // display traceid in the terminal
   const traceId = currentSpan?.spanContext().traceId;
   console.log(`traceid: ${traceId}`);
-  console.log(`Jaeger URL: http://localhost:16686/trace/${traceId}`);
   console.log(`Zipkin URL: http://localhost:9411/zipkin/traces/${traceId}`);
   try {
     const body = [];

examples/mysql/src/tracer.ts

@@ -3,7 +3,6 @@
 import opentelemetry from '@opentelemetry/api';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
-import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
 import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';
 import { registerInstrumentations } from '@opentelemetry/instrumentation';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
@@ -38,8 +37,6 @@ export const setupTracing = (serviceName: string) => {
 
   if (EXPORTER.toLowerCase().startsWith('z')) {
     tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new ZipkinExporter()));
-  } else {
-    tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new JaegerExporter()));
   }
 
   // Initialize the OpenTelemetry APIs to use the NodeTracerProvider bindings

metapackages/auto-instrumentations-node/README.md

@@ -77,8 +77,8 @@ For example, to enable only the `env`, `host` detectors:
 export OTEL_NODE_RESOURCE_DETECTORS="env,host"
 ```
 
-By default, all [Supported Instrumentations](#supported-instrumentations) are enabled.
-You can use the environment variable `OTEL_NODE_ENABLED_INSTRUMENTATIONS` to enable only certain instrumentations,
+By default, all [Supported Instrumentations](#supported-instrumentations) are enabled, unless they are annotated with "default disabled".
+You can use the environment variable `OTEL_NODE_ENABLED_INSTRUMENTATIONS` to enable only certain instrumentations, including "default disabled" ones
 OR the environment variable `OTEL_NODE_DISABLED_INSTRUMENTATIONS` to disable only certain instrumentations,
 by providing a comma-separated list of the instrumentation package names without the `@opentelemetry/instrumentation-` prefix.
 
@@ -91,10 +91,10 @@ instrumentations:
 export OTEL_NODE_ENABLED_INSTRUMENTATIONS="http,nestjs-core"
 ```
 
-To disable only [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-fs):
+To disable only [@opentelemetry/instrumentation-net](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-net):
 
 ```shell
-export OTEL_NODE_DISABLED_INSTRUMENTATIONS="fs"
+export OTEL_NODE_DISABLED_INSTRUMENTATIONS="net"
 ```
 
 If both environment variables are set, `OTEL_NODE_ENABLED_INSTRUMENTATIONS` is applied first, and then `OTEL_NODE_DISABLED_INSTRUMENTATIONS` is applied to that list.
@@ -170,6 +170,7 @@ registerInstrumentations({
 - [@opentelemetry/instrumentation-dns](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns)
 - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express)
 - [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify)
+- [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-fs) (default disabled)
 - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool)
 - [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql)
 - [@opentelemetry/instrumentation-grpc](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-grpc)