OTel: Do not include on non-Linux platforms.

Also refactor to use telemetry::Telemetry<X> object that is always present but does nothing if telemetry is not supported.

Author: rsomla1

cdk/cmake/dependency.cmake

@@ -129,7 +129,7 @@ function(add_ext NAME HEADER)
   )
 
 
-  show_config_options()
+  #show_config_options()
 
   # Handle non-path value of WITH_X option
 

jdbc/CMakeLists.txt

@@ -148,7 +148,17 @@ endif()
 
 
 find_dependency(MySQL)
-find_dependency(Otel)
+
+add_library(otel_api INTERFACE)
+# Note: For now make it phony target on platforms other than Linux
+if(NOT (WIN32 OR APPLE OR CMAKE_SYSTEM_NAME MATCHES "SunOS"))
+  message(STATUS "Adding OTel support")
+  set(TELEMETRY ON)
+  target_include_directories(otel_api INTERFACE 
+    "${PROJECT_SOURCE_DIR}/extra/otel/opentelemetry-cpp-1.8.3/api/include"
+  )
+  target_compile_definitions(otel_api INTERFACE TELEMETRY)
+endif()
 
 
 #-----------------

jdbc/cmake/DepFindOtel.cmake

@@ -109,7 +109,6 @@ SET(MYSQLCPPCONN_SOURCES
   mysql_resultset.cpp
   mysql_resultset_metadata.cpp
   mysql_statement.cpp
-  mysql_telemetry.cpp
   mysql_util.cpp
   mysql_warning.cpp
   mysql_uri.cpp
@@ -121,6 +120,10 @@ SET(MYSQLCPPCONN_SOURCES
   nativeapi/mysql_native_resultset_wrapper.cpp
 )
 
+if(TELEMETRY)
+  list(APPEND MYSQLCPPCONN_SOURCES  mysql_telemetry.cpp)
+endif()
+
 
 IF(WIN32)
 # adding headers to sources, so they will be included to VS projects
@@ -144,7 +147,6 @@ IF(WIN32)
     mysql_resultset.h
     mysql_resultset_metadata.h
     mysql_statement.h
-    mysql_telemetry.h
     mysql_util.h
     mysql_warning.h
     mysql_uri.h
@@ -180,6 +182,10 @@ IF(WIN32)
         nativeapi/library_loader.h)
   ENDIF(NOT MYSQLCLIENT_STATIC_BINDING)
 
+  if(TELEMETRY)
+    list(APPEND MYSQLCPPCONN_SOURCES  mysql_telemetry.h)
+  endif()
+
   # Used to create source filter in projects in VS
   SOURCE_GROUP(NativeApi nativeapi/.+)
   SOURCE_GROUP(API ../cppconn/.+)
@@ -207,7 +213,7 @@ else()
   ENDIF(NOT WIN32)
 endif()
 
-target_link_libraries(jdbc PRIVATE ext::opentelemetry_api)
+target_link_libraries(jdbc PRIVATE otel_api)
 
 if(NOT BUILD_SHARED_LIBS)
   target_compile_definitions(jdbc PRIVATE -DCPPCONN_LIB_BUILD)

jdbc/driver/CMakeLists.txt

@@ -538,6 +538,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 
   sql::ConnectOptionsMap::const_iterator it;
 
+#ifdef TELEMETRY
   // TODO: Use these helpers to reduce code repetition.
 
   auto get_option_i = [&properties, &p_i](std::string name, bool check = true) 
@@ -601,6 +602,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
       };
     }
   };
+#endif
 #endif
 
   /* Port from options must be set as default for all hosts where port
@@ -694,6 +696,17 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
     not work, we try bool value.
   */
 
+#ifndef TELEMETRY
+
+  if (properties.count(OPT_OPENTELEMETRY))
+  {
+    throw sql::SQLException{
+      "Option OPT_OPENTELEMETRY not yet supported on this platform."
+    };
+  }
+
+#else
+
   try {
     if (get_option_i(OPT_OPENTELEMETRY))
     {
@@ -709,7 +722,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
         };
       };
 
-      intern->telemetryMode = (enum_opentelemetry_mode)*p_i;
+      intern->telemetry.set_mode((enum_opentelemetry_mode)*p_i);
     }
   }
   catch(const sql::InvalidArgumentException&)
@@ -721,7 +734,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
         throw sql::InvalidArgumentException{
           "OPT_OPENTELEMETRY can only be set to FALSE"
         };
-      intern->telemetryMode = OTEL_DISABLED;
+      intern->telemetry.set_mode(OTEL_DISABLED);
     }
     catch(const sql::InvalidArgumentException&)
     {
@@ -732,6 +745,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
     }
   }
 
+#endif
 
 #define PROCESS_CONN_OPTION(option_type, options_map) \
   process_connection_option< option_type >(it, options_map, sizeof(options_map)/sizeof(String2IntMap), proxy)
@@ -1304,10 +1318,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
 
   CPP_INFO_FMT("OPT_DNS_SRV=%d", opt_dns_srv);
 
-  if (!telemetry_disabled())
-  {
-    intern->trace_span = telemetry::mk_span(this);
-  }
+  intern->telemetry.span_start(this);
 
   try
   {
@@ -1564,7 +1575,7 @@ void MySQL_Connection::init(ConnectOptionsMap & properties)
   }
   catch(sql::SQLException &e)
   {
-    telemetry::set_error(intern->trace_span, e.what());
+    intern->telemetry.set_error(this, e.what());
     throw;
   }
 }
@@ -1782,12 +1793,6 @@ MySQL_Connection::getTransactionIsolation()
 /* }}} */
 
 
-bool MySQL_Connection::telemetry_disabled() const
-{
-  return !intern || (OTEL_DISABLED == intern->telemetryMode);
-}
-
-
 /* {{{ MySQL_Connection::getWarnings() -I- */
 const SQLWarning *
 MySQL_Connection::getWarnings()

jdbc/driver/mysql_connection.cpp

@@ -206,8 +206,6 @@ class CPPCONN_PUBLIC_FUNC MySQL_Connection : public sql::Connection
 #pragma warning(pop)
 #endif
 
-  bool telemetry_disabled() const;
-
   /* Prevent use of these */
   MySQL_Connection(const MySQL_Connection &);
   void operator=(MySQL_Connection &);

jdbc/driver/mysql_connection.h

@@ -89,8 +89,7 @@ struct MySQL_ConnectionData
 
   std::unique_ptr<MySQL_ConnectionMetaData> meta;
 
-  enum_opentelemetry_mode telemetryMode = OTEL_PREFERRED;
-  telemetry::Span_ptr trace_span;
+  telemetry::Telemetry<MySQL_Connection> telemetry;
 };
 
 } /* namespace mysql */

jdbc/driver/mysql_connection_data.h

@@ -34,6 +34,7 @@
 #include <algorithm>
 #include <sstream>
 #include <cstring>
+#include <cassert>
 
 
 /*
@@ -105,10 +106,7 @@ MySQL_Statement::do_query(const ::sql::SQLString &q)
     throw sql::InvalidInstanceException("Connection has been closed");
   }
 
-  if (!connection->telemetry_disabled())
-  {
-    trace_span = telemetry::mk_span(this);
-  }
+  telemetry.span_start(this);
 
   try 
   {
@@ -125,7 +123,7 @@ MySQL_Statement::do_query(const ::sql::SQLString &q)
   }
   catch(sql::SQLException &e)
   {
-    telemetry::set_error(trace_span, e.what());
+    telemetry.set_error(this, e.what());
     throw;
   }
 
@@ -134,11 +132,11 @@ MySQL_Statement::do_query(const ::sql::SQLString &q)
 }
 /* }}} */
 
-
-telemetry::Span_ptr
-MySQL_Statement::get_conn_span()
+telemetry::Telemetry<MySQL_Connection>&
+MySQL_Statement::conn_telemetry()
 {
-  return connection->intern->trace_span;
+  assert(connection && connection->intern);
+  return connection->intern->telemetry;
 }
 
 

jdbc/driver/mysql_statement.cpp

@@ -59,8 +59,6 @@ class NativeConnectionWrapper;
 
 class MySQL_Statement : public sql::Statement
 {
-  friend telemetry::Span_ptr telemetry::mk_span(MySQL_Statement*);
-
 protected:
  std::unique_ptr<MySQL_Warning> warnings;
  MySQL_Connection *connection;
@@ -80,12 +78,15 @@ class MySQL_Statement : public sql::Statement
 
  unsigned int warningsCount;
 
- telemetry::Span_ptr trace_span;
-
  virtual std::shared_ptr<NativeAPI::NativeResultsetWrapper> get_resultset();
  virtual void checkClosed();
 
- telemetry::Span_ptr get_conn_span();
+ telemetry::Telemetry<MySQL_Statement> telemetry;
+
+ // Get connection's telemetry object.
+ telemetry::Telemetry<MySQL_Connection>& conn_telemetry();
+
+ friend telemetry::Telemetry_base<MySQL_Statement>;
 
 public:
  MySQL_Statement(MySQL_Connection *conn,