Build OpenTelemetry C++ SDK and exporter into DLL

.gitignore

@@ -16,6 +16,7 @@
 *.so
 *.dylib
 *.dll
+*.pdb
 
 # Fortran module files
 *.mod

CMakeLists.txt

@@ -513,6 +513,13 @@ endif()
 
 include(CMakePackageConfigHelpers)
 
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  if(NOT MSVC)
+    message(WARNING "Build DLL is supposed to work with MSVC")
+  endif()
+  add_definitions(-DOPENTELEMETRY_BUILD_EXPORT_DLL)
+endif()
+
 include_directories(api/include)
 
 add_subdirectory(api)

api/include/opentelemetry/baggage/baggage.h

@@ -16,7 +16,7 @@ OPENTELEMETRY_BEGIN_NAMESPACE
 namespace baggage
 {
 
-class Baggage
+class OPENTELEMETRY_API Baggage
 {
 public:
   static constexpr size_t kMaxKeyValuePairs = 180;

api/include/opentelemetry/common/key_value_iterable.h

@@ -13,7 +13,7 @@ namespace common
 /**
  * Supports internal iteration over a collection of key-value pairs.
  */
-class KeyValueIterable
+class OPENTELEMETRY_API KeyValueIterable
 {
 public:
   virtual ~KeyValueIterable() = default;

api/include/opentelemetry/common/key_value_iterable_view.h

@@ -47,7 +47,7 @@ struct is_key_value_iterable
  * 'non-standard' type to one of the standard types.
  */
 template <class T>
-class KeyValueIterableView final : public KeyValueIterable
+class OPENTELEMETRY_API KeyValueIterableView final : public KeyValueIterable
 {
 
 public:

api/include/opentelemetry/common/kv_properties.h

@@ -28,7 +28,7 @@ struct KeyValueStringTokenizerOptions
 };
 
 // Tokenizer for key-value headers
-class KeyValueStringTokenizer
+class OPENTELEMETRY_API KeyValueStringTokenizer
 {
 public:
   KeyValueStringTokenizer(
@@ -134,7 +134,7 @@ class KeyValueStringTokenizer
 };
 
 // Class to store fixed size array of key-value pairs of string type
-class KeyValueProperties
+class OPENTELEMETRY_API KeyValueProperties
 {
   // Class to store key-value pairs of string types
 public:

api/include/opentelemetry/common/macros.h

@@ -175,3 +175,24 @@ point.
 #  define OPENTELEMETRY_API_SINGLETON
 
 #endif
+
+//
+// The if/elif order matters here. If both OPENTELEMETRY_BUILD_IMPORT_DLL and
+// OPENTELEMETRY_BUILD_EXPORT_DLL are defined, the former takes precedence.
+//
+#if defined(_MSC_VER) && defined(OPENTELEMETRY_BUILD_IMPORT_DLL)
+
+#  define OPENTELEMETRY_API __declspec(dllimport)
+
+#elif defined(_MSC_VER) && defined(OPENTELEMETRY_BUILD_EXPORT_DLL)
+
+#  define OPENTELEMETRY_API __declspec(dllexport)
+
+#else
+
+//
+// build OpenTelemetry as static library or not on Windows.
+//
+#  define OPENTELEMETRY_API
+
+#endif

api/include/opentelemetry/common/timestamp.h

@@ -17,7 +17,7 @@ namespace common
  *
  * This is used for marking the beginning and end of an operation.
  */
-class SystemTimestamp
+class OPENTELEMETRY_API SystemTimestamp
 {
 public:
   /**

api/include/opentelemetry/context/propagation/global_propagator.h

@@ -22,7 +22,7 @@ namespace propagation
 
 /* Stores the singleton TextMapPropagator */
 
-class GlobalTextMapPropagator
+class OPENTELEMETRY_API GlobalTextMapPropagator
 {
 public:
   static nostd::shared_ptr<TextMapPropagator> GetGlobalPropagator() noexcept

api/include/opentelemetry/context/runtime_context.h

@@ -37,7 +37,7 @@ class Token
  * this class and passing an initialized RuntimeContextStorage object to
  * RuntimeContext::SetRuntimeContextStorage.
  */
-class RuntimeContextStorage
+class OPENTELEMETRY_API RuntimeContextStorage
 {
 public:
   /**
@@ -78,7 +78,7 @@ static RuntimeContextStorage *GetDefaultStorage() noexcept;
 // Provides a wrapper for propagating the context object globally.
 //
 // By default, a thread-local runtime context storage is used.
-class RuntimeContext
+class OPENTELEMETRY_API RuntimeContext
 {
 public:
   // Return the current context.

api/include/opentelemetry/trace/noop.h

@@ -27,7 +27,7 @@ namespace trace
 /**
  * No-op implementation of Span. This class should not be used directly.
  */
-class NoopSpan final : public Span
+class OPENTELEMETRY_API NoopSpan final : public Span
 {
 public:
   explicit NoopSpan(const std::shared_ptr<Tracer> &tracer) noexcept
@@ -76,7 +76,8 @@ class NoopSpan final : public Span
 /**
  * No-op implementation of Tracer.
  */
-class NoopTracer final : public Tracer, public std::enable_shared_from_this<NoopTracer>
+class OPENTELEMETRY_API NoopTracer final : public Tracer,
+                                           public std::enable_shared_from_this<NoopTracer>
 {
 public:
   // Tracer
@@ -101,7 +102,7 @@ class NoopTracer final : public Tracer, public std::enable_shared_from_this<Noop
 /**
  * No-op implementation of a TracerProvider.
  */
-class NoopTracerProvider final : public opentelemetry::trace::TracerProvider
+class OPENTELEMETRY_API NoopTracerProvider final : public opentelemetry::trace::TracerProvider
 {
 public:
   NoopTracerProvider() noexcept

api/include/opentelemetry/trace/provider.h

@@ -17,7 +17,7 @@ namespace trace
 /**
  * Stores the singleton global TracerProvider.
  */
-class Provider
+class OPENTELEMETRY_API Provider
 {
 public:
   /**

api/include/opentelemetry/trace/trace_state.h

@@ -29,7 +29,7 @@ namespace trace
  * For more information, see the W3C Trace Context specification:
  * https://www.w3.org/TR/trace-context
  */
-class TraceState
+class OPENTELEMETRY_API TraceState
 {
 public:
   static constexpr int kKeyMaxSize         = 256;

api/include/opentelemetry/trace/tracer_provider.h

@@ -13,7 +13,7 @@ namespace trace
 /**
  * Creates new Tracer instances.
  */
-class TracerProvider
+class OPENTELEMETRY_API TracerProvider
 {
 public:
   virtual ~TracerProvider() = default;

examples/common/foo_library/CMakeLists.txt

@@ -1,3 +1,7 @@
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  add_definitions(-DOPENTELEMETRY_BUILD_IMPORT_DLL)
+endif()
+
 add_library(common_foo_library foo_library.h foo_library.cc)
 target_link_libraries(common_foo_library PUBLIC ${CMAKE_THREAD_LIBS_INIT}
                                                 opentelemetry_api)

examples/common/logs_foo_library/CMakeLists.txt

@@ -1,3 +1,7 @@
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  add_definitions(-DOPENTELEMETRY_BUILD_IMPORT_DLL)
+endif()
+
 add_library(common_logs_foo_library foo_library.h foo_library.cc)
 target_link_libraries(common_logs_foo_library PUBLIC ${CMAKE_THREAD_LIBS_INIT}
                                                      opentelemetry_api)

examples/otlp/CMakeLists.txt

@@ -1,43 +1,69 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  add_definitions(-DOPENTELEMETRY_BUILD_IMPORT_DLL)
+endif()
+
 include_directories(
   ${CMAKE_BINARY_DIR}/generated/third_party/opentelemetry-proto
   ${CMAKE_SOURCE_DIR}/exporters/otlp/include)
 
 if(WITH_OTLP_GRPC)
   add_executable(example_otlp_grpc grpc_main.cc)
-  target_link_libraries(
-    example_otlp_grpc ${CMAKE_THREAD_LIBS_INIT} common_foo_library
-    opentelemetry_trace opentelemetry_exporter_otlp_grpc)
+
+  target_link_libraries(example_otlp_grpc ${CMAKE_THREAD_LIBS_INIT}
+                        common_foo_library)
+
+  if(DEFINED OPENTELEMETRY_BUILD_DLL)
+    target_link_libraries(example_otlp_grpc opentelemetry_cpp)
+  else()
+    target_link_libraries(example_otlp_grpc opentelemetry_trace
+                          opentelemetry_exporter_otlp_grpc)
+  endif()
   if(WITH_LOGS_PREVIEW)
     add_executable(example_otlp_grpc_log grpc_log_main.cc)
-    target_link_libraries(
-      example_otlp_grpc_log
-      ${CMAKE_THREAD_LIBS_INIT}
-      common_logs_foo_library
-      opentelemetry_trace
-      opentelemetry_logs
-      opentelemetry_exporter_otlp_grpc
-      opentelemetry_exporter_otlp_grpc_log)
+
+    target_link_libraries(example_otlp_grpc_log ${CMAKE_THREAD_LIBS_INIT}
+                          common_logs_foo_library)
+    if(DEFINED OPENTELEMETRY_BUILD_DLL)
+      target_link_libraries(example_otlp_grpc_log opentelemetry_cpp)
+    else()
+      target_link_libraries(
+        example_otlp_grpc_log opentelemetry_trace opentelemetry_logs
+        opentelemetry_exporter_otlp_grpc opentelemetry_exporter_otlp_grpc_log)
+    endif()
   endif()
 endif()
 
 if(WITH_OTLP_HTTP)
   add_executable(example_otlp_http http_main.cc)
-  target_link_libraries(
-    example_otlp_http ${CMAKE_THREAD_LIBS_INIT} common_foo_library
-    opentelemetry_trace opentelemetry_exporter_otlp_http)
+
+  target_link_libraries(example_otlp_http ${CMAKE_THREAD_LIBS_INIT}
+                        common_foo_library)
+  if(DEFINED OPENTELEMETRY_BUILD_DLL)
+    target_link_libraries(example_otlp_http opentelemetry_cpp
+                          opentelemetry_common)
+  else()
+    target_link_libraries(example_otlp_http opentelemetry_trace
+                          opentelemetry_exporter_otlp_http)
+  endif()
+
   if(WITH_LOGS_PREVIEW)
     add_executable(example_otlp_http_log http_log_main.cc)
-    target_link_libraries(
-      example_otlp_http_log
-      ${CMAKE_THREAD_LIBS_INIT}
-      common_logs_foo_library
-      opentelemetry_trace
-      opentelemetry_logs
-      opentelemetry_exporter_otlp_http
-      opentelemetry_exporter_otlp_http_log)
+    target_link_libraries(example_otlp_http_log ${CMAKE_THREAD_LIBS_INIT}
+                          common_logs_foo_library)
+
+    if(DEFINED OPENTELEMETRY_BUILD_DLL)
+      target_link_libraries(example_otlp_http_log opentelemetry_cpp
+                            opentelemetry_common)
+    else()
+      target_link_libraries(
+        example_otlp_http_log common_logs_foo_library opentelemetry_trace
+        opentelemetry_logs opentelemetry_exporter_otlp_http
+        opentelemetry_exporter_otlp_http_log)
+    endif()
+
   endif()
 endif()
 

examples/simple/CMakeLists.txt

@@ -1,6 +1,16 @@
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  add_definitions(-DOPENTELEMETRY_BUILD_IMPORT_DLL)
+endif()
+
 include_directories(${CMAKE_SOURCE_DIR}/exporters/ostream/include)
 
 add_executable(example_simple main.cc)
-target_link_libraries(
-  example_simple ${CMAKE_THREAD_LIBS_INIT} common_foo_library
-  opentelemetry_trace opentelemetry_exporter_ostream_span)
+target_link_libraries(example_simple ${CMAKE_THREAD_LIBS_INIT}
+                      common_foo_library)
+
+if(DEFINED OPENTELEMETRY_BUILD_DLL)
+  target_link_libraries(example_simple opentelemetry_cpp)
+else()
+  target_link_libraries(example_simple opentelemetry_trace
+                        opentelemetry_exporter_ostream_span)
+endif()

exporters/ostream/include/opentelemetry/exporters/ostream/span_exporter_factory.h

@@ -25,7 +25,7 @@ namespace trace
 /**
  * Factory class for OStreamSpanExporter.
  */
-class OStreamSpanExporterFactory
+class OPENTELEMETRY_API OStreamSpanExporterFactory
 {
 public:
   /**

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_exporter_factory.h

@@ -17,7 +17,7 @@ namespace otlp
 /**
  * Factory class for OtlpGrpcExporter.
  */
-class OtlpGrpcExporterFactory
+class OPENTELEMETRY_API OtlpGrpcExporterFactory
 {
 public:
   /**

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter_factory.h

@@ -17,7 +17,7 @@ namespace otlp
 /**
  * Factory class for OtlpGrpcLogRecordExporter.
  */
-class OtlpGrpcLogRecordExporterFactory
+class OPENTELEMETRY_API OtlpGrpcLogRecordExporterFactory
 {
 public:
   /**

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_http_exporter_factory.h

@@ -17,7 +17,7 @@ namespace otlp
 /**
  * Factory class for OtlpHttpExporter.
  */
-class OtlpHttpExporterFactory
+class OPENTELEMETRY_API OtlpHttpExporterFactory
 {
 public:
   /**

exporters/otlp/include/opentelemetry/exporters/otlp/otlp_http_log_record_exporter_factory.h

@@ -18,7 +18,7 @@ namespace otlp
 /**
  * Factory class for OtlpHttpLogRecordExporter.
  */
-class OtlpHttpLogRecordExporterFactory
+class OPENTELEMETRY_API OtlpHttpLogRecordExporterFactory
 {
 public:
   /**

ext/src/CMakeLists.txt

@@ -8,3 +8,7 @@ endif()
 if(WITH_HTTP_CLIENT_CURL)
   add_subdirectory(http/client/curl)
 endif()
+
+if(MSVC AND DEFINED OPENTELEMETRY_BUILD_DLL)
+  add_subdirectory(dll)
+endif()

ext/src/dll/CMakeLists.txt

@@ -0,0 +1,21 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+add_library(opentelemetry_cpp SHARED dllmain.cc opentelemetry_cpp.def)
+
+target_link_libraries(
+  opentelemetry_cpp
+  PRIVATE opentelemetry_trace
+          opentelemetry_exporter_ostream_span
+          opentelemetry_exporter_otlp_grpc
+          opentelemetry_exporter_otlp_http
+          opentelemetry_exporter_otlp_http_log
+          opentelemetry_logs
+          opentelemetry_exporter_otlp_grpc_log)
+
+install(
+  TARGETS opentelemetry_cpp
+  EXPORT "${PROJECT_NAME}-target"
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})