Skip to content

Latest commit

 

History

History
78 lines (66 loc) · 2.88 KB

README.md

File metadata and controls

78 lines (66 loc) · 2.88 KB
Raw

Oracle JDBC Open Telemetry Provider

This module contains a provider for integration between Oracle JDBC and Open Telemetry.

This provider implements the TraceEventListener interface provided by the JDBC driver which will be notified whenever events are generated in the driver and will publish these events into Open Telemetry. These events include:

  • roundtrips to the database server
  • AC begin and sucess
  • VIP down event

The following attributes are added the the traces for each event:

  • Roundtrips
    • Connection ID
    • Database Operation
    • Database User
    • Database Tenant
    • SQL ID
    • Original SQL Text (only present if sensitive data is enabled)
    • Actual SQL Text (only present if sensitive data is enabled)
  • AC begin and success
    • Error Message
    • Error code
    • SQL state
    • Current replay retry count
  • VIP down event
    • Error message
    • VIP address
    • Protocol (only present if sensitive data is enabled)
    • Host (only present if sensitive data is enabled)
    • Port (only present if sensitive data is enabled)
    • Service name (only present if sensitive data is enabled)
    • SID (only present if sensitive data is enabled)
    • Connection data (only present if sensitive data is enabled)

Installation

This provider is distributed as single jar on the Maven Central Repository. The jar is compiled for JDK 8, and is forward compatible with later JDK versions. The coordinates for the latest release are:

<dependency>
  <groupId>com.oracle.database.jdbc</groupId>
  <artifactId>ojdbc-provider-opentelemetry</artifactId>
  <version>1.0.0</version>
</dependency>

Usage

To use the Oracle JDBC provider for Open Telemetry just add the artifact to the application's classpath and set the following connection property :

oracle.jdbc.provider.traceEventListener=open-telemetry-trace-event-listener-provider

Configuration

A MBean with object name "com.oracle.jdbc.extension.opentelemetry:type=OpenTelemetryTraceEventListener" is registered by the provider. It exposes two attributes that allows the configuration of the TraceEventListener. The following attributes are available :

  • Enabled: when enabled (true) traces will be exported to Open Telemetry. This attribute is enabled by default.
  • SensitiveDataEnabled: when enabled (true) attributes containing sensitive information like SQL statements and connection URL will be included in the traces. This attribute is disabled by default.

The sample code below shows how to retrieve the value of an attribute:

ObjectName objectName = new ObjectName(
    "com.oracle.jdbc.extension.opentelemetry:type=OpenTelemetryTraceEventListener");
MBeanServer server = ManagementFactory.getPlatformMBeanServer();
boolean isEnabled = Boolean.valueOf(server.getAttribute(objectName, "Enabled").toString())
    .booleanValue();