@saidsef/tracing-node 3.6.0 → 3.7.3

package/README.md

@@ -7,17 +7,14 @@
 ![GitHub release(latest by date)](https://img.shields.io/github/v/release/saidsef/tracing-node)
 ![Commits](https://img.shields.io/github/commits-since/saidsef/tracing-node/latest.svg)
 
-
-
-
 Get telemetry for your app in less than 3 minutes!
 
-A wrapper around opentelemetry and set of instrumentation applications. This is to make instrumentation (more) idempotent.
+Effortlessly supercharge your applications with world-class distributed tracing! This OpenTelemetry wrapper delivers seamless, lightning-fast observability, empowering developers to monitor, debug, and optimise microservices with ease. Designed for modern cloud-native environments, it’s the smart choice for engineers who demand reliability, scalability, and actionable insights. Get started in minutes and unlock the full potential of your service architecture—no fuss, just results.  This is to make instrumentation (more) idempotent.
 
 ## Prerequisites
 - NodeJS
 - ...
-- Profit!
+- Profit?
 
 ## Instalation
 
@@ -30,18 +27,13 @@ npm install @saidsef/tracing-node --save
 You can set required params via env variables or function:
 
 Env vars:
-```
-CONTAINER_NAME || HOSTNAME
-ENDPOINT
-SERVICE_NAME
-```
+| Environment Variable   | Description                | Required |
+|-----------------------|----------------------------| --------- |
+| CONTAINER_NAME/HOSTNAME| Container or pod hostname  | No |
+| ENDPOINT              | Tracing collector endpoint | Yes |
+| SERVICE_NAME          | Service/application name   | Yes |
 
 Function args
-```
-const { setupTracing } = require('@saidsef/tracing-node');
-setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});
-```
-
 ```
 import { setupTracing } from '@saidsef/tracing-node';
 setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});
@@ -49,13 +41,13 @@ setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'
 
 ### Required Parameters are
 
-| Name | Type | Description|
-|----- | ---- | ------------- |
-| hostname | string | container / pod hostname | 
-| serviceName | string | service / application name |
-| url | string | tracing endpoint i.e. `<schema>://<host>:<port>` |
-| enableFsInstrumentation | boolean | enable FS instrumentation, default `false` |
-| enableDnsInstrumentation | boolean | enable DNS instrumentation, default `false` |
+| Name | Type | Description| Required | Default |
+|----- | ---- | ------------- | ----- | ---- |
+| hostname | string | container / pod hostname | No | `hostname` |
+| serviceName | string | service / application name | Yes | `n/a` |
+| url | string | tracing endpoint i.e. `<schema>://<host>:<port>` | Yes | `n/a` |
+| enableFsInstrumentation | boolean | enable FS instrumentation | No | `false` |
+| enableDnsInstrumentation | boolean | enable DNS instrumentation | No | `false`  |
 
 ## Source
 

package/libs/index.mjs

@@ -17,6 +17,7 @@
  */
 
 import {AwsInstrumentation} from '@opentelemetry/instrumentation-aws-sdk';
+import {AsyncHooksContextManager} from '@opentelemetry/context-async-hooks';
 import {BatchSpanProcessor} from '@opentelemetry/sdk-trace-base';
 import {CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator} from '@opentelemetry/core';
 import {ConnectInstrumentation} from '@opentelemetry/instrumentation-connect';
@@ -91,6 +92,7 @@ export function setupTracing(options = {}) {
 
   // Initialize the tracer provider with propagators
   tracerProvider.register({
+    contextManager: new AsyncHooksContextManager().enable(),
     propagator: new CompositePropagator({
     propagators: [
       new W3CTraceContextPropagator(),
@@ -106,12 +108,12 @@ export function setupTracing(options = {}) {
 
   // Register instrumentations
   const instrumentations = [
-    new HttpInstrumentation({serverName: serviceName, requireParentforOutgoingSpans: true, requireParentforIncomingSpans: true, ignoreIncomingRequestHook,}),
+    new HttpInstrumentation({serverName: serviceName, ignoreIncomingRequestHook,}),
     new ExpressInstrumentation({ ignoreIncomingRequestHook, }),
     new PinoInstrumentation({logHook: (span, record) => {record['trace_id'] = span.spanContext().traceId;record['span_id'] = span.spanContext().spanId;},}),
     new ConnectInstrumentation(),
     new AwsInstrumentation({ sqsExtractContextPropagationFromPayload: true, }),
-    new IORedisInstrumentation({ requireParentSpan: true, }),
+    new IORedisInstrumentation(),
   ];
 
   if (enableFsInstrumentation) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "3.6.0",
+  "version": "3.7.3",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {
@@ -31,9 +31,10 @@
   "homepage": "https://github.com/saidsef/tracing-node#readme",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/context-async-hooks": "^2.0.1",
     "@opentelemetry/exporter-trace-otlp-grpc": "^0.203.0",
     "@opentelemetry/instrumentation": "^0.203.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.56.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.57.0",
     "@opentelemetry/instrumentation-connect": "^0.47.0",
     "@opentelemetry/instrumentation-dns": "^0.47.0",
     "@opentelemetry/instrumentation-express": "^0.52.0",