feat: add ability to shutdonw tracing gracefully

[saidsef]

1. Logger Configuration:

• The diag.setLogger function now uses a DiagConsoleLogger with a log level set to INFO. This ensures that tracing logs are properly configured for debugging purposes.

2. Tracer Provider Initialization:

• The NodeTracerProvider is now initialized with a Resource object that includes attributes such as CONTAINER_NAME and DEPLOYMENT_ENVIRONMENT. This provides context to the tracing system.
• The tracerProvider is declared in module scope for access in the stopTracing function.

3. Propagator Configuration:

• A CompositePropagator is used to combine multiple propagators (W3CBaggagePropagator, W3CTraceContextPropagator, and B3Propagator) for efficient propagation of tracing context across different systems.

4. Span Processor Configuration:

• The OTLPTraceExporter is configured with options for exporting traces to a collector endpoint using gRPC.
• A BatchSpanProcessor is registered with the tracer provider to handle batch processing of spans before exporting them.

5. Instrumentation Registration:

• Various instrumentations (Express, Pino, HTTP, AWS, DNS) are registered with the tracer provider to instrument specific parts of the application.
• Each instrumentation is configured with relevant hooks and settings to ensure accurate and efficient tracing.

6. Graceful Shutdown:

• A new stopTracing function has been added to gracefully shut down the tracing system by shutting down the tracer provider and ensuring all pending spans are exported before cleanup.

This commit enhances the OpenTelemetry tracing setup by improving logger configuration, tracer provider initialization, propagator combination, span processor configuration, instrumentation registration, and adding a graceful shutdown mechanism. These changes ensure robustness and efficiency in tracing operations within the application.

[saidsef]

/code pr

[saidsef]

🤖
The changes look solid overall, with good improvements to the tracing implementation. Here's my review:

Positives:

• Good addition of graceful shutdown functionality via stopTracing()
• Improved code organisation with module-scoped tracerProvider
• Better error handling in shutdown process
• Clear documentation with JSDoc comments
• Proper separation of exporter and span processor setup

Suggestions for improvement:

1. In stopTracing():

// Consider adding a timeout parameter
export async function stopTracing(timeoutMs = 5000) {
  if (!tracerProvider) return;
  
  try {
    await Promise.race([
      tracerProvider.shutdown(),
      new Promise((_, reject) => 
        setTimeout(() => reject(new Error('Shutdown timeout')), timeoutMs)
      )
    ]);
    console.info('Tracing shutdown complete');
  } catch (error) {
    console.error('Tracing shutdown failed:', error);
  }
}

2. Fix indentation inconsistencies in the instrumentations setup:

registerInstrumentations({
  tracerProvider: tracerProvider,
  instrumentations: [
    // Keep consistent indentation throughout
  ]
});

3. Consider adding a simple status check method:

export function isTracingActive() {
  return tracerProvider !== null;
}

The changes are well-structured and improve the codebase. Just ensure the indentation is consistent throughout the file.

_{> claude-3-5-sonnet-20241022 [pr | 1]}