@saidsef/tracing-node 1.11.0 → 2.1.0

package/deployment/base/job.yml

@@ -31,4 +31,4 @@ spec:
       gitRepo:
         directory: "."
         repository: "https://github.com/saidsef/tracing-node.git"
-        revision: "dependabot-npm_and_yarn-opentelemetry-instrumentation-express-0.39.0"
+        revision: "tracking-func-signature"

package/libs/index.mjs

@@ -34,42 +34,54 @@ import {B3Propagator, B3InjectEncoding} from '@opentelemetry/propagator-b3';
 diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
 
 /**
-* Sets up tracing for a given service, allowing for the collection and export of trace data.
-* This function configures a NodeTracerProvider with specific resource attributes, including
-* service name, namespace, and host. It also configures an exporter using the OTLP protocol
-* over gRPC, with the option to specify an endpoint. Instrumentations for HTTP, Express,
-* AWS, Pino, and DNS are registered to capture relevant spans. The function finally returns
-* a tracer specific to the service for initiating and exporting spans.
+* Sets up tracing for the application using OpenTelemetry.
 *
-* @param {string} serviceName - The name of the service to be traced. This will be used to
-* label traces and is essential for identifying traces belonging
-* to this service.
-* @param {string} [appName="application"] - The namespace or application name the service
-* belongs to. This helps in grouping services under
-* a common namespace for better trace organization.
-* @param {string|null} [endpoint=null] - The endpoint URL for the OTLP gRPC exporter. If not
-* provided, the exporter will default to its standard
-* configuration, which might not be suitable for all
-* deployments.
-* @returns {Tracer} - Returns a Tracer instance configured for the service. This tracer can
-* be used to create and export spans for tracing various operations within
-* the service.
+* This function configures a NodeTracerProvider with various instrumentations
+* and span processors to enable tracing for the application. It supports
+* tracing for HTTP, Express, AWS, Pino, and DNS.
+*
+* @param {Object} options - Configuration options for tracing.
+* @param {string} [options.containerName=process.env.CONTAINER_NAME] - The name of the container.
+* @param {string} [options.deploymentEnvironment=process.env.NODE_ENV] - The deployment environment.
+* @param {string} [options.hostname=process.env.HOSTNAME] - The hostname of the service.
+* @param {string} [options.serviceName=process.env.SERVICE_NAME] - The name of the service.
+* @param {string} [options.serviceNameSpace=process.env.NAME_SPACE || 'default'] - The namespace of the service.
+* @param {string} [options.serviceVersion=process.env.SERVICE_VERSION || '0.0.0'] - The version of the service.
+* @param {string} [options.url=process.env.ENDPOINT] - The endpoint URL for the tracing collector.
+* @param {number} [options.concurrencyLimit=10] - The concurrency limit for the exporter.
+*
+* @returns {Tracer} - The tracer for the service.
 */
-export function setupTracing (serviceName, appName='application', endpoint=null) {
+export function setupTracing (options={}) {
+  const {
+    containerName = process.env.CONTAINER_NAME,
+    deploymentEnvironment = process.env.NODE_ENV,
+    hostname = process.env.HOSTNAME,
+    serviceName = process.env.SERVICE_NAME,
+    serviceNameSpace = process.env.NAME_SPACE || 'default',
+    serviceVersion = process.env.SERVICE_VERSION || '0.0.0',
+    url = process.env.ENDPOINT,
+    concurrencyLimit = 10,
+  } = options;
+
   const provider = new NodeTracerProvider({
     resource: new Resource({
+      [SemanticResourceAttributes.CONTAINER_NAME]: containerName,
+      [SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT]: deploymentEnvironment,
+      [SemanticResourceAttributes.HOSTNAME]: hostname,
       [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
-      [SemanticResourceAttributes.SERVICE_NAMESPACE]: appName,
-      [SemanticResourceAttributes.CONTAINER_NAME]: serviceName,
-      [SemanticResourceAttributes.HOST_NAME]: serviceName,
+      [SemanticResourceAttributes.SERVICE_NAMESPACE]: serviceNameSpace,
+      [SemanticResourceAttributes.SERVICE_VERSION]: serviceVersion || '0.0.0',
+      [SemanticResourceAttributes.URL]: url,
       instrumentationLibrarySemanticConvention: true,
     }),
   });
 
   // Configure exporter with the Collector endpoint - uses gRPC
   const exportOptions = {
-    serviceName: serviceName,
-    url: endpoint,
+    concurrencyLimit: concurrencyLimit,
+    url: url,
+    timeoutMillis: 1000,
   };
 
   // Register the span processor with the tracer provider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "1.11.0",
+  "version": "2.1.0",
   "description": "tracing NodeJS - This is a wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {