Added static Events and tests

Author: fmeheust

.github/workflows/run-tests.yaml

@@ -119,6 +119,12 @@ jobs:
           JACKSON_OSON_PASSWORD=${{ secrets.TEST_JACKSON_OSON_PASSWORD }}\n
           " >> ojdbc-provider-jackson-oson/test.properties
 
+          # Generate ojdbc-provider-observability/test.properties
+          echo -e "OBSERVABILITY_URL=${{ secrets.TEST_JACKSON_OSON_URL }}\n
+          OBSERVABILITY_USERNAME=${{ secrets.TEST_JACKSON_OSON_USERNAME }}\n
+          OBSERVABILITY_PASSWORD=${{ secrets.TEST_JACKSON_OSON_PASSWORD }}\n
+          " >> ojdbc-provider-observability/test.properties
+
       - name: Run tests with Maven
         run: mvn -B test --file pom.xml
 
@@ -133,3 +139,4 @@ jobs:
           rm ojdbc-provider-azure/test.properties
           
           rm ojdbc-provider-jackson-oson/test.properties
+          rm ojdbc-provider-observability/test.properties

ojdbc-provider-observability/example-test.properties

@@ -0,0 +1,86 @@
+################################################################################
+# Copyright (c) 2024 Oracle and/or its affiliates.
+#
+# The Universal Permissive License (UPL), Version 1.0
+#
+# Subject to the condition set forth below, permission is hereby granted to any
+# person obtaining a copy of this software, associated documentation and/or data
+# (collectively the "Software"), free of charge and under any and all copyright
+# rights in the Software, and any and all patent rights owned or freely
+# licensable by each licensor hereunder covering either (i) the unmodified
+# Software as contributed to or provided by such licensor, or (ii) the Larger
+# Works (as defined below), to deal in both
+#
+# (a) the Software, and
+# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+# one is included with the Software (each a "Larger Work" to which the Software
+# is contributed by such licensors),
+#
+# without restriction, including without limitation the rights to copy, create
+# derivative works of, display, perform, and distribute the Software and make,
+# use, sell, offer for sale, import, export, have made, and have sold the
+# Software and the Larger Work(s), and to sublicense the foregoing rights on
+# either these or other terms.
+#
+# This license is subject to the following condition:
+# The above copyright notice and either this complete permission notice or at
+# a minimum a reference to the UPL must be included in all copies or
+# substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+################################################################################
+
+# This file provides examples of properties that configure tests in this
+# module.
+#
+# QUICK GUIDE TO RUNNING TESTS:
+#   1. Create a copy of this file named "test.properties":
+#      cp example-test.properties test.properties
+#   2. In test.properties, replace example values with real values (the file is
+#      .gitignore'd, so sensitive info won't be checked in to the repo)
+#   3. Comment out any lines for which a value can not be provided (tests are
+#      skipped if no value is configured).
+#   4. mvn clean verify
+#
+# CONFIGURING TEST PROPERTIES
+#   Test properties are read from a properties file by the TestProperties class.
+#   The TestProperties class can be found in:
+#   ojdbc-provider-common/src/testFixtures/java/oracle/jdbc/provider/TestProperties.java
+#   The default behavior of TestProperties is to read a file named
+#   "test.properties" in the current directory. A non-default location may be
+#   specified as a JVM system property:
+#   mvn clean verify -Doracle.jdbc.provider.TestProperties=/path/to/my-test.properties
+#
+# MAINTAINING THIS FILE
+#   Project maintainers should add an example to this file anytime they write a
+#   test which requires a new property. Not doing so will inflict pain and
+#   suffering upon our fellow programmers, and will also lead to increased
+#   maintenance costs.
+#
+# IGNORING UNCONFIGURED PROPERTIES
+#   No test should cause a build failure due to an unconfigured property.
+#   Using JUnit terminology: A test should "abort" rather than "fail" when a
+#   property is not configured. This means that the test does not pass, but it
+#   does not cause the build to fail either.
+#   Methods of the TestProperties class will automatically abort a test if a
+#   property is not configured. The org.junit.jupiter.api.Assumptions class may
+#   also be used directly to abort a test.
+#   There is NO environment in which ALL tests can be run. Some tests may
+#   require authentication as a managed identity in an Azure VM, while other
+#   tests require authentication as an instance principal in an OCI compute
+#   instance; These environments are mutually exclusive. This is one reason why
+#   tests can not fail the build if a required property is not set.
+#   A more practical reason is that developers may not need to run all tests if
+#   their changes are isolated to single module. For instance, a developer
+#   working on an OCI provider should not need to set up an Azure tenancy to test
+#   their changes.
+
+OBSERVABILITY_URL=<url>
+OBSERVABILITY_USERNAME=<username>
+OBSERVABILITY_PASSWORD=<password>

ojdbc-provider-observability/pom.xml

@@ -39,6 +39,18 @@
         <artifactId>junit-jupiter-engine</artifactId>
         <scope>test</scope>
       </dependency>
+      <dependency>
+        <groupId>org.junit.jupiter</groupId>
+        <artifactId>junit-jupiter-params</artifactId>
+        <scope>test</scope>
+      </dependency>
+      <dependency>
+        <artifactId>ojdbc-provider-common</artifactId>
+        <groupId>com.oracle.database.jdbc</groupId>
+        <version>1.0.2</version>
+        <classifier>tests</classifier>
+        <type>test-jar</type>
+      </dependency>
     </dependencies>
 
 </project>

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/ObservabilityTraceEventListener.java

@@ -30,7 +30,7 @@ public ObservabilityTracer getTracer() {
   public Object roundTrip(Sequence sequence, TraceContext traceContext, Object userContext) {
     EnumMap<Tracers, Object> currentUserContext = getCurrentUserContext(userContext);
     for (Tracers tracer : ObservabilityConfiguration.getInstance().getEnabledTracersSet()) {
-      Object newUserContext = tracer.getTracer().traceRoudtrip(sequence, traceContext, currentUserContext.get(tracer));
+      Object newUserContext = tracer.getTracer().traceRoundtrip(sequence, traceContext, currentUserContext.get(tracer));
       currentUserContext.put(tracer, newUserContext);
     }
     return currentUserContext;

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/ObservabilityTraceEventListenerProvider.java

@@ -17,12 +17,13 @@
 import javax.management.ReflectionException;
 
 import oracle.jdbc.TraceEventListener;
+import oracle.jdbc.provider.observability.configuration.ObservabilityConfiguration;
 import oracle.jdbc.spi.TraceEventListenerProvider;
 
 public class ObservabilityTraceEventListenerProvider implements TraceEventListenerProvider {
 
   private static final String PROVIDER_NAME = "observability-trace-event-listener-provider";
-  private static final String MBEAN_OBJECT_NAME = "com.oracle.jdbc.extension.opentelemetry:type=ObservabilityTraceEventListener";
+  private static final String MBEAN_OBJECT_NAME = "com.oracle.jdbc.extension.observability:type=ObservabilityConfiguration";
 
   private static final MBeanServer server = ManagementFactory.getPlatformMBeanServer();;
   private static ObjectName objectName;
@@ -39,23 +40,13 @@ public class ObservabilityTraceEventListenerProvider implements TraceEventListen
 
   @Override
   public TraceEventListener getTraceEventListener(Map<Parameter, CharSequence> map) {
-    ObservabilityTraceEventListener observabilityBean;
     try {
-      if (objectName != null && server.isRegistered(objectName)) {
-        observabilityBean = (ObservabilityTraceEventListener) server
-            .instantiate(ObservabilityTraceEventListener.class.getName());
-        return observabilityBean;
-      }
-    } catch (ReflectionException | MBeanException e) {
-      logger.log(Level.WARNING, "Could not retrieve MBean from server", e);
-    }
-    observabilityBean = new ObservabilityTraceEventListener();
-    try {
-      server.registerMBean(observabilityBean, objectName);
+      if (!server.isRegistered(objectName))
+      server.registerMBean(ObservabilityConfiguration.getInstance(), objectName);
     } catch (InstanceAlreadyExistsException | MBeanRegistrationException | NotCompliantMBeanException e) {
       logger.log(Level.WARNING, "Could not register MBean", e);
     }
-    return observabilityBean;
+    return new ObservabilityTraceEventListener();
   }
 
   @Override

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/OpenTelemetryTraceEventListenerProvider.java

@@ -0,0 +1,20 @@
+package oracle.jdbc.provider.observability;
+
+import java.util.Collection;
+import java.util.Collections;
+
+public class OpenTelemetryTraceEventListenerProvider extends ObservabilityTraceEventListenerProvider {
+
+  private static final String PROVIDER_NAME = "open-telemetry-trace-event-listener-provider";
+
+  @Override
+  public String getName() {
+    return PROVIDER_NAME;
+  }
+
+  @Override
+  public Collection<? extends Parameter> getParameters() {
+    return Collections.emptyList();
+  }
+
+}

ojdbc-provider-observability/src/main/java/oracle/jdbc/provider/observability/configuration/ObservabilityConfiguration.java

@@ -8,16 +8,22 @@
 
 public class ObservabilityConfiguration implements ObservabilityConfigurationMBean {
 
-  private final ReentrantLock observabilityConfiguraitonLock = new ReentrantLock();
+  private static final ReentrantLock observabilityConfiguraitonLock = new ReentrantLock();
 
-  private static final ObservabilityConfiguration INSTANCE = new ObservabilityConfiguration();
+  private static final ObservabilityConfiguration INSTANCE;
+
+  static {
+    INSTANCE = new ObservabilityConfiguration();
+    //INSTANCE.setSensitiveDataEnabled(true);
+    INSTANCE.setEnabledTracers(System.getProperty("oracle.jdbc.provider.observability.tracer", "OTEL,JFR"));
+  }
 
   private ObservabilityConfiguration() {  }
 
   private boolean sensitiveDataEnabled;
   private String tracers;
 
-  private EnumSet<ObservabilityTraceEventListener.Tracers> enabledTracers;
+  private EnumSet<ObservabilityTraceEventListener.Tracers> enabledTracers = EnumSet.noneOf(ObservabilityTraceEventListener.Tracers.class);
 
   @Override
   public String getEnabledTracers() {
@@ -32,6 +38,7 @@ public String getEnabledTracers() {
   @Override
   public void setEnabledTracers(String tracers) {
     try {
+      observabilityConfiguraitonLock.lock();
       enabledTracers.clear();
       String[] items = tracers.split(",");
       for (String item : items) {
@@ -61,7 +68,11 @@ public static ObservabilityConfiguration getInstance() {
   }
 
   public EnumSet<ObservabilityTraceEventListener.Tracers> getEnabledTracersSet() {
-    return enabledTracers.clone();
+    if (enabledTracers != null) {
+      return enabledTracers.clone();
+    } else {
+      return null;
+    }
   }
 
 }