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

.github/scripts/levelization/results/loops.txt

@@ -5,7 +5,7 @@ Loop: test.jtx test.unit_test
   test.unit_test ~= test.jtx
 
 Loop: xrpl.telemetry xrpld.rpc
-  xrpld.rpc ~= xrpl.telemetry
+  xrpld.rpc > xrpl.telemetry
 
 Loop: xrpld.app xrpld.overlay
   xrpld.app > xrpld.overlay

.github/scripts/levelization/results/ordering.txt

@@ -194,6 +194,7 @@ tests.libxrpl > xrpl.json
 tests.libxrpl > xrpl.net
 tests.libxrpl > xrpl.protocol
 tests.libxrpl > xrpl.protocol_autogen
+tests.libxrpl > xrpl.telemetry
 xrpl.conditions > xrpl.basics
 xrpl.conditions > xrpl.protocol
 xrpl.core > xrpl.basics

OpenTelemetryPlan/Phase3_taskList.md

@@ -23,7 +23,7 @@
 
 **What to do**:
 
-- Edit `include/xrpl/proto/xrpl.proto` (or `src/ripple/proto/ripple.proto`, wherever the proto is):
+- Edit `include/xrpl/proto/xrpl.proto` (or `src/xrpld/proto/ripple.proto`, wherever the proto is):
   - Add `TraceContext` message definition:
     ```protobuf
     message TraceContext {

OpenTelemetryPlan/Phase5_taskList.md

@@ -175,7 +175,7 @@
 **What to do**:
 
 - Create `docs/telemetry-runbook.md`:
-  - **Setup**: How to enable telemetry in rippled
+  - **Setup**: How to enable telemetry in xrpld
   - **Configuration**: All config options with descriptions
   - **Collector Deployment**: Docker Compose vs. Kubernetes vs. bare metal
   - **Troubleshooting**: Common issues and resolutions
@@ -199,7 +199,7 @@
 **What to do**:
 
 1. Start full Docker stack (Collector, Tempo, Grafana, Prometheus)
-2. Build rippled with `telemetry=ON`
+2. Build xrpld with `telemetry=ON`
 3. Run in standalone mode with telemetry enabled
 4. Generate RPC traffic and verify traces in Tempo
 5. Verify dashboards populate in Grafana

include/xrpl/telemetry/Telemetry.h

@@ -85,8 +85,7 @@
 #include <opentelemetry/trace/tracer.h>
 #endif
 
-namespace xrpl {
-namespace telemetry {
+namespace xrpl::telemetry {
 
 class Telemetry
 {
@@ -222,27 +221,27 @@ public:
     stop() = 0;
 
     /** @return true if this instance is actively exporting spans. */
-    virtual bool
+    [[nodiscard]] virtual bool
     isEnabled() const = 0;
 
     /** @return true if transaction processing should be traced. */
-    virtual bool
+    [[nodiscard]] virtual bool
     shouldTraceTransactions() const = 0;
 
     /** @return true if consensus rounds should be traced. */
-    virtual bool
+    [[nodiscard]] virtual bool
     shouldTraceConsensus() const = 0;
 
     /** @return true if RPC request handling should be traced. */
-    virtual bool
+    [[nodiscard]] virtual bool
     shouldTraceRpc() const = 0;
 
     /** @return true if peer-to-peer messages should be traced. */
-    virtual bool
+    [[nodiscard]] virtual bool
     shouldTracePeer() const = 0;
 
     /** @return true if ledger close/accept should be traced. */
-    virtual bool
+    [[nodiscard]] virtual bool
     shouldTraceLedger() const = 0;
 
 #ifdef XRPL_ENABLE_TELEMETRY
@@ -318,5 +317,4 @@ setup_Telemetry(
     std::string const& version,
     std::uint32_t networkId);
 
-}  // namespace telemetry
-}  // namespace xrpl
+}  // namespace xrpl::telemetry

src/libxrpl/telemetry/NullTelemetry.cpp

@@ -10,14 +10,17 @@
     its own factory that can return the real TelemetryImpl.
 */
 
+#include <xrpl/beast/utility/Journal.h>
 #include <xrpl/telemetry/Telemetry.h>
 
 #ifdef XRPL_ENABLE_TELEMETRY
 #include <opentelemetry/trace/noop.h>
 #endif
 
-namespace xrpl {
-namespace telemetry {
+#include <memory>
+#include <utility>
+
+namespace xrpl::telemetry {
 
 namespace {
 
@@ -32,7 +35,7 @@ class NullTelemetry : public Telemetry
     Setup const setup_;
 
 public:
-    explicit NullTelemetry(Setup const& setup) : setup_(setup)
+    explicit NullTelemetry(Setup setup) : setup_(std::move(setup))
     {
     }
 
@@ -48,37 +51,37 @@ public:
         Telemetry::setInstance(nullptr);
     }
 
-    bool
+    [[nodiscard]] bool
     isEnabled() const override
     {
         return false;
     }
 
-    bool
+    [[nodiscard]] bool
     shouldTraceTransactions() const override
     {
         return false;
     }
 
-    bool
+    [[nodiscard]] bool
     shouldTraceConsensus() const override
     {
         return false;
     }
 
-    bool
+    [[nodiscard]] bool
     shouldTraceRpc() const override
     {
         return false;
     }
 
-    bool
+    [[nodiscard]] bool
     shouldTracePeer() const override
     {
         return false;
     }
 
-    bool
+    [[nodiscard]] bool
     shouldTraceLedger() const override
     {
         return false;
@@ -125,5 +128,4 @@ make_Telemetry(Telemetry::Setup const& setup, beast::Journal)
 }
 #endif
 
-}  // namespace telemetry
-}  // namespace xrpl
+}  // namespace xrpl::telemetry

src/libxrpl/telemetry/TelemetryConfig.cpp

@@ -7,12 +7,14 @@
     See cfg/xrpld-example.cfg for the full list of available options.
 */
 
+#include <xrpl/basics/BasicConfig.h>
 #include <xrpl/telemetry/Telemetry.h>
 
 #include <algorithm>
+#include <cstdint>
+#include <string>
 
-namespace xrpl {
-namespace telemetry {
+namespace xrpl::telemetry {
 
 namespace {
 
@@ -78,5 +80,4 @@ setup_Telemetry(
     return setup;
 }
 
-}  // namespace telemetry
-}  // namespace xrpl
+}  // namespace xrpl::telemetry

src/tests/libxrpl/telemetry/SpanGuardFactory.cpp

@@ -7,7 +7,7 @@ using namespace xrpl::telemetry;
 
 TEST(SpanGuardFactory, null_guard_methods_are_safe)
 {
-    auto span = SpanGuard::span("nonexistent.span");
+    auto span = SpanGuard::span(TraceCategory::Rpc, "rpc", "nonexistent");
     EXPECT_FALSE(span);
 
     span.setAttribute("key", "value");
@@ -29,28 +29,28 @@ TEST(SpanGuardFactory, category_span_returns_null_when_disabled)
 
 TEST(SpanGuardFactory, child_span_null_when_no_parent)
 {
-    auto span = SpanGuard::span("parent.test");
+    auto span = SpanGuard::span(TraceCategory::Rpc, "rpc", "parent");
     auto child = span.childSpan("child.test");
     EXPECT_FALSE(child);
 }
 
 TEST(SpanGuardFactory, linked_span_null_when_no_context)
 {
-    auto span = SpanGuard::span("source.test");
+    auto span = SpanGuard::span(TraceCategory::Rpc, "rpc", "source");
     auto linked = span.linkedSpan("linked.test");
     EXPECT_FALSE(linked);
 }
 
 TEST(SpanGuardFactory, capture_context_returns_invalid_on_null)
 {
-    auto span = SpanGuard::span("ctx.test");
+    auto span = SpanGuard::span(TraceCategory::Rpc, "rpc", "ctx");
     auto ctx = span.captureContext();
     EXPECT_FALSE(ctx.isValid());
 }
 
 TEST(SpanGuardFactory, move_construction_transfers_ownership)
 {
-    auto span = SpanGuard::span("move.test");
+    auto span = SpanGuard::span(TraceCategory::Rpc, "rpc", "move");
     auto moved = std::move(span);
     EXPECT_FALSE(span);
     moved.setAttribute("key", "value");

src/xrpld/app/main/Application.cpp

@@ -82,6 +82,7 @@
 #include <xrpl/protocol/STParsedJSON.h>
 #include <xrpl/protocol/Serializer.h>
 #include <xrpl/protocol/jss.h>
+#include <xrpl/protocol/tokens.h>
 #include <xrpl/rdb/DatabaseCon.h>
 #include <xrpl/resource/Charge.h>
 #include <xrpl/resource/Consumer.h>

src/xrpld/rpc/detail/RpcSpanNames.h

@@ -37,6 +37,7 @@ inline constexpr auto command = join(seg::rpc, makeStr("command"));
 
 namespace op {
 inline constexpr auto wsMessage = makeStr("ws_message");
+inline constexpr auto wsUpgrade = makeStr("ws_upgrade");
 inline constexpr auto httpRequest = makeStr("http_request");
 inline constexpr auto process = makeStr("process");
 }  // namespace op
@@ -65,6 +66,7 @@ using telemetry::attr_val::error;
 using telemetry::attr_val::success;
 inline constexpr auto admin = makeStr("admin");
 inline constexpr auto user = makeStr("user");
+inline constexpr auto unknownCommand = makeStr("unknown_command");
 }  // namespace val
 
 }  // namespace rpc_span