Use a standalone flag to switch deprecated LogRecord APIs

owent · owent · commit 8459290adf36 · 2025-05-20T12:06:55.000+08:00
Fixes GetBody::ReadWriteLogRecord
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -63,13 +63,15 @@ Important changes:
 * [SDK] Fix lifetime for sdk::ReadWriteLogRecord
   [#3147](https://github.com/open-telemetry/opentelemetry-cpp/pull/3245)
 
-  * With ABI version 2, `opentelemetry::sdk::logs::ReadableLogRecord::GetAttributes()`
+  * `opentelemetry::sdk::logs::ReadableLogRecord::GetAttributes()`
     will returns a `std::unordered_map<std::string, opentelemetry::sdk::common::OwnedAttributeValue>`
     instead of a `std::unordered_map<std::string, opentelemetry::common::AttributeValue>`
     to keep the same type as the `opentelemetry::sdk::trace::SpanData`. And
     `opentelemetry::sdk::logs::ReadableLogRecord::GetBody()` will returns a
     `const opentelemetry::sdk::common::OwnedAttributeValue &` instead of a
-    `const opentelemetry::common::AttributeValue &`.
+    `const opentelemetry::common::AttributeValue &` now, we switch to the old
+    APIs by add `-DWITH_DEPRECATED_SDK_LOG_RECORD=ON` for cmake or add
+    `--copt -DOPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD` for bazel.
 
 ## [1.20 2025-04-01]
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -185,6 +185,13 @@ message(STATUS "OPENTELEMETRY_VERSION=${OPENTELEMETRY_VERSION}")
 
 option(WITH_NO_DEPRECATED_CODE "Do not include deprecated code" OFF)
 
+option(WITH_DEPRECATED_SDK_LOG_RECORD "Use deprecated SDK log record" OFF)
+
+if(WITH_DEPRECATED_SDK_LOG_RECORD)
+  message(
+    WARNING "WITH_DEPRECATED_SDK_LOG_RECORD=ON is temporary and deprecated")
+endif()
+
 set(WITH_STL
     "OFF"
     CACHE STRING "Which version of the Standard Library for C++ to use")
diff --git a/ci/do_ci.ps1 b/ci/do_ci.ps1
@@ -67,6 +67,7 @@ switch ($action) {
     cmake $SRC_DIR `
       -DVCPKG_TARGET_TRIPLET=x64-windows `
       -DOPENTELEMETRY_BUILD_DLL=1 `
+      -DWITH_DEPRECATED_SDK_LOG_RECORD=ON `
      "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
     $exit = $LASTEXITCODE
     if ($exit -ne 0) {
@@ -221,6 +222,7 @@ switch ($action) {
     cmake $SRC_DIR `
       -DVCPKG_TARGET_TRIPLET=x64-windows `
       -DWITH_ASYNC_EXPORT_PREVIEW=ON `
+      -DWITH_DEPRECATED_SDK_LOG_RECORD=ON `
       "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
     $exit = $LASTEXITCODE
     if ($exit -ne 0) {
diff --git a/ci/do_ci.sh b/ci/do_ci.sh
@@ -228,6 +228,7 @@ elif [[ "$1" == "cmake.with_async_export.test" ]]; then
         -DWITH_METRICS_EXEMPLAR_PREVIEW=ON \
         -DCMAKE_CXX_FLAGS="-Werror $CXXFLAGS" \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
+        -DWITH_DEPRECATED_SDK_LOG_RECORD=ON \
         "${SRC_DIR}"
   make -j $(nproc)
   make test
@@ -281,6 +282,7 @@ elif [[ "$1" == "cmake.c++20.test" ]]; then
         -DCMAKE_CXX_FLAGS="-Werror $CXXFLAGS" \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
         -DWITH_STL=CXX20 \
+        -DWITH_DEPRECATED_SDK_LOG_RECORD=ON \
         "${SRC_DIR}"
   eval "$MAKE_COMMAND"
   make test
@@ -292,6 +294,7 @@ elif [[ "$1" == "cmake.c++23.test" ]]; then
         -DCMAKE_CXX_FLAGS="-Werror $CXXFLAGS" \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
         -DWITH_STL=CXX23 \
+        -DWITH_DEPRECATED_SDK_LOG_RECORD=ON \
         "${SRC_DIR}"
   eval "$MAKE_COMMAND"
   make test
@@ -304,6 +307,7 @@ elif [[ "$1" == "cmake.c++14.stl.test" ]]; then
         -DCMAKE_CXX_FLAGS="-Werror $CXXFLAGS" \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
         -DWITH_STL=CXX14 \
+        -DWITH_DEPRECATED_SDK_LOG_RECORD=ON \
         "${SRC_DIR}"
   eval "$MAKE_COMMAND"
   make test
@@ -316,6 +320,7 @@ elif [[ "$1" == "cmake.c++17.stl.test" ]]; then
         -DCMAKE_CXX_FLAGS="-Werror $CXXFLAGS" \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
         -DWITH_STL=CXX17 \
+        -DWITH_DEPRECATED_SDK_LOG_RECORD=ON \
         "${SRC_DIR}"
   eval "$MAKE_COMMAND"
   make test
diff --git a/sdk/include/opentelemetry/sdk/logs/log_record_data.h b/sdk/include/opentelemetry/sdk/logs/log_record_data.h
@@ -82,7 +82,7 @@ class LogRecordData final : public ReadableLogRecord
    * Get body field of this log.          \
    * @return the body field for this log. \
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   const common::OwnedAttributeValue &
 #else
   const opentelemetry::common::AttributeValue &
@@ -156,7 +156,7 @@ class LogRecordData final : public ReadableLogRecord
    * Get attributes of this log.
    * @return the body field of this log
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   const std::unordered_map<std::string, common::OwnedAttributeValue> &
 #else
   const std::unordered_map<std::string, opentelemetry::common::AttributeValue> &
@@ -196,7 +196,7 @@ class LogRecordData final : public ReadableLogRecord
   const opentelemetry::sdk::resource::Resource *resource_;
   const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_;
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   common::AttributeMap attributes_map_;
   // We resue the same utility functions of MixedAttributeMap with key="" for the body field
   common::OwnedAttributeValue body_;
diff --git a/sdk/include/opentelemetry/sdk/logs/read_write_log_record.h b/sdk/include/opentelemetry/sdk/logs/read_write_log_record.h
@@ -82,7 +82,7 @@ class ReadWriteLogRecord final : public ReadableLogRecord
    * Get body field of this log.
    * @return the body field for this log.
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   const common::OwnedAttributeValue &
 #else
   const opentelemetry::common::AttributeValue &
@@ -156,7 +156,7 @@ class ReadWriteLogRecord final : public ReadableLogRecord
    * Get attributes of this log.
    * @return the body field of this log
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   const std::unordered_map<std::string, common::OwnedAttributeValue> &
 #else
   const std::unordered_map<std::string, opentelemetry::common::AttributeValue> &
@@ -196,7 +196,7 @@ class ReadWriteLogRecord final : public ReadableLogRecord
   const opentelemetry::sdk::resource::Resource *resource_;
   const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_;
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   common::AttributeMap attributes_map_;
   // We resue the same utility functions of MixedAttributeMap with key="" for the body field
   common::OwnedAttributeValue body_;
diff --git a/sdk/include/opentelemetry/sdk/logs/readable_log_record.h b/sdk/include/opentelemetry/sdk/logs/readable_log_record.h
@@ -75,7 +75,7 @@ class ReadableLogRecord : public Recordable
    * Get body field of this log.
    * @return the body field for this log.
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   virtual const common::OwnedAttributeValue &
 #else
   virtual const opentelemetry::common::AttributeValue &
@@ -116,7 +116,7 @@ class ReadableLogRecord : public Recordable
    * Get attributes of this log.
    * @return the body field of this log
    */
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   virtual const std::unordered_map<std::string, common::OwnedAttributeValue> &
 #else
   virtual const std::unordered_map<std::string, opentelemetry::common::AttributeValue> &
diff --git a/sdk/src/logs/CMakeLists.txt b/sdk/src/logs/CMakeLists.txt
@@ -31,6 +31,11 @@ target_link_libraries(opentelemetry_logs PUBLIC opentelemetry_resources
                                                 opentelemetry_common)
 set_target_version(opentelemetry_logs)
 
+if(NOT WITH_NO_DEPRECATED_CODE AND WITH_DEPRECATED_SDK_LOG_RECORD)
+  target_compile_definitions(opentelemetry_logs
+                             PUBLIC OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
+endif()
+
 target_include_directories(
   opentelemetry_logs
   PUBLIC "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/sdk/include>")
diff --git a/sdk/src/logs/log_record_data.cc b/sdk/src/logs/log_record_data.cc
@@ -36,7 +36,7 @@ LogRecordData::LogRecordData()
       event_name_("")
 {
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   body_ = std::string();
 #else
   body_.SetAttribute("", nostd::string_view());
@@ -77,21 +77,21 @@ opentelemetry::logs::Severity LogRecordData::GetSeverity() const noexcept
 
 void LogRecordData::SetBody(const opentelemetry::common::AttributeValue &message) noexcept
 {
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   body_ = nostd::visit(attribute_converter_, message);
 #else
   body_.SetAttribute("", message);
 #endif
 }
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
 const common::OwnedAttributeValue &
 #else
 const opentelemetry::common::AttributeValue &
 #endif
 LogRecordData::GetBody() const noexcept
 {
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   return body_;
 #else
   return body_.GetAttributes().begin()->second;
@@ -183,7 +183,7 @@ void LogRecordData::SetAttribute(nostd::string_view key,
   attributes_map_.SetAttribute(key, value);
 }
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
 const std::unordered_map<std::string, opentelemetry::sdk::common::OwnedAttributeValue> &
 #else
 const std::unordered_map<std::string, opentelemetry::common::AttributeValue> &
diff --git a/sdk/src/logs/read_write_log_record.cc b/sdk/src/logs/read_write_log_record.cc
@@ -30,7 +30,7 @@ ReadWriteLogRecord::ReadWriteLogRecord()
     : severity_(opentelemetry::logs::Severity::kInvalid),
       resource_(nullptr),
       instrumentation_scope_(nullptr),
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
       body_(std::string()),
 #else
       body_(nostd::string_view()),
@@ -75,14 +75,14 @@ opentelemetry::logs::Severity ReadWriteLogRecord::GetSeverity() const noexcept
 
 void ReadWriteLogRecord::SetBody(const opentelemetry::common::AttributeValue &message) noexcept
 {
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   body_ = nostd::visit(attribute_converter_, message);
 #else
   body_ = message;
 #endif
 }
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
 const common::OwnedAttributeValue &
 #else
 const opentelemetry::common::AttributeValue &
@@ -174,21 +174,21 @@ const opentelemetry::trace::TraceFlags &ReadWriteLogRecord::GetTraceFlags() cons
 void ReadWriteLogRecord::SetAttribute(nostd::string_view key,
                                       const opentelemetry::common::AttributeValue &value) noexcept
 {
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   attributes_map_.SetAttribute(key, value);
 #else
   attributes_map_[std::string(key)] = value;
 #endif
 }
 
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
 const std::unordered_map<std::string, opentelemetry::sdk::common::OwnedAttributeValue> &
 #else
 const std::unordered_map<std::string, opentelemetry::common::AttributeValue> &
 #endif
 ReadWriteLogRecord::GetAttributes() const noexcept
 {
-#if OPENTELEMETRY_ABI_VERSION_NO >= 2
+#if !defined(OPENTELEMETRY_DEPRECATED_SDK_LOG_RECORD)
   return attributes_map_.GetAttributes();
 #else
   return attributes_map_;
diff --git a/sdk/test/logs/log_record_test.cc b/sdk/test/logs/log_record_test.cc
