Merge remote-tracking branch 'upstream/main' into main

.dockerignore

@@ -0,0 +1,10 @@
+node_modules
+
+# examples
+examples/*/node_modules
+examples/*/package-lock.json
+examples/*/.env*
+!examples/*/.env.collector
+
+# example tests
+test/examples/node_modules

.github/dependabot.yml

@@ -5,9 +5,5 @@ updates:
   - package-ecosystem: "npm"
     # Look for `package.json` and `lock` files in the `root` directory
     directory: "/"
-    # Check the npm registry for updates every day (weekdays)
     schedule:
-      interval: "daily"
-    allowed_updates:
-      - match:
-          update_type: "security"
+      interval: "weekly"

.github/workflows/ci.yml

@@ -78,10 +78,26 @@ jobs:
           docker --version;
       - name: Test basic example
         working-directory: test/examples
-        run: docker-compose -f basic.docker-compose.yml up --build --exit-code-from test
+        run: docker-compose -f e2e.docker-compose.yml -f published.override.yml up --exit-code-from test
       - name: Test express example
         working-directory: test/examples
-        run: docker-compose -f express.docker-compose.yml up --build --exit-code-from test
+        run: docker-compose -f e2e.docker-compose.yml -f express.override.yml -f published.override.yml up --exit-code-from test
       - name: Test mixed example
         working-directory: test/examples
-        run: docker-compose -f mixed.docker-compose.yml up --build --exit-code-from test
+        run: docker-compose -f e2e.docker-compose.yml -f mixed.override.yml -f published.override.yml up --exit-code-from test
+
+  e2e:
+    runs-on: ubuntu-latest
+    permissions: read-all
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Test basic example
+        working-directory: test/examples
+        run: docker-compose -f e2e.docker-compose.yml up --exit-code-from test
+      - name: Test express example
+        working-directory: test/examples
+        run: docker-compose -f e2e.docker-compose.yml -f express.override.yml up --exit-code-from test
+      - name: Test mixed example
+        working-directory: test/examples
+        run: docker-compose -f e2e.docker-compose.yml -f mixed.override.yml up --exit-code-from test

README.md

@@ -85,7 +85,7 @@ Then you can automatically instrument your application by running
 node -r @splunk/otel/instrument index.js
 ```
 
-## Correlate traces and logs
+## Correlate traces and logs
 
 The Splunk Distribution of OpenTelemetry JS automatically injects trace metadata into logs so that Node.js logging libraries can access it. You can use trace metadata to correlate traces with log events and explore logs in Observability Cloud.
 

docs/advanced-config.md

@@ -42,4 +42,6 @@ The following config options can be set by passing them as arguments to `startTr
 
 - `propagatorFactory`: A function that returns a new instance of a TextMapPropagator. Defaults to a composite propagator comprised of W3C [Trace Context](https://www.w3.org/TR/trace-context/) and [Baggage](https://w3c.github.io/baggage/) propagators.
 
-- `instrumentations`: Can be used to enable additional instrumentation packages.
+- `instrumentations`: Can be used to enable additional instrumentation packages.
+
+- `captureHttpRequestUriParams`: Either a list of keys (case-sensitive) of HTTP query parameters to capture or a function that gets invoked with the current span and query parameters to set a custom span attribute. When using the former, parameters are set as span attributes as `http.request.param.${key}`. Attribute keys are normalized at capture time, meaning `.` is replaced with `_` to avoid any attribute namespacing issues.

docs/correlate-logs-traces.md

@@ -3,7 +3,7 @@
 
 The Splunk Distribution of OpenTelemetry JS automatically injects trace metadata into logs so that Node.js logging libraries can access it. You can use trace metadata to correlate traces with log events and explore logs in Observability Cloud.
 
-## Supported logging libraries
+## Supported logging libraries
 
 The following logging librares are supported:
 
@@ -24,7 +24,7 @@ The format of each log message depends on the logging library. The following is
    {"level":30,"time":1979374615686,"pid":728570,"hostname":"my_host","trace_id":"f8e261432221096329baf5e62090d856","span_id":"3235afe76b55fe51","trace_flags":"01","url":"/lkasd","msg":"request handler"}
 ```
 
-## Enable logs injection
+## Enable logs injection
 
 To enable log injection, install the instrumentation package for your logging library:
 
@@ -34,4 +34,4 @@ To enable log injection, install the instrumentation package for your logging li
 @opentelemetry/instrumentation-winston
 ``
 
-To inject trace data into formatted logs, refer to the documentation of each library.
+To inject trace data into formatted logs, refer to the documentation of each library.

examples/basic/.dockerignore

@@ -1 +1,2 @@
 node_modules
+package-lock.json

examples/express/package.json

@@ -3,14 +3,15 @@
   "private": true,
   "main": "server.js",
   "scripts": {
-    "client": "env-cmd nodemon -r ./tracer.js client.js",
-    "client:jaeger": "env-cmd nodemon -r ./tracer.jaeger.js client.js",
-    "client:collector": "env-cmd -f .env.collector nodemon -r ./tracer.js client.js",
-    "client:opentracing": "env-cmd nodemon -r ./tracer.opentracing.js client.js",
-    "server": "env-cmd nodemon -r ./tracer.js server.js",
-    "server:jaeger": "env-cmd nodemon -r ./tracer.jaeger.js server.js",
-    "server:collector": "env-cmd -f .env.collector nodemon -r ./tracer.js server.js",
-    "server:opentracing": "env-cmd nodemon -r ./tracer.opentracing.js server.js"
+    "client": "env-cmd --silent nodemon -r ./tracer.js client.js",
+    "client:jaeger": "env-cmd --silent nodemon -r ./tracer.jaeger.js client.js",
+    "client:collector": "env-cmd --silent -f .env.collector nodemon -r ./tracer.js client.js",
+    "client:opentracing": "env-cmd --silent nodemon -r ./tracer.opentracing.js client.js",
+    "start": "npm run server",
+    "server": "env-cmd --silent nodemon -r ./tracer.js server.js",
+    "server:jaeger": "env-cmd --silent nodemon -r ./tracer.jaeger.js server.js",
+    "server:collector": "env-cmd --silent -f .env.collector nodemon -r ./tracer.js server.js",
+    "server:opentracing": "env-cmd --silent nodemon -r ./tracer.opentracing.js server.js"
   },
   "dependencies": {
     "@opentelemetry/exporter-jaeger": "^0.24.0",

examples/mixed/.dockerignore

@@ -1 +1,2 @@
 node_modules
+package-lock.json