From 5f4fe4a0317932f7c741580f43e7a5ba5dada487 Mon Sep 17 00:00:00 2001 From: Marc Alff Date: Thu, 15 May 2025 21:30:15 +0200 Subject: [PATCH 1/3] POC, alternate fix for log record lifecycle. --- .../sdk/logs/read_write_log_record.h | 10 +-- .../sdk/logs/readable_log_record.h | 4 +- sdk/src/logs/read_write_log_record.cc | 13 ++-- sdk/test/logs/log_record_test.cc | 74 ++++++++----------- 4 files changed, 45 insertions(+), 56 deletions(-) diff --git a/sdk/include/opentelemetry/sdk/logs/read_write_log_record.h b/sdk/include/opentelemetry/sdk/logs/read_write_log_record.h index 9831eaa1c9..af28273c49 100644 --- 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. */ - const opentelemetry::common::AttributeValue &GetBody() const noexcept override; + const opentelemetry::sdk::common::OwnedAttributeValue &GetBody() const noexcept override; /** * Set the Event Id object @@ -151,8 +151,8 @@ class ReadWriteLogRecord final : public ReadableLogRecord * Get attributes of this log. * @return the body field of this log */ - const std::unordered_map &GetAttributes() - const noexcept override; + const std::unordered_map & + GetAttributes() const noexcept override; /** * Get resource of this log @@ -187,8 +187,8 @@ class ReadWriteLogRecord final : public ReadableLogRecord const opentelemetry::sdk::resource::Resource *resource_; const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_; - std::unordered_map attributes_map_; - opentelemetry::common::AttributeValue body_; + std::unordered_map attributes_map_; + opentelemetry::sdk::common::OwnedAttributeValue body_; opentelemetry::common::SystemTimestamp timestamp_; opentelemetry::common::SystemTimestamp observed_timestamp_; diff --git a/sdk/include/opentelemetry/sdk/logs/readable_log_record.h b/sdk/include/opentelemetry/sdk/logs/readable_log_record.h index 2222def9d2..3245717ce2 100644 --- 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. */ - virtual const opentelemetry::common::AttributeValue &GetBody() const noexcept = 0; + virtual const opentelemetry::sdk::common::OwnedAttributeValue &GetBody() const noexcept = 0; /** * Get the Event id. @@ -111,7 +111,7 @@ class ReadableLogRecord : public Recordable * Get attributes of this log. * @return the body field of this log */ - virtual const std::unordered_map & + virtual const std::unordered_map & GetAttributes() const noexcept = 0; /** diff --git a/sdk/src/logs/read_write_log_record.cc b/sdk/src/logs/read_write_log_record.cc index 84a4bed2f4..f3cb63acfb 100644 --- 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), - body_(nostd::string_view()), + body_(std::string()), observed_timestamp_(std::chrono::system_clock::now()), event_id_(0), event_name_("") @@ -71,10 +71,11 @@ opentelemetry::logs::Severity ReadWriteLogRecord::GetSeverity() const noexcept void ReadWriteLogRecord::SetBody(const opentelemetry::common::AttributeValue &message) noexcept { - body_ = message; + opentelemetry::sdk::common::AttributeConverter converter; + body_ = nostd::visit(converter, message); } -const opentelemetry::common::AttributeValue &ReadWriteLogRecord::GetBody() const noexcept +const opentelemetry::sdk::common::OwnedAttributeValue &ReadWriteLogRecord::GetBody() const noexcept { return body_; } @@ -161,10 +162,12 @@ const opentelemetry::trace::TraceFlags &ReadWriteLogRecord::GetTraceFlags() cons void ReadWriteLogRecord::SetAttribute(nostd::string_view key, const opentelemetry::common::AttributeValue &value) noexcept { - attributes_map_[static_cast(key)] = value; + std::string safe_key(key); + opentelemetry::sdk::common::AttributeConverter converter; + attributes_map_[safe_key] = nostd::visit(converter, value); } -const std::unordered_map & +const std::unordered_map & ReadWriteLogRecord::GetAttributes() const noexcept { return attributes_map_; diff --git a/sdk/test/logs/log_record_test.cc b/sdk/test/logs/log_record_test.cc index 1a9ac328cf..a0e7e23c12 100644 --- a/sdk/test/logs/log_record_test.cc +++ b/sdk/test/logs/log_record_test.cc @@ -72,13 +72,9 @@ TEST(ReadWriteLogRecord, SetAndGet) // Test that all fields match what was set ASSERT_EQ(record.GetSeverity(), logs_api::Severity::kInvalid); - if (nostd::holds_alternative(record.GetBody())) + if (nostd::holds_alternative(record.GetBody())) { - ASSERT_EQ(std::string(nostd::get(record.GetBody())), "Message"); - } - else if (nostd::holds_alternative(record.GetBody())) - { - ASSERT_TRUE(nostd::get(record.GetBody()) == "Message"); + ASSERT_EQ(std::string(nostd::get(record.GetBody())), "Message"); } ASSERT_TRUE(nostd::get(record.GetResource().GetAttributes().at("res1"))); ASSERT_EQ(nostd::get(record.GetAttributes().at("attr1")), 314159); @@ -109,13 +105,13 @@ class TestBodyLogger : public opentelemetry::logs::Logger } } - const opentelemetry::common::AttributeValue &GetLastLogRecord() const noexcept + const opentelemetry::sdk::common::OwnedAttributeValue &GetLastLogRecord() const noexcept { return last_body_; } private: - opentelemetry::common::AttributeValue last_body_; + opentelemetry::sdk::common::OwnedAttributeValue last_body_; }; // Define a basic LoggerProvider class that returns an instance of the logger class defined above @@ -173,28 +169,19 @@ TEST(LogBody, BodyConversation) real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, "128"); ASSERT_TRUE( - opentelemetry::nostd::holds_alternative(real_logger->GetLastLogRecord()) || - opentelemetry::nostd::holds_alternative(real_logger->GetLastLogRecord())); - if (opentelemetry::nostd::holds_alternative(real_logger->GetLastLogRecord())) - { - ASSERT_EQ(nostd::string_view{"128"}, - opentelemetry::nostd::get(real_logger->GetLastLogRecord())); - } - else - { - ASSERT_EQ(nostd::string_view{"128"}, - opentelemetry::nostd::get(real_logger->GetLastLogRecord())); - } + opentelemetry::nostd::holds_alternative(real_logger->GetLastLogRecord())); + ASSERT_EQ(nostd::string_view{"128"}, + opentelemetry::nostd::get(real_logger->GetLastLogRecord())); { bool data[] = {true, false, true}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -208,11 +195,11 @@ TEST(LogBody, BodyConversation) int32_t data[] = {221, 222, 223}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -226,11 +213,11 @@ TEST(LogBody, BodyConversation) uint32_t data[] = {231, 232, 233}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -244,11 +231,11 @@ TEST(LogBody, BodyConversation) int64_t data[] = {241, 242, 243}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -262,11 +249,11 @@ TEST(LogBody, BodyConversation) uint64_t data[] = {251, 252, 253}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -280,11 +267,11 @@ TEST(LogBody, BodyConversation) uint8_t data[] = {161, 162, 163}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -298,11 +285,11 @@ TEST(LogBody, BodyConversation) double data[] = {271.0, 272.0, 273.0}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); @@ -317,12 +304,11 @@ TEST(LogBody, BodyConversation) nostd::string_view data[] = {data_origin[0], data_origin[1], data_origin[2]}; nostd::span data_span = data; real_logger->EmitLogRecord(opentelemetry::logs::Severity::kInfo, data_span); - ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( + ASSERT_TRUE(opentelemetry::nostd::holds_alternative>( real_logger->GetLastLogRecord())); - nostd::span output = - opentelemetry::nostd::get>( - real_logger->GetLastLogRecord()); + std::vector output = + opentelemetry::nostd::get>(real_logger->GetLastLogRecord()); ASSERT_EQ(data_span.size(), output.size()); From fa6ff2c738c381a78e7760dd50977a4b152896cc Mon Sep 17 00:00:00 2001 From: Marc Alff Date: Thu, 15 May 2025 22:48:35 +0200 Subject: [PATCH 2/3] Cleanup --- CHANGELOG.md | 3 +++ sdk/src/logs/read_write_log_record.cc | 1 + sdk/test/logs/log_record_test.cc | 3 ++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 82eaf5a2ba..a714b0de6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,6 +55,9 @@ Increment the: * [CMAKE] Add generated protobuf headers to the opentelemetry_proto target [#3400](https://github.com/open-telemetry/opentelemetry-cpp/pull/3400) +* [EXPORTER] ostream log exporter, fixed memory ownership issues + [#3417](https://github.com/open-telemetry/opentelemetry-cpp/pull/3417) + ## [1.20 2025-04-01] * [BUILD] Update opentelemetry-proto version diff --git a/sdk/src/logs/read_write_log_record.cc b/sdk/src/logs/read_write_log_record.cc index f3cb63acfb..7743fbd5db 100644 --- a/sdk/src/logs/read_write_log_record.cc +++ b/sdk/src/logs/read_write_log_record.cc @@ -12,6 +12,7 @@ #include "opentelemetry/logs/severity.h" #include "opentelemetry/nostd/string_view.h" #include "opentelemetry/nostd/variant.h" +#include "opentelemetry/sdk/common/attribute_utils.h" #include "opentelemetry/sdk/instrumentationscope/instrumentation_scope.h" #include "opentelemetry/sdk/logs/read_write_log_record.h" #include "opentelemetry/sdk/resource/resource.h" diff --git a/sdk/test/logs/log_record_test.cc b/sdk/test/logs/log_record_test.cc index a0e7e23c12..48d0754060 100644 --- a/sdk/test/logs/log_record_test.cc +++ b/sdk/test/logs/log_record_test.cc @@ -9,8 +9,8 @@ #include #include #include +#include -#include "opentelemetry/common/attribute_value.h" #include "opentelemetry/common/key_value_iterable.h" #include "opentelemetry/common/timestamp.h" #include "opentelemetry/logs/log_record.h" @@ -22,6 +22,7 @@ #include "opentelemetry/nostd/string_view.h" #include "opentelemetry/nostd/unique_ptr.h" #include "opentelemetry/nostd/variant.h" +#include "opentelemetry/sdk/common/attribute_utils.h" #include "opentelemetry/sdk/logs/read_write_log_record.h" #include "opentelemetry/sdk/resource/resource.h" #include "opentelemetry/trace/span_id.h" From 6d82b435f0140295c73086d69350380a285490dc Mon Sep 17 00:00:00 2001 From: Marc Alff Date: Sun, 18 May 2025 16:57:52 +0200 Subject: [PATCH 3/3] CHANGELOG: added important change. --- CHANGELOG.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a714b0de6f..71c20d135e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -58,6 +58,25 @@ Increment the: * [EXPORTER] ostream log exporter, fixed memory ownership issues [#3417](https://github.com/open-telemetry/opentelemetry-cpp/pull/3417) +Important changes: + +* [EXPORTER] ostream log exporter, fixed memory ownership issues + [#3417](https://github.com/open-telemetry/opentelemetry-cpp/pull/3417) + + * In the SDK, the following classes implementation has changed: + + * opentelemetry::sdk::logs::ReadableLogRecord + * opentelemetry::sdk::logs::ReadWriteLogRecord + + * An application implementing a custom log record exporter, + that reuses these classes from the opentelemetry-cpp SDK, + will need code adjustments, in particular for methods: + + * GetBody() + * GetAttributes() + + * Applications not using these SDK classes directly are not affected. + ## [1.20 2025-04-01] * [BUILD] Update opentelemetry-proto version