Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme file #144

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Updated readme file #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions ojdbc-provider-opentelemetry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,18 @@ oracle.jdbc.provider.traceEventListener=open-telemetry-trace-event-listener-prov

## 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 :
The Oracle JDBC provider for Open Telemetry can be configured using system properties
or a MBean. Two parameters can be configured:
* **Enabled**: when enabled (*true*) traces will be exported to Open
Telemetry. This attribute is **enabled by default**.
* **SensitiveDataEnabled**: when enabled (*true*) attributes containing
Telemetry. This property is **enabled by default**.
* **Sensitive data enabled**: 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**.
in the traces. This property is **disabled by default**.

The system properties are "oracle.jdbc.provider.opentelemetry.enabled" and
"oracle.jdbc.provider.opentelemetry.sensitive-enabled" respectively and the MBean
with object name "com.oracle.jdbc.extension.opentelemetry:type=OpenTelemetryTraceEventListener"
exposes two attributes "Enabled" and "SensitiveDataEnabled".

The sample code below shows how to retrieve the value of an attribute:
```java
Expand Down
Loading