ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-07-22 14:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(telemetry): use SpanNames constants (not literals) in SpanGuard @code examples

Browse Source 
The otel-naming Rule F check scans @code doc examples as call sites; raw
string literals there trip the rule. Reference *SpanNames.h constants /
placeholder identifiers in the examples so comments follow the naming rules.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Pratik Mankawde
2026-07-17 22:11:24 +01:00
parent 4f9650502b
commit 2aeea61964
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
include/xrpl/telemetry/SpanGuard.h
View File

@@ -57,8 +57,8 @@
* using namespace xrpl::telemetry;
*
* auto span = SpanGuard::span(
* TraceCategory::Rpc, rpc_span::prefix::command, "submit");
* span.setAttribute(rpc_span::attr::command, "submit");
* TraceCategory::Rpc, rpc_span::prefix::command, commandName);
* span.setAttribute(rpc_span::attr::command, commandName);
* span.setAttribute(rpc_span::attr::rpcStatus, rpc_span::val::success);
* // span ended automatically on scope exit
* @endcode
@@ -66,7 +66,7 @@
* 2. Error recording:
* @code
* auto span = SpanGuard::span(
* TraceCategory::Rpc, rpc_span::prefix::command, "submit");
* TraceCategory::Rpc, rpc_span::prefix::command, commandName);
* try {
* doWork();
* span.setOk();
@@ -112,20 +112,27 @@
*
* 6. Fresh trace root at an inbound entry point (primary rootSpan use):
* @code
* #include <xrpld/overlay/detail/PeerSpanNames.h>
* using namespace xrpl::telemetry;
*
* // A peer message handled on a shared worker thread that may
* // already have unrelated spans active — start a clean root so
* // those do not become parents of this trace.
* // those do not become parents of this trace. Names come from a
* // *SpanNames.h header, never raw literals.
* auto span = SpanGuard::rootSpan(
* TraceCategory::Peer, "peer", "validation.receive");
* span.setAttribute("ledger_hash", hashStr);
* TraceCategory::Peer, seg::peer, peer_span::op::validationReceive);
* span.setAttribute(peer_span::attr::ledgerHash, hashStr);
* @endcode
*
* 7. Hand a span to a job on another thread (edge case, detached):
* @code
* #include <xrpld/app/ledger/detail/LedgerSpanNames.h>
* using namespace xrpl::telemetry;
*
* // Build the guard on THIS thread, then strip its thread-local
* // Scope so it can be safely moved into a job and ended there.
* auto span = SpanGuard::span(
* TraceCategory::Ledger, "ledger", "build");
* TraceCategory::Ledger, seg::ledger, ledger_span::op::build);
* jobQueue.addJob(
* [g = std::move(span).detached()]() mutable {
* doWork();