Merge branch 'main' into fix/host-metrics-bundling

.github/component_owners.yml

@@ -27,6 +27,9 @@ components:
     - pichlermarc
     - legendecas
     - blumamir
+  packages/baggage-span-processor:
+    - mikegoldsmith
+    - jamiedanielson
   packages/opentelemetry-host-metrics:
     - legendecas
   packages/opentelemetry-id-generator-aws-xray:

.release-please-manifest.json

@@ -6,8 +6,9 @@
   "detectors/node/opentelemetry-resource-detector-gcp": "0.29.9",
   "detectors/node/opentelemetry-resource-detector-github": "0.28.2",
   "detectors/node/opentelemetry-resource-detector-instana": "0.9.0",
-  "metapackages/auto-instrumentations-node": "0.45.0",
+  "metapackages/auto-instrumentations-node": "0.46.0",
   "metapackages/auto-instrumentations-web": "0.39.0",
+  "packages/baggage-span-processor": "0.1.0",
   "packages/opentelemetry-host-metrics": "0.35.1",
   "packages/opentelemetry-id-generator-aws-xray": "1.2.2",
   "packages/opentelemetry-propagation-utils": "0.30.9",
@@ -20,34 +21,34 @@
   "plugins/node/instrumentation-dataloader": "0.9.0",
   "plugins/node/instrumentation-fs": "0.12.0",
   "plugins/node/instrumentation-lru-memoizer": "0.37.0",
-  "plugins/node/instrumentation-mongoose": "0.38.0",
+  "plugins/node/instrumentation-mongoose": "0.38.1",
   "plugins/node/instrumentation-runtime-node": "0.4.0",
   "plugins/node/instrumentation-socket.io": "0.39.0",
-  "plugins/node/instrumentation-tedious": "0.10.0",
+  "plugins/node/instrumentation-tedious": "0.10.1",
   "plugins/node/instrumentation-undici": "0.2.0",
   "plugins/node/opentelemetry-instrumentation-aws-lambda": "0.41.0",
   "plugins/node/opentelemetry-instrumentation-aws-sdk": "0.41.0",
   "plugins/node/opentelemetry-instrumentation-bunyan": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-cassandra": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-connect": "0.36.0",
-  "plugins/node/opentelemetry-instrumentation-dns": "0.36.0",
+  "plugins/node/opentelemetry-instrumentation-dns": "0.36.1",
   "plugins/node/opentelemetry-instrumentation-express": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-fastify": "0.36.0",
+  "plugins/node/opentelemetry-instrumentation-fastify": "0.36.1",
   "plugins/node/opentelemetry-instrumentation-generic-pool": "0.36.0",
   "plugins/node/opentelemetry-instrumentation-graphql": "0.40.0",
-  "plugins/node/opentelemetry-instrumentation-hapi": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-hapi": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-ioredis": "0.40.0",
-  "plugins/node/opentelemetry-instrumentation-knex": "0.36.0",
+  "plugins/node/opentelemetry-instrumentation-knex": "0.36.1",
   "plugins/node/opentelemetry-instrumentation-koa": "0.40.0",
   "plugins/node/opentelemetry-instrumentation-memcached": "0.36.0",
   "plugins/node/opentelemetry-instrumentation-mongodb": "0.43.0",
-  "plugins/node/opentelemetry-instrumentation-mysql": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-mysql2": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-mysql": "0.38.1",
+  "plugins/node/opentelemetry-instrumentation-mysql2": "0.38.1",
+  "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.37.1",
   "plugins/node/opentelemetry-instrumentation-net": "0.36.0",
   "plugins/node/opentelemetry-instrumentation-pg": "0.41.0",
-  "plugins/node/opentelemetry-instrumentation-pino": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-redis": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-pino": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-redis": "0.39.1",
   "plugins/node/opentelemetry-instrumentation-redis-4": "0.39.0",
   "plugins/node/opentelemetry-instrumentation-restify": "0.38.0",
   "plugins/node/opentelemetry-instrumentation-router": "0.37.0",

GUIDELINES.md

@@ -164,3 +164,36 @@ To support this use case, you can choose one of the following options:
     };
     ...
     ```
+
+## Diag Logging
+
+The OpenTelemetry diagnostic logging channel can be used to troubleshoot issues with instrumentation packages.
+
+### Patching Messages
+
+When OpenTelemetry is installed in a user application, and expected spans are missing from generated traces, it is often useful to differentiate between the following scenarios:
+
+- The instrumentation is not auto loaded - due to issue with the require/import interception, an unsupported version of the instrumented package, or some other issue. This knowledge can pin-point the issue to the instrumentation package.
+- The instrumentation patch was applied but expected spans are missing -- this can suggest an issue with instrumented package logic, configuration, limits, otel sdk, or other issues.
+
+It can also be useful to know when the instrumentation is loaded and patched, to understand the order of operations in the application.
+
+Instrumentation packages should use the `@opentelemetry/instrumentation` package `InstrumentationBase` class to register patches and unpatch callbacks for specific require/import of the instrumented package, it's dependency or an internal module file. When this mechanism is used, the base class will automatically emit a debug message on instrumentation diag component logger, looking like this:
+
+```shell
+@opentelemetry/instrumentation-foo Applying instrumentation patch for module on require hook {
+  module: 'foo',
+  version: '1.2.3',
+  baseDir: '<your directory>/node_modules/foo'
+}
+```
+
+Instrumentation should not add additional debug messages for triggering the patching and unpatching callbacks, as the base class will handle this.
+
+Instrumentation may add additional patch/unpatch messages for specific functions if it is expected to help in troubleshooting issues with the instrumentation. Few examples:
+
+- If the patch logic is conditional, and user can benefit from ensuring the condition is met and the patch happened. `koa` patching logic examine an object and branch between patching it as router vs middleware, which is applied at runtime. `aws-lambda` will abort patching if the environment is not configured properly.
+- When the patch is not applied directly on a `moduleExports` object in the `InstrumentationBase` callbacks, but rather from an event in the package, like creating new client instance, registering a listener, etc. `fastify` instrumentation applies a patch when a hook is added to the fastify app instance, which is patched from `moduleExports`.
+- In situations where the patch logic is not trivial and it helps to specify patch events in the right context and nuances. `aws-lambda` logs additional properties extracted from the lambda framework and exposes them for troubleshooting.
+
+The cases above are not covered by the base class and offer additional context to the user troubleshooting an issue with the instrumentation.