mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-23 23:20:33 +00:00
d865a266b5
- Rename file-local thread_local globals to the .clang-tidy convention (GlobalVariablePrefix "g" + CamelCase), keeping the Tls marker: tlsPendingTraceId -> gTlsPendingTraceId, tlsPendingConsumed -> gTlsPendingConsumed. - Add direct includes for opentelemetry trace_id.h / span_id.h (header uses TraceId/SpanId in signatures) and sdk/trace/id_generator.h (.cpp references IdGenerator directly) to satisfy misc-include-cleaner. Both verified clean with clang-tidy against a telemetry-enabled compile DB. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
94 lines
2.9 KiB
C++
94 lines
2.9 KiB
C++
/**
|
|
* Implementation of DeterministicIdGenerator and PendingTraceId.
|
|
*
|
|
* The pending trace_id lives in file-local thread_locals shared between the
|
|
* generator and the RAII guard. GenerateTraceId() consumes the pending id on
|
|
* the SDK's no-parent branch; PendingTraceId sets it and asserts consumption.
|
|
* All OpenTelemetry SDK types stay confined to telemetry translation units.
|
|
*
|
|
* @see DeterministicIdGenerator, PendingTraceId (DeterministicIdGenerator.h)
|
|
*/
|
|
|
|
#ifdef XRPL_ENABLE_TELEMETRY
|
|
|
|
#include <xrpl/telemetry/DeterministicIdGenerator.h>
|
|
|
|
#include <xrpl/beast/utility/instrumentation.h>
|
|
|
|
#include <opentelemetry/nostd/span.h>
|
|
#include <opentelemetry/sdk/trace/id_generator.h>
|
|
#include <opentelemetry/sdk/trace/random_id_generator_factory.h>
|
|
#include <opentelemetry/trace/span_id.h>
|
|
#include <opentelemetry/trace/trace_id.h>
|
|
|
|
#include <array>
|
|
#include <cstdint>
|
|
#include <optional>
|
|
|
|
namespace xrpl::telemetry {
|
|
|
|
namespace {
|
|
|
|
/**
|
|
* Trace_id pinned by PendingTraceId, consumed by GenerateTraceId(). File-local
|
|
* and thread-local, so it is set and read on the same thread with no locking.
|
|
*/
|
|
thread_local std::optional<std::array<std::uint8_t, 16>> gTlsPendingTraceId;
|
|
|
|
/**
|
|
* True once GenerateTraceId() has consumed the pending id. ~PendingTraceId
|
|
* asserts on it to catch a forced-root span that never reached the SDK root
|
|
* branch.
|
|
*/
|
|
thread_local bool gTlsPendingConsumed = false;
|
|
|
|
} // namespace
|
|
|
|
DeterministicIdGenerator::DeterministicIdGenerator()
|
|
: opentelemetry::sdk::trace::IdGenerator(/*is_random=*/false)
|
|
, random_(opentelemetry::sdk::trace::RandomIdGeneratorFactory::Create())
|
|
{
|
|
}
|
|
|
|
opentelemetry::trace::TraceId
|
|
DeterministicIdGenerator::GenerateTraceId() noexcept
|
|
{
|
|
if (gTlsPendingTraceId)
|
|
{
|
|
auto const id = *gTlsPendingTraceId;
|
|
gTlsPendingTraceId.reset();
|
|
gTlsPendingConsumed = true;
|
|
return opentelemetry::trace::TraceId(
|
|
opentelemetry::nostd::span<std::uint8_t const, 16>(id.data(), 16));
|
|
}
|
|
return random_->GenerateTraceId();
|
|
}
|
|
|
|
opentelemetry::trace::SpanId
|
|
DeterministicIdGenerator::GenerateSpanId() noexcept
|
|
{
|
|
return random_->GenerateSpanId(); // ALWAYS random — never uses the pending id
|
|
}
|
|
|
|
PendingTraceId::PendingTraceId(std::array<std::uint8_t, 16> const& id) noexcept
|
|
{
|
|
gTlsPendingTraceId = id;
|
|
gTlsPendingConsumed = false;
|
|
}
|
|
|
|
PendingTraceId::~PendingTraceId() noexcept
|
|
{
|
|
// The forced no-parent (root) span-start MUST have consumed the pending id
|
|
// via GenerateTraceId(). If not, the SDK took a different branch than the
|
|
// caller forced — a bug — so fail loudly in debug/test builds.
|
|
XRPL_ASSERT(
|
|
gTlsPendingConsumed,
|
|
"xrpl::telemetry::PendingTraceId : deterministic trace_id was not consumed");
|
|
gTlsPendingTraceId.reset(); // never leak, even in release
|
|
gTlsPendingConsumed = false;
|
|
}
|
|
|
|
} // namespace xrpl::telemetry
|
|
|
|
#endif // XRPL_ENABLE_TELEMETRY
|