Skip to content

Commit fb20779

Browse files
authored
Updated readme file (#144)
1 parent e2982af commit fb20779

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

ojdbc-provider-opentelemetry/README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,18 @@ oracle.jdbc.provider.traceEventListener=open-telemetry-trace-event-listener-prov
5959

6060
## Configuration
6161

62-
A MBean with object name "com.oracle.jdbc.extension.opentelemetry:type=OpenTelemetryTraceEventListener"
63-
is registered by the provider. It exposes two attributes that allows the configuration
64-
of the TraceEventListener. The following attributes are available :
62+
The Oracle JDBC provider for Open Telemetry can be configured using system properties
63+
or a MBean. Two parameters can be configured:
6564
* **Enabled**: when enabled (*true*) traces will be exported to Open
66-
Telemetry. This attribute is **enabled by default**.
67-
* **SensitiveDataEnabled**: when enabled (*true*) attributes containing
65+
Telemetry. This property is **enabled by default**.
66+
* **Sensitive data enabled**: when enabled (*true*) attributes containing
6867
sensitive information like SQL statements and connection URL will be included
69-
in the traces. This attribute is **disabled by default**.
68+
in the traces. This property is **disabled by default**.
69+
70+
The system properties are "oracle.jdbc.provider.opentelemetry.enabled" and
71+
"oracle.jdbc.provider.opentelemetry.sensitive-enabled" respectively and the MBean
72+
with object name "com.oracle.jdbc.extension.opentelemetry:type=OpenTelemetryTraceEventListener"
73+
exposes two attributes "Enabled" and "SensitiveDataEnabled".
7074

7175
The sample code below shows how to retrieve the value of an attribute:
7276
```java

0 commit comments

Comments
 (0)