@stratumn/instrumentation-pg

OpenCensus pg instrumentation for Node.js

This package instruments the Client.prototype.query and PoolClient.prototype.query in the node-postgres module. Child spans will be created anytime these methods are used when using this module.

Usage

Add the key value pair

plugins: { pg: '@stratumn/instrumentation-pg' }

to your OpenCensus tracing config.

Example:

import tracing from '@opencensus/nodejs';

tracing.start({
    samplingRate: 1,
    plugins: { pg: '@stratumn/instrumentation-pg' }
});

Release process

We are using semantic-release to publish the package on the NPM registry. Publishing can be triggered by "promoting" a successful build on master from Semaphore UI. The commit message summary should follow the following format:

Tag: Message (fixes #1234)

Where Tag is one of the following:

• Fix - for a bug fix. (patch)
• Update - for a backwards-compatible enhancement. (minor)
• New - implemented a new feature. (minor)
• Breaking - for a backwards-incompatible enhancement. (major)

The message summary should be a one-sentence description of the change. The issue number should be mentioned at the end. * The commit message should say "(fixes #1234)" at the end of the description if it closes out an existing issue (replace 1234 with the issue number). If the commit doesn't completely fix the issue, then use (refs #1234) instead of (fixes #1234).

Here are some good commit message summary examples:

Build: Update Semaphore to only test Node 0.10 (refs #734)
Fix: Semi rule incorrectly flagging extra semicolon (fixes #840)
Upgrade: Express to 13.4.2, switch to using Express comment attachment (fixes #730)