npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@opentelemetry/instrumentation-knex

v0.41.0

Published

OpenTelemetry instrumentation for `knex` database SQL query builder

Downloads

4,093,312

Readme

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

| Options | Type | Example | Description | | ------- | ---- | ------- | ----------- | | maxQueryLength | number | 100 | Truncate 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. | | requireParentSpan | boolean | false | Don'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:

| Attribute | Short Description | | ----------------------- | ------------------------------------------------------------------------------ | | db.name | This attribute is used to report the name of the database being accessed. | | db.operation | The name of the operation being executed. | | 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. | | net.transport | Transport protocol used. |

Useful links

License

Apache 2.0 - See LICENSE for more information.