Merge branch 'main' into remove-addLogRecordProcessor

Author: svetlanabrennan

.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

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.

examples/connect/.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/connect/.npmrc

@@ -0,0 +1 @@
+package-lock=false

examples/connect/client.js

@@ -1,3 +1,19 @@
+/*
+ * 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';
 
 // eslint-disable-next-line import/order

examples/connect/package.json

@@ -5,6 +5,8 @@
   "description": "Example of Connect integration with OpenTelemetry",
   "main": "index.js",
   "scripts": {
+    "lint": "eslint . --ext=ts,js,mjs",
+    "lint:fix": "eslint . --ext=ts,js,mjs --fix",
     "client": "node ./client.js",
     "docker:start": "cd ./docker && docker-compose down && docker-compose up",
     "docker:stop": "cd ./docker && docker-compose down",

examples/connect/server.js

@@ -1,3 +1,19 @@
+/*
+ * 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';
 
 // eslint-disable-next-line
@@ -21,7 +37,9 @@ app.use((req, res, next) => {
 });
 
 app.use('/run_test', async (req, res) => {
-  const result = await axios.get('https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/main/package.json');
+  const result = await axios.get(
+    'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/main/package.json'
+  );
   tracing.log('sending response');
   res.end(`OK ${result.data.version}`);
 

examples/connect/tracing.js

@@ -1,3 +1,19 @@
+/*
+ * 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 opentelemetry = require('@opentelemetry/api');
@@ -12,7 +28,9 @@ const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
 const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { CollectorTraceExporter } = require('@opentelemetry/exporter-collector');
 
-const { ConnectInstrumentation } = require('@opentelemetry/instrumentation-connect');
+const {
+  ConnectInstrumentation,
+} = require('@opentelemetry/instrumentation-connect');
 const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
 
 function log() {
@@ -21,15 +39,13 @@ function log() {
   console.log.apply(this, args);
 }
 
-module.exports = (serviceName) => {
+module.exports = serviceName => {
   const exporter = new CollectorTraceExporter();
   const provider = new NodeTracerProvider({
     resource: new Resource({
       [ATTR_SERVICE_NAME]: serviceName,
     }),
-    spanProcessors: [
-      new SimpleSpanProcessor(exporter),
-    ],
+    spanProcessors: [new SimpleSpanProcessor(exporter)],
   });
   const connectInstrumentation = new ConnectInstrumentation();
   registerInstrumentations({

examples/dns/.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,
+  },
+};