@opentelemetry/instrumentation-tedious

What is @opentelemetry/instrumentation-tedious?

@opentelemetry/instrumentation-tedious is an OpenTelemetry instrumentation library for the Tedious SQL Server client. It allows you to automatically collect and report telemetry data such as traces and metrics from your SQL Server interactions, which can be used for monitoring and debugging purposes.

What are @opentelemetry/instrumentation-tedious's main functionalities?

Automatic Tracing

This feature allows you to automatically trace SQL queries made using the Tedious client. The traces can be used to monitor the performance and behavior of your SQL queries.

{"import":"import { NodeTracerProvider } from '@opentelemetry/node';","import2":"import { registerInstrumentations } from '@opentelemetry/instrumentation';","import3":"import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';","setup":"const provider = new NodeTracerProvider();","register":"registerInstrumentations({\n  instrumentations: [\n    new TediousInstrumentation(),\n  ],\n  tracerProvider: provider,\n});","start":"provider.register();"}

Custom Span Attributes

This feature allows you to add custom attributes to the spans generated by the Tedious instrumentation. This can be useful for adding additional context to your telemetry data.

{"import":"import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';","setup":"const tediousInstrumentation = new TediousInstrumentation({\n  responseHook: (span, request, response) => {\n    span.setAttribute('custom-attribute', 'value');\n  }\n});"}

Other packages similar to @opentelemetry/instrumentation-tedious

@opentelemetry/instrumentation-mysql

@opentelemetry/instrumentation-mysql is an OpenTelemetry instrumentation library for the MySQL client. It provides similar functionalities for MySQL as @opentelemetry/instrumentation-tedious does for SQL Server, including automatic tracing and custom span attributes.

@opentelemetry/instrumentation-pg

@opentelemetry/instrumentation-pg is an OpenTelemetry instrumentation library for the PostgreSQL client. Like @opentelemetry/instrumentation-tedious, it allows for automatic tracing and custom span attributes, but it is designed for use with PostgreSQL.

@opentelemetry/instrumentation-mongodb

@opentelemetry/instrumentation-mongodb is an OpenTelemetry instrumentation library for the MongoDB client. It provides similar functionalities for MongoDB as @opentelemetry/instrumentation-tedious does for SQL Server, including automatic tracing and custom span attributes.

README

OpenTelemetry Tedious Instrumentation for Node.js

This module provides automatic instrumentation for the tedious module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-tedious

Supported Versions

• tedious >=1.11.0 <20

Usage

OpenTelemetry Tedious Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with tedious.

To load a specific plugin, specify it in the registerInstrumentations's configuration:

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { TediousInstrumentation } = require('@opentelemetry/instrumentation-tedious');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new TediousInstrumentation(),
  ],
})

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute	Short Description
db.name	This attribute is used to report the name of the database being accessed.
db.sql.table	The name of the primary table that the operation is acting upon.
db.statement	The database statement being executed.
db.system	An identifier for the database management system (DBMS) product being used.
db.user	Username for accessing the database.
net.peer.name	Remote hostname or similar.
net.peer.port	Remote port number.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.16.0

:boom: Breaking Change

• opentelemetry-host-metrics
  • #429 Remove plugins (@obecny)

:bug: Bug Fix

• #403 chore: fixing context propagation on mongo callback (@obecny)

:rocket: Enhancement

• opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • #440 chore: update core to 0.19, api to rc0 (@dyladan)
• opentelemetry-id-generator-aws-xray
  • #423 feat: add x-ray id generator (@anuraaga)
• Other
  • #432 feat: pino instrumentation (@seemk)
  • #425 feat: winston instrumentation (@seemk)
  • #416 feat: restify instrumentation (@Rauno56)
  • #419 feat: bunyan instrumentation (@seemk)

:house: Internal

• opentelemetry-host-metrics, opentelemetry-test-utils
  • #437 chore: clean some unused deps (@Rauno56)
• Other
  • #434 chore: clean up images from restify example (@Rauno56)

:memo: Documentation

• #413 document: fix express example (@Rauno56)

Committers: 9

• Anuraag Agrawal (@anuraaga)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Rauno Viskus (@Rauno56)
• Severin Neumann (@svrnm)
• Siim Kallas (@seemk)
• Valentin Marchaud (@vmarchaud)
• William Armiros (@willarmiros)
• @gregoryfranklin