Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@opentelemetry/instrumentation-pg
Advanced tools
OpenTelemetry postgres automatic instrumentation package.
@opentelemetry/instrumentation-pg is an npm package that provides automatic instrumentation for the 'pg' (node-postgres) module, enabling the collection of telemetry data such as traces and metrics for PostgreSQL database operations. This helps in monitoring and debugging database interactions in applications.
Automatic Tracing
This feature allows automatic tracing of PostgreSQL operations. The code sample demonstrates how to set up the NodeTracerProvider and register the PgInstrumentation to start collecting trace data.
const { NodeTracerProvider } = require('@opentelemetry/node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { PgInstrumentation } = require('@opentelemetry/instrumentation-pg');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new PgInstrumentation(),
],
tracerProvider: provider,
});
Custom Span Attributes
This feature allows adding custom attributes to spans. The code sample shows how to configure the PgInstrumentation to include additional information such as the number of rows returned in the response.
const { PgInstrumentation } = require('@opentelemetry/instrumentation-pg');
const pgInstrumentation = new PgInstrumentation({
enhancedDatabaseReporting: true,
responseHook: (span, responseInfo) => {
span.setAttribute('db.response.rows', responseInfo.rowCount);
},
});
Error Handling
This feature allows capturing and reporting errors in database operations. The code sample demonstrates how to set the span status to error if an error occurs during the database operation.
const { PgInstrumentation } = require('@opentelemetry/instrumentation-pg');
const pgInstrumentation = new PgInstrumentation({
responseHook: (span, responseInfo) => {
if (responseInfo.error) {
span.setStatus({ code: 2, message: responseInfo.error.message });
}
},
});
@opentelemetry/instrumentation-mysql provides similar functionality for MySQL databases. It allows automatic tracing and collection of telemetry data for MySQL operations, enabling monitoring and debugging of database interactions.
@opentelemetry/instrumentation-mongodb offers similar capabilities for MongoDB databases. It provides automatic instrumentation for MongoDB operations, helping in the collection of trace data and metrics for monitoring and debugging purposes.
This module provides automatic instrumentation for the pg
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+
.
npm install --save @opentelemetry/instrumentation-pg
>=8 <9
const { PgInstrumentation } = require('@opentelemetry/instrumentation-pg');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new PgInstrumentation(),
],
});
PgInstrumentation contains both pg and pg.Pool
so it will be instrumented automatically.
See examples/postgres for a short example.
PostgreSQL instrumentation has few options available to choose from. You can set the following:
Options | Type | Description |
---|---|---|
enhancedDatabaseReporting | boolean | If true, additional information about query parameters and results will be attached (as attributes ) to spans representing database operations |
requestHook | PgInstrumentationExecutionRequestHook (function) | Function for adding custom span attributes using information about the query being issued and the db to which it's directed |
responseHook | PgInstrumentationExecutionResponseHook (function) | Function for adding custom span attributes from db response |
requireParentSpan | boolean | If true, requires a parent span to create new spans (default false) |
addSqlCommenterCommentToQueries | boolean | If true, adds sqlcommenter specification compliant comment to queries with tracing context (default false). NOTE: A comment will not be added to queries that already contain -- or /* ... */ in them, even if these are not actually part of comments |
Apache 2.0 - See LICENSE for more information.
FAQs
OpenTelemetry instrumentation for `pg` and `pg-pool` database client for PostgreSQL
We found that @opentelemetry/instrumentation-pg demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
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.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.