@opentelemetry/sql-common

What is @opentelemetry/sql-common?

@opentelemetry/sql-common is a package that provides common utilities and types for instrumenting SQL databases with OpenTelemetry. It helps in tracing and monitoring SQL queries by providing a standardized way to collect and report telemetry data.

What are @opentelemetry/sql-common's main functionalities?

Instrumentation of SQL Queries

This feature allows you to create spans around SQL query executions, which helps in tracing the performance and errors of SQL queries.

const { createSpan, context } = require('@opentelemetry/sql-common');

function executeQuery(query) {
  const span = createSpan('executeQuery');
  try {
    // Execute the SQL query
    const result = database.execute(query);
    span.setStatus({ code: 0 }); // Success
    return result;
  } catch (error) {
    span.setStatus({ code: 2, message: error.message }); // Error
    throw error;
  } finally {
    span.end();
  }
}

Context Propagation

This feature allows you to propagate context across asynchronous operations, ensuring that telemetry data is correctly associated with the originating request.

const { context, setSpan } = require('@opentelemetry/sql-common');

function executeQueryWithContext(query) {
  const span = createSpan('executeQueryWithContext');
  const ctx = setSpan(context.active(), span);
  return context.with(ctx, () => {
    try {
      // Execute the SQL query
      const result = database.execute(query);
      span.setStatus({ code: 0 }); // Success
      return result;
    } catch (error) {
      span.setStatus({ code: 2, message: error.message }); // Error
      throw error;
    } finally {
      span.end();
    }
  });
}

Other packages similar to @opentelemetry/sql-common

@opentelemetry/instrumentation

@opentelemetry/instrumentation is a core package for OpenTelemetry that provides a framework for instrumenting various libraries and frameworks. It is more general-purpose compared to @opentelemetry/sql-common, which is specifically focused on SQL databases.

winston

Winston is a popular logging library for Node.js. While it is not specifically designed for telemetry, it can be used to log SQL queries and errors, providing some level of monitoring. However, it lacks the built-in context propagation and span creation features of @opentelemetry/sql-common.

datadog

Datadog is a comprehensive monitoring and analytics platform that offers SQL query monitoring as part of its APM (Application Performance Monitoring) suite. It provides more out-of-the-box features compared to @opentelemetry/sql-common but is a paid service.

README

Common Utils for OpenTelemetry SQL packages

This is an internal utils package used for the different SQL instrumentations:

1. mysql2
2. pg