Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@opentelemetry/instrumentation-knex

Package Overview
Dependencies
Maintainers
3
Versions
35
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-knex

OpenTelemetry instrumentation for `knex` database SQL query builder

  • 0.43.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.8M
increased by12.83%
Maintainers
3
Weekly downloads
 
Created
Source

OpenTelemetry Knex Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the knex module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle. This module allows the user to automatically collect trace data and export them to their backend of choice.

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-knex

Supported Versions

  • knex versions >=0.10.0 <4

Usage

const { KnexInstrumentation } = require('@opentelemetry/instrumentation-knex');
const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();

provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();

registerInstrumentations({
  instrumentations: [
    new KnexInstrumentation({
        maxQueryLength: 100,
      })
  ],
  tracerProvider: provider,
});

Configuration Options

OptionsTypeExampleDescription
maxQueryLengthnumber100Truncate db.statement attribute to a maximum length. If the statement is truncated '..' is added to it's end. Default 1022. -1 leaves db.statement untouched.
requireParentSpanbooleanfalseDon't create spans unless they are part of an existing trace. Default is false.

Semantic Conventions

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

Attributes collected:

AttributeShort Description
db.nameThis attribute is used to report the name of the database being accessed.
db.operationThe name of the operation being executed.
db.sql.tableThe name of the primary table that the operation is acting upon.
db.statementThe database statement being executed.
db.systemAn identifier for the database management system (DBMS) product being used.
db.userUsername for accessing the database.
net.peer.nameRemote hostname or similar.
net.peer.portRemote port number.
net.transportTransport protocol used.

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Package last updated on 05 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc