Merge branch 'pratik/otel-phase2-rpc-tracing' into pratik/otel-phase3-tx-tracing

Signed-off-by: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com>

CMakeLists.txt

@@ -122,7 +122,7 @@ endif()
 # so that SpanGuard factory methods produce real OTel spans.
 # When OFF (default), all tracing code compiles to no-ops with zero overhead.
 # Enable via: conan install -o telemetry=True, or cmake -Dtelemetry=ON.
-option(telemetry "Enable OpenTelemetry tracing" OFF)
+option(telemetry "Enable OpenTelemetry tracing" ON)
 if(telemetry)
     find_package(opentelemetry-cpp CONFIG REQUIRED)
     add_compile_definitions(XRPL_ENABLE_TELEMETRY)

OpenTelemetryPlan/04-code-samples.md

@@ -165,12 +165,12 @@ public:
 
 // Factory functions
 std::unique_ptr<Telemetry>
-make_Telemetry(
+makeTelemetry(
     Telemetry::Setup const& setup,
     beast::Journal journal);
 
 Telemetry::Setup
-setup_Telemetry(
+setupTelemetry(
     Section const& section,
     std::string const& nodePublicKey,
     std::string const& version);

OpenTelemetryPlan/05-configuration-reference.md

@@ -128,7 +128,7 @@ namespace xrpl {
 namespace telemetry {
 
 Telemetry::Setup
-setup_Telemetry(
+setupTelemetry(
     Section const& section,
     std::string const& nodePublicKey,
     std::string const& version)
@@ -213,8 +213,8 @@ class ApplicationImp : public Application, public BasicApp
     // Member initializer list (excerpt):
     // ...
     // , telemetry_(
-    //       telemetry::make_Telemetry(
-    //           telemetry::setup_Telemetry(
+    //       telemetry::makeTelemetry(
+    //           telemetry::setupTelemetry(
     //               config_->section("telemetry"),
     //               "",  // Updated later via setServiceInstanceId()
     //               BuildInfo::getVersionString()),
@@ -629,8 +629,8 @@ flowchart TB
     end
 
     subgraph init["Initialization"]
-        parse["setup_Telemetry()"]
-        factory["make_Telemetry()"]
+        parse["setupTelemetry()"]
+        factory["makeTelemetry()"]
     end
 
     subgraph runtime["Runtime Components"]
@@ -663,7 +663,7 @@ flowchart TB
 **Reading the diagram:**
 
 - **Configuration Sources**: `xrpld.cfg` provides runtime settings (endpoint, sampling) while the CMake flag controls whether telemetry is compiled in at all.
-- **Initialization**: `setup_Telemetry()` parses config values, then `make_Telemetry()` constructs the provider, processor, and exporter objects.
+- **Initialization**: `setupTelemetry()` parses config values, then `makeTelemetry()` constructs the provider, processor, and exporter objects.
 - **Runtime Components**: The `TracerProvider` creates spans, the `BatchProcessor` buffers them, and the `OTLP Exporter` serializes and sends them over the wire.
 - **OTLP arrow to Collector**: Trace data leaves the xrpld process via OTLP (gRPC or HTTP) and enters the external Collector pipeline.
 - **Collector Pipeline**: `Receivers` ingest OTLP data, `Processors` apply sampling/filtering/enrichment, and `Exporters` forward traces to storage backends (Tempo, etc.).

OpenTelemetryPlan/POC_taskList.md

@@ -143,8 +143,8 @@
     - `virtual bool shouldTraceRpc() const = 0;`
     - `virtual bool shouldTraceTransactions() const = 0;`
     - `virtual bool shouldTraceConsensus() const = 0;`
-  - Factory: `std::unique_ptr<Telemetry> make_Telemetry(Setup const&, beast::Journal);`
-  - Config parser: `Telemetry::Setup setup_Telemetry(Section const&, std::string const& nodePublicKey, std::string const& version);`
+  - Factory: `std::unique_ptr<Telemetry> makeTelemetry(Setup const&, beast::Journal);`
+  - Config parser: `Telemetry::Setup setupTelemetry(Section const&, std::string const& nodePublicKey, std::string const& version);`
 
 - Create `include/xrpl/telemetry/SpanGuard.h`:
   - RAII guard with static factory methods (`rpcSpan()`, `txSpan()`, `consensusSpan()`, etc.) that access the global `Telemetry::getInstance()` singleton internally.
@@ -196,10 +196,10 @@
     - `shouldTraceRpc()` etc. read from `Setup` fields
 
 - Create `src/libxrpl/telemetry/TelemetryConfig.cpp`:
-  - `setup_Telemetry()` parses the `[telemetry]` config section from `xrpld.cfg`
+  - `setupTelemetry()` parses the `[telemetry]` config section from `xrpld.cfg`
   - Maps config keys: `enabled`, `exporter`, `endpoint`, `sampling_ratio`, `trace_rpc`, `trace_transactions`, `trace_consensus`, `trace_peer`
 
-- Wire `make_Telemetry()` factory:
+- Wire `makeTelemetry()` factory:
   - If `setup.enabled` is true AND `XRPL_ENABLE_TELEMETRY` is defined: return `TelemetryImpl`
   - Otherwise: return `NullTelemetry`
 
@@ -217,7 +217,7 @@
 **Reference**:
 
 - [04-code-samples.md §4.1](./04-code-samples.md) — `Telemetry` interface that `TelemetryImpl` must implement
-- [05-configuration-reference.md §5.2](./05-configuration-reference.md) — `setup_Telemetry()` config parser implementation
+- [05-configuration-reference.md §5.2](./05-configuration-reference.md) — `setupTelemetry()` config parser implementation
 - [02-design-decisions.md §2.2](./02-design-decisions.md) — OTLP/gRPC exporter config (endpoint, TLS options)
 - [02-design-decisions.md §2.4.1](./02-design-decisions.md) — Resource attributes: `service.name`, `service.version`, `service.instance.id`, `xrpl.network.id`
 - [03-implementation-strategy.md §3.4](./03-implementation-strategy.md) — Per-operation CPU costs and overhead budget for span creation
@@ -242,8 +242,8 @@
     `serviceInstanceId` (node identity is not yet known):
     ```cpp
     , telemetry_(
-          telemetry::make_Telemetry(
-              telemetry::setup_Telemetry(
+          telemetry::makeTelemetry(
+              telemetry::setupTelemetry(
                   config_->section("telemetry"),
                   "",  // Updated later via setServiceInstanceId()
                   BuildInfo::getVersionString()),

OpenTelemetryPlan/Phase2_taskList.md

@@ -67,7 +67,7 @@
 
 - `src/tests/libxrpl/telemetry/TelemetryConfig.cpp`:
   - Test Setup defaults (all fields have correct initial values)
-  - Test `setup_Telemetry` config parser (empty section, full section, edge cases)
+  - Test `setupTelemetry` config parser (empty section, full section, edge cases)
   - Test `samplingRatio` clamping (values outside 0.0-1.0)
 
 - `src/tests/libxrpl/telemetry/SpanGuardFactory.cpp`:

conanfile.py

@@ -54,7 +54,7 @@ class Xrpl(ConanFile):
         "rocksdb": True,
         "shared": False,
         "static": True,
-        "telemetry": False,
+        "telemetry": True,
         "tests": False,
         "unity": False,
         "xrpld": False,

docs/build/telemetry.md

@@ -258,7 +258,7 @@ The Conan package provides a single umbrella target
 | `include/xrpl/telemetry/SpanGuard.h`          | RAII span guard with `discard()` for dropping unwanted spans |
 | `include/xrpl/telemetry/DiscardFlag.h`        | Thread-local discard flag (zero-dependency header)           |
 | `src/libxrpl/telemetry/Telemetry.cpp`         | OTel SDK setup, `FilteringSpanProcessor`, provider lifecycle |
-| `src/libxrpl/telemetry/TelemetryConfig.cpp`   | Config parser (`setup_Telemetry()`)                          |
+| `src/libxrpl/telemetry/TelemetryConfig.cpp`   | Config parser (`setupTelemetry()`)                           |
 | `src/libxrpl/telemetry/NullTelemetry.cpp`     | No-op implementation (used when disabled)                    |
 | `src/libxrpl/telemetry/SpanGuard.cpp`         | Pimpl implementation for SpanGuard (all OTel types confined) |
 | `src/xrpld/rpc/detail/ServerHandler.cpp`      | RPC entry point instrumentation                              |

src/libxrpl/telemetry/NullTelemetry.cpp

@@ -10,12 +10,16 @@
     its own factory that can return the real TelemetryImpl.
 */
 
+#include <xrpl/beast/utility/Journal.h>
 #include <xrpl/telemetry/Telemetry.h>
 
-#include <string_view>
+#include <memory>
+#include <utility>
 
 #ifdef XRPL_ENABLE_TELEMETRY
 #include <opentelemetry/trace/noop.h>
+
+#include <string_view>
 #endif
 
 namespace xrpl::telemetry {

src/libxrpl/telemetry/SpanGuard.cpp

@@ -27,14 +27,15 @@
 #include <xrpl/telemetry/SpanNames.h>
 #include <xrpl/telemetry/Telemetry.h>
 
+#include <opentelemetry/context/context.h>
 #include <opentelemetry/context/runtime_context.h>
 #include <opentelemetry/nostd/shared_ptr.h>
 #include <opentelemetry/trace/context.h>
 #include <opentelemetry/trace/default_span.h>
-#include <opentelemetry/trace/provider.h>
 #include <opentelemetry/trace/scope.h>
 #include <opentelemetry/trace/span.h>
 #include <opentelemetry/trace/span_context.h>
+#include <opentelemetry/trace/span_metadata.h>
 #include <opentelemetry/trace/span_startoptions.h>
 #include <opentelemetry/trace/trace_flags.h>
 #include <opentelemetry/trace/trace_id.h>

src/libxrpl/telemetry/Telemetry.cpp

@@ -18,11 +18,15 @@
 #include <xrpl/telemetry/Telemetry.h>
 
 #include <xrpl/basics/Log.h>
+#include <xrpl/beast/utility/Journal.h>
 #include <xrpl/telemetry/DiscardFlag.h>
 #include <xrpl/telemetry/SpanNames.h>
 
+#include <opentelemetry/context/context.h>
 #include <opentelemetry/exporters/otlp/otlp_http_exporter_factory.h>
 #include <opentelemetry/exporters/otlp/otlp_http_exporter_options.h>
+#include <opentelemetry/nostd/shared_ptr.h>
+#include <opentelemetry/sdk/resource/resource.h>
 #include <opentelemetry/sdk/trace/batch_span_processor_factory.h>
 #include <opentelemetry/sdk/trace/batch_span_processor_options.h>
 #include <opentelemetry/sdk/trace/processor.h>
@@ -33,8 +37,15 @@
 #include <opentelemetry/semconv/incubating/service_attributes.h>
 #include <opentelemetry/trace/noop.h>
 #include <opentelemetry/trace/provider.h>
+#include <opentelemetry/trace/span.h>
+#include <opentelemetry/trace/span_metadata.h>
+#include <opentelemetry/trace/span_startoptions.h>
+#include <opentelemetry/trace/tracer.h>
+#include <opentelemetry/trace/tracer_provider.h>
 
 #include <chrono>
+#include <cstdint>
+#include <memory>
 #include <string>
 #include <string_view>
 #include <utility>
@@ -82,7 +93,7 @@ namespace resource = opentelemetry::sdk::resource;
 */
 class FilteringSpanProcessor : public trace_sdk::SpanProcessor
 {
-    std::unique_ptr<trace_sdk::SpanProcessor> delegate_{};
+    std::unique_ptr<trace_sdk::SpanProcessor> delegate_;
 
 public:
     explicit FilteringSpanProcessor(std::unique_ptr<trace_sdk::SpanProcessor> delegate)
@@ -240,7 +251,7 @@ class TelemetryImpl : public Telemetry
         Held as std::shared_ptr so we can call ForceFlush() on shutdown.
         Wrapped in a nostd::shared_ptr when registered as the global provider.
     */
-    std::shared_ptr<trace_sdk::TracerProvider> sdkProvider_{};
+    std::shared_ptr<trace_sdk::TracerProvider> sdkProvider_;
 
 public:
     TelemetryImpl(Setup setup, beast::Journal journal) : setup_(std::move(setup)), journal_(journal)

src/tests/libxrpl/telemetry/TelemetryConfig.cpp

@@ -4,8 +4,6 @@
 
 #include <gtest/gtest.h>
 
-#include <chrono>
-
 using namespace xrpl;
 
 TEST(TelemetryConfig, setup_defaults)
@@ -34,7 +32,7 @@ TEST(TelemetryConfig, setup_defaults)
 TEST(TelemetryConfig, parse_empty_section)
 {
     Section const section;
-    auto setup = telemetry::setup_Telemetry(section, "nHUtest123", "2.0.0", 0);
+    auto setup = telemetry::setupTelemetry(section, "nHUtest123", "2.0.0", 0);
 
     EXPECT_FALSE(setup.enabled);
     EXPECT_EQ(setup.serviceName, "xrpld");
@@ -68,7 +66,7 @@ TEST(TelemetryConfig, parse_full_section)
     section.set("trace_peer", "1");
     section.set("trace_ledger", "0");
 
-    auto setup = telemetry::setup_Telemetry(section, "nHUtest123", "2.0.0", 1);
+    auto setup = telemetry::setupTelemetry(section, "nHUtest123", "2.0.0", 1);
 
     EXPECT_TRUE(setup.enabled);
     EXPECT_EQ(setup.serviceName, "my-rippled");
@@ -94,7 +92,7 @@ TEST(TelemetryConfig, null_telemetry_factory)
 
     beast::Journal::Sink& sink = beast::Journal::getNullSink();
     beast::Journal const j(sink);
-    auto tel = telemetry::make_Telemetry(setup, j);
+    auto tel = telemetry::makeTelemetry(setup, j);
     EXPECT_TRUE(tel != nullptr);
     EXPECT_FALSE(tel->isEnabled());
     EXPECT_FALSE(tel->shouldTraceRpc());
@@ -112,11 +110,11 @@ TEST(TelemetryConfig, sampling_ratio_clamped)
 {
     Section section;
     section.set("sampling_ratio", "2.5");
-    auto setup = telemetry::setup_Telemetry(section, "nHUtest123", "2.0.0", 0);
+    auto setup = telemetry::setupTelemetry(section, "nHUtest123", "2.0.0", 0);
     EXPECT_DOUBLE_EQ(setup.samplingRatio, 1.0);
 
     Section section2;
     section2.set("sampling_ratio", "-0.5");
-    auto setup2 = telemetry::setup_Telemetry(section2, "nHUtest123", "2.0.0", 0);
+    auto setup2 = telemetry::setupTelemetry(section2, "nHUtest123", "2.0.0", 0);
     EXPECT_DOUBLE_EQ(setup2.samplingRatio, 0.0);
 }