Merge branch 'main' into bedrock-invoke-model-stream

Author: yuliia-fryshko

.github/workflows/test-all-versions.yml

@@ -163,8 +163,6 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - name: Set MySQL variables
-        run: mysql --user=root --password=${MYSQL_ROOT_PASSWORD} --host=${MYSQL_HOST} --port=${MYSQL_PORT} -e "SET GLOBAL log_output='TABLE'; SET GLOBAL general_log = 1;" mysql
       - name: Install
         run: npm ci
       - name: Download Build Artifacts

.github/workflows/unit-test.yml

@@ -176,8 +176,6 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - name: Set MySQL variables
-        run: mysql --user=root --password=${MYSQL_ROOT_PASSWORD} --host=${MYSQL_HOST} --port=${MYSQL_PORT} -e "SET GLOBAL log_output='TABLE'; SET GLOBAL general_log = 1;" mysql
       - name: Install
         run: npm ci
       - name: Download Build Artifacts

.release-please-manifest.json

@@ -7,7 +7,7 @@
   "detectors/node/opentelemetry-resource-detector-github": "0.31.0",
   "detectors/node/opentelemetry-resource-detector-instana": "0.21.0",
   "metapackages/auto-configuration-propagators": "0.4.1",
-  "metapackages/auto-instrumentations-node": "0.60.0",
+  "metapackages/auto-instrumentations-node": "0.60.1",
   "metapackages/auto-instrumentations-web": "0.48.0",
   "packages/baggage-span-processor": "0.4.0",
   "packages/baggage-log-record-processor": "0.3.0",
@@ -29,7 +29,7 @@
   "plugins/node/instrumentation-socket.io": "0.49.0",
   "plugins/node/instrumentation-tedious": "0.21.0",
   "plugins/node/instrumentation-typeorm": "0.3.0",
-  "plugins/node/instrumentation-undici": "0.13.0",
+  "plugins/node/instrumentation-undici": "0.13.1",
   "plugins/node/opentelemetry-instrumentation-aws-lambda": "0.53.0",
   "plugins/node/opentelemetry-instrumentation-aws-sdk": "0.54.0",
   "plugins/node/opentelemetry-instrumentation-bunyan": "0.48.0",
@@ -40,22 +40,22 @@
   "plugins/node/opentelemetry-instrumentation-fastify": "0.47.0",
   "plugins/node/opentelemetry-instrumentation-generic-pool": "0.46.0",
   "plugins/node/opentelemetry-instrumentation-graphql": "0.50.0",
-  "plugins/node/opentelemetry-instrumentation-hapi": "0.48.0",
+  "plugins/node/opentelemetry-instrumentation-hapi": "0.49.0",
   "plugins/node/opentelemetry-instrumentation-ioredis": "0.50.0",
   "plugins/node/opentelemetry-instrumentation-knex": "0.47.0",
-  "plugins/node/opentelemetry-instrumentation-koa": "0.50.0",
+  "plugins/node/opentelemetry-instrumentation-koa": "0.50.1",
   "plugins/node/opentelemetry-instrumentation-memcached": "0.46.0",
-  "plugins/node/opentelemetry-instrumentation-mongodb": "0.55.0",
+  "plugins/node/opentelemetry-instrumentation-mongodb": "0.55.1",
   "plugins/node/opentelemetry-instrumentation-mysql": "0.48.0",
   "plugins/node/opentelemetry-instrumentation-mysql2": "0.48.0",
   "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.48.0",
-  "plugins/node/opentelemetry-instrumentation-net": "0.46.0",
+  "plugins/node/opentelemetry-instrumentation-net": "0.46.1",
   "plugins/node/opentelemetry-instrumentation-oracledb": "0.28.0",
   "plugins/node/opentelemetry-instrumentation-pg": "0.54.0",
   "plugins/node/opentelemetry-instrumentation-pino": "0.49.0",
-  "plugins/node/opentelemetry-instrumentation-redis": "0.49.0",
+  "plugins/node/opentelemetry-instrumentation-redis": "0.49.1",
   "plugins/node/opentelemetry-instrumentation-redis-4": "0.49.0",
-  "plugins/node/opentelemetry-instrumentation-restify": "0.48.0",
+  "plugins/node/opentelemetry-instrumentation-restify": "0.48.1",
   "plugins/node/opentelemetry-instrumentation-router": "0.47.0",
   "plugins/node/opentelemetry-instrumentation-winston": "0.47.0",
   "plugins/web/opentelemetry-instrumentation-document-load": "0.47.0",

CONTRIBUTING.md

@@ -135,6 +135,34 @@ The conventional commit type (in PR title) is very important to automatically bu
 
 There is no need to update the CHANGELOG in a PR because it will be updated as part of the release process (see [RELEASING.md](RELEASING.md) for more details).
 
+### Testing
+
+Most unit tests case be run via:
+
+```sh
+npm test
+```
+
+However, some instrumentations require test-services to be running (e.g. the `instrumentation-mongodb` package requires a MongoDB server). Use the `test-services`-related npm scripts to start all required services in Docker and then run the tests with the appropriate configuration to use those services:
+
+```sh
+npm run test-services:start       # starts services in Docker
+npm run test:with-services-config # runs 'npm test' with envvars from test/test-services.env
+npm run test-services:stop        # stops services in Docker
+```
+
+If you only want to test a single package (e.g. the `instrumentation-mongodb`) you can `cd` into it and run the tests after you started the services.
+
+```sh
+npm run test-services:start                           # starts services in Docker
+cd plugins/node/opentelemetry-instrumentation-mongodb # get into the instrumenation folder
+RUN_MONGODB_TESTS=1 npm test                          # run the test with the proper config (check each package)
+cd ../../..                                           # go back to root folder
+npm run test-services:stop                            # stops services in Docker
+```
+
+NOTE: scripts for each package will be added to avoid extra consumption of resources and improve the development experience.
+
 ### Benchmarks
 
 When two or more approaches must be compared, please write a benchmark in the benchmark/index.js module so that we can keep track of the most efficient algorithm.

eslint.config.js

@@ -5,10 +5,10 @@ module.exports = {
     "node",
     "prettier"
   ],
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  extends: ["eslint:recommended", "plugin:prettier/recommended"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
-    "project": "./tsconfig.json"
+    "project": null
   },
   rules: {
     "quotes": ["error", "single", { "avoidEscape": true }],
@@ -28,6 +28,11 @@ module.exports = {
   overrides: [
     {
       files: ['*.ts'],
+      // Enable typescript-eslint for ts files.
+      extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+      parserOptions: {
+        "project": "./tsconfig.json"
+      },
       rules: {
         "@typescript-eslint/no-floating-promises": "error",
         "@typescript-eslint/no-this-alias": "off",
@@ -49,21 +54,39 @@ module.exports = {
           }
         }],
         "@typescript-eslint/no-shadow": ["warn"],
+        "prefer-rest-params": "off",
       }
     },
     {
       files: ["test/**/*.ts"],
+      // Enable typescript-eslint for ts files.
+      extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+      parserOptions: {
+        "project": "./tsconfig.json"
+      },
       rules: {
         "no-empty": "off",
         "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/ban-types": ["warn", {
+          "types": {
+            "Function": null,
+          }
+        }],
         "@typescript-eslint/no-empty-function": "off",
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/no-shadow": ["off"],
         "@typescript-eslint/no-floating-promises": ["off"],
         "@typescript-eslint/no-non-null-assertion": ["off"],
-        "@typescript-eslint/explicit-module-boundary-types": ["off"]
+        "@typescript-eslint/explicit-module-boundary-types": ["off"],
+        "prefer-rest-params": "off",
+      }
+    },
+    {
+      files: ["*.mjs"],
+      parserOptions: {
+        sourceType: 'module',
       }
     }
   ]

examples/bunyan/.eslintrc.js

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+'use strict';
+
+const baseConfig = require('../../eslint.config');
+
+module.exports = {
+  ...baseConfig,
+  env: {
+    node: true,
+  },
+};

examples/bunyan/app.js

@@ -28,7 +28,7 @@ const log = bunyan.createLogger({ name: 'myapp', level: 'debug' });
 log.debug({ foo: 'bar' }, 'hi');
 
 const tracer = otel.trace.getTracer('example');
-tracer.startActiveSpan('manual-span', (span) => {
+tracer.startActiveSpan('manual-span', span => {
   log.info('this record will have trace_id et al fields for the current span');
   span.end();
 });

examples/bunyan/app.mjs

@@ -21,13 +21,12 @@
 import { trace } from '@opentelemetry/api';
 import bunyan from 'bunyan';
 
-const log = bunyan.createLogger({name: 'myapp', level: 'debug'});
+const log = bunyan.createLogger({ name: 'myapp', level: 'debug' });
 
-log.debug({foo: 'bar'}, 'hi');
+log.debug({ foo: 'bar' }, 'hi');
 
 const tracer = trace.getTracer('example');
 tracer.startActiveSpan('manual-span', span => {
   log.info('this record will have trace_id et al fields for the current span');
   span.end();
 });
-

examples/bunyan/package.json

@@ -4,6 +4,8 @@
   "version": "0.1.0",
   "description": "Example of Bunyan integration with OpenTelemetry",
   "scripts": {
+    "lint": "eslint . --ext=ts,js,mjs",
+    "lint:fix": "eslint . --ext=ts,js,mjs --fix",
     "start": "node -r ./telemetry.js app.js"
   },
   "repository": {

examples/bunyan/telemetry.js

@@ -23,10 +23,16 @@
 // for viewing and analysis.
 
 const { NodeSDK, tracing, logs } = require('@opentelemetry/sdk-node');
-const { envDetector, hostDetector, processDetector } = require('@opentelemetry/resources');
+const {
+  envDetector,
+  hostDetector,
+  processDetector,
+} = require('@opentelemetry/resources');
 // api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.DEBUG);
 
-const { BunyanInstrumentation } = require('@opentelemetry/instrumentation-bunyan');
+const {
+  BunyanInstrumentation,
+} = require('@opentelemetry/instrumentation-bunyan');
 
 const sdk = new NodeSDK({
   serviceName: 'bunyan-example',
@@ -40,18 +46,20 @@ const sdk = new NodeSDK({
     // default detector of the `NodeSDK`.
     hostDetector,
   ],
-  spanProcessor: new tracing.SimpleSpanProcessor(new tracing.ConsoleSpanExporter()),
-  logRecordProcessor: new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
-  instrumentations: [
-    new BunyanInstrumentation(),
-  ],
+  spanProcessor: new tracing.SimpleSpanProcessor(
+    new tracing.ConsoleSpanExporter()
+  ),
+  logRecordProcessor: new logs.SimpleLogRecordProcessor(
+    new logs.ConsoleLogRecordExporter()
+  ),
+  instrumentations: [new BunyanInstrumentation()],
 });
 process.on('SIGTERM', () => {
   sdk
     .shutdown()
     .then(
       () => {},
-      (err) => console.log('warning: error shutting down OTel SDK', err),
+      err => console.log('warning: error shutting down OTel SDK', err)
     )
     .finally(() => process.exit(0));
 });