This module provides automatic instrumentation for the oracledb
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-oracledb
oracledb
versions >=6.7.0 <7
OpenTelemetry OracleInstrumentation 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 oracledb. This module works with both Thin and Thick modes of the oracledb package, although there may be some caveats with Thick Mode now, which are listed in a later paragraph.
To load a specific plugin (OracleInstrumentation in this case), specify it in the configuration of the registerInstrumentations object.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node'); const { OracleInstrumentation } = require('@opentelemetry/instrumentation-oracledb'); const { registerInstrumentations } = require('@opentelemetry/instrumentation'); const provider = new NodeTracerProvider(); provider.register(); registerInstrumentations({ instrumentations: [ new OracleInstrumentation(), ], })
Caveats with oracledb
Thick mode:
enhancedDatabaseReporting
boolean
false
If true, details about the sql statement's bind values (being set on parameters db.operation.parameter.<key>
) and the sql string (being set on parameter db.query.text
) will be attached to the spans generated dbStatementDump
boolean
false
If true, db.query.text
will contain the sql string in the spans generated requestHook
OracleInstrumentationExecutionRequestHook
(function) Function for adding custom span attributes using information about the data for the sql statement being executed responseHook
OracleInstrumentationExecutionResponseHook
(function) Function for adding custom span attributes from the db response requireParentSpan
boolean
false
If true, requires a parent span to create new spans
Apache 2.0 - See LICENSE for more information.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4