mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-29 18:10:34 +00:00
15596f5b8d
Slowness on the peer object-fetch path could be observed but not
attributed. Job duration metrics carry only `job_type`, and both
`RcvGetLedger` and `RcvGetObjByHash` report as `ledgerRequest`, so a
queue-wait spike could not be traced to a handler. Nothing measured
NodeStore cost, request size, or the differential charge.
Latency now decomposes into three additive parts, each separately
measurable:
end-to-end = queue wait + NodeStore lookup + everything else
- `handler` label on job_queued_total/_started_total/_finished_total and
job_queued_us/job_running_us. The value is sanitised: a name passes
through only if non-empty and all ASCII letters, else "other". Two job
names embed a ledger sequence, so a raw label would mint one series
per ledger; the rule bounds the domain at 43 names plus "other".
- getobject_lookup_us, _request_objects, _lookups_total{result},
_rejected_total{reason} and _charge, recorded at their call sites.
All three histograms get explicit bucket views: the SDK default stops
at 10,000, which every one of them exceeds.
- Per-job-type waiting/running/deferred gauges for the 35 non-special
job types. `deferred` is the leading indicator, since addJob never
rejects -- it defers, so backpressure otherwise shows up only as
latency after the fact.
`JobQueue::collect()` snapshots the counters under the queue lock and
publishes gauges after releasing it. Writing them while holding the lock
would invert a lock order against the collector's own lock, which the
collector's flush thread already holds when it calls this hook.
Tests assert exact values, including that the charge is priced on the
requested count rather than the capped iteration count.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
161 lines
6.0 KiB
C++
161 lines
6.0 KiB
C++
#pragma once
|
|
|
|
// cspell:ignore ISTOGRAM
|
|
// The all-caps macro name XRPL_METRIC_HISTOGRAM_RECORD trips cspell's
|
|
// compound-word splitter, which emits the subword "ISTOGRAM"; ignore it here.
|
|
|
|
/**
|
|
* Metric names, label keys, label values, and descriptions for the
|
|
* `TMGetObjectByHash` request path.
|
|
*
|
|
* These constants are shared across two modules, which is why they live in a
|
|
* header rather than in either translation unit's unnamed namespace:
|
|
*
|
|
* GetObjectMetricNames.h
|
|
* |
|
|
* +--> PeerImp.cpp (XRPL_METRIC_* call sites: records the
|
|
* | instruments)
|
|
* |
|
|
* +--> MetricsRegistry.cpp (addMicrosecondHistogramView: registers
|
|
* the explicit bucket boundaries for
|
|
* kGetObjectLookupUs)
|
|
*
|
|
* `kGetObjectLookupUs` in particular is referenced from both sites. A
|
|
* copy-pasted literal would let the two drift, and a drifted name silently
|
|
* drops the bucket override -- the histogram would fall back to the SDK
|
|
* default boundaries, which top out at 10,000 (10 ms), so every quantile
|
|
* would saturate. This mirrors the reason the existing
|
|
* `kJobQueuedDurationUs` / `kJobRunningDurationUs` / `kRpcMethodDurationUs`
|
|
* constants exist in MetricsRegistry.cpp; those three are referenced only
|
|
* within that one file, so they stay file-local.
|
|
*
|
|
* Placed under `include/xrpl/telemetry/` because the two consumers sit in
|
|
* different levelization modules: PeerImp.cpp is `xrpld.overlay` and
|
|
* MetricsRegistry.cpp is `xrpld.telemetry`. Both are allowed to depend on
|
|
* `xrpl.telemetry` (see `xrpld.overlay > xrpl.telemetry` and
|
|
* `xrpld.telemetry > xrpl.telemetry` in the levelization ordering results), so
|
|
* `include/xrpl/` is the one level both can reach. Keeping the constants in
|
|
* `src/xrpld/telemetry/` would have required overlay to include a private
|
|
* xrpld header from another module, flipping a levelization edge. Both sites
|
|
* include this file as `<xrpl/telemetry/GetObjectMetricNames.h>`.
|
|
*
|
|
* Example usage -- recording a histogram:
|
|
* @code
|
|
* XRPL_METRIC_HISTOGRAM_RECORD(
|
|
* app_, kGetObjectRequestObjects, kGetObjectRequestObjectsDesc, requested);
|
|
* @endcode
|
|
*
|
|
* Example usage -- edge case: the same instrument recorded under two
|
|
* different label values, which is why the label key and both values are
|
|
* constants rather than literals:
|
|
* @code
|
|
* XRPL_METRIC_COUNTER_ADD_LABELED(
|
|
* app_, kGetObjectLookupsTotal, kGetObjectLookupsTotalDesc, hits,
|
|
* {{kLabelResult, std::string(kResultHit)}});
|
|
* XRPL_METRIC_COUNTER_ADD_LABELED(
|
|
* app_, kGetObjectLookupsTotal, kGetObjectLookupsTotalDesc, misses,
|
|
* {{kLabelResult, std::string(kResultMiss)}});
|
|
* @endcode
|
|
*
|
|
* @note These are `constexpr char[]`, not `constexpr std::string_view`. The
|
|
* OTel C++ API takes `nostd::string_view`, which on this build is OTel's own
|
|
* type (the build defines only OPENTELEMETRY_ABI_VERSION_NO, not
|
|
* OPENTELEMETRY_STL_VERSION, so `nostd::string_view` is not an alias for
|
|
* `std::string_view`). It converts from `char const*` and from
|
|
* `std::string`, but has no converting constructor from `std::string_view`,
|
|
* so a `string_view` constant would not compile at the call sites. This also
|
|
* matches the existing convention in MetricsRegistry.cpp.
|
|
*
|
|
* @note Header-only constants with no runtime state, so there is nothing to
|
|
* synchronize -- safe to include from any thread context.
|
|
*/
|
|
|
|
namespace xrpl::telemetry {
|
|
|
|
// ===== Metric names ==========================================================
|
|
|
|
/**
|
|
* Requests refused by `onMessage(TMGetObjectByHash)` before any NodeStore
|
|
* access, split by the `reason` label.
|
|
*/
|
|
inline constexpr char kGetObjectRejectedTotal[] = "getobject_rejected_total";
|
|
|
|
/**
|
|
* Distribution of the object count requested per message.
|
|
*/
|
|
inline constexpr char kGetObjectRequestObjects[] = "getobject_request_objects";
|
|
|
|
/**
|
|
* Wall time spent in the NodeStore fetch loop, in microseconds.
|
|
*
|
|
* Referenced twice: here at the record site, and by
|
|
* `addMicrosecondHistogramView()` in MetricsRegistry.cpp. Both must use this
|
|
* one constant.
|
|
*/
|
|
inline constexpr char kGetObjectLookupUs[] = "getobject_lookup_us";
|
|
|
|
/**
|
|
* NodeStore lookups performed, split by the `result` label.
|
|
*/
|
|
inline constexpr char kGetObjectLookupsTotal[] = "getobject_lookups_total";
|
|
|
|
/**
|
|
* Distribution of the dynamic resource charge applied per request.
|
|
*/
|
|
inline constexpr char kGetObjectCharge[] = "getobject_charge";
|
|
|
|
// ===== Label keys ============================================================
|
|
|
|
/**
|
|
* Label key distinguishing a hit from a miss on `kGetObjectLookupsTotal`.
|
|
*/
|
|
inline constexpr char kLabelResult[] = "result";
|
|
|
|
/**
|
|
* Label key naming which gate refused the request.
|
|
*/
|
|
inline constexpr char kLabelReason[] = "reason";
|
|
|
|
// ===== Label values ==========================================================
|
|
|
|
/**
|
|
* `kLabelResult` value: the object was found in the NodeStore.
|
|
*/
|
|
inline constexpr char kResultHit[] = "hit";
|
|
|
|
/**
|
|
* `kLabelResult` value: the object was not found.
|
|
*/
|
|
inline constexpr char kResultMiss[] = "miss";
|
|
|
|
/**
|
|
* `kLabelReason` value: more objects requested than the handler accepts.
|
|
*/
|
|
inline constexpr char kReasonOversize[] = "oversize";
|
|
|
|
/**
|
|
* `kLabelReason` value: the ledger hash was not uint256-sized.
|
|
*/
|
|
inline constexpr char kReasonMalformedLedgerHash[] = "malformed_ledgerhash";
|
|
|
|
// ===== Instrument descriptions ===============================================
|
|
|
|
/** @{ */
|
|
inline constexpr char kGetObjectRejectedTotalDesc[] =
|
|
"TMGetObjectByHash requests refused before any NodeStore access, by reason";
|
|
|
|
inline constexpr char kGetObjectRequestObjectsDesc[] =
|
|
"Objects requested per TMGetObjectByHash message";
|
|
|
|
inline constexpr char kGetObjectLookupUsDesc[] =
|
|
"Time spent in the TMGetObjectByHash NodeStore fetch loop, in microseconds";
|
|
|
|
inline constexpr char kGetObjectLookupsTotalDesc[] =
|
|
"TMGetObjectByHash NodeStore lookups, by hit/miss result";
|
|
|
|
inline constexpr char kGetObjectChargeDesc[] =
|
|
"Dynamic resource charge applied per TMGetObjectByHash request";
|
|
/** @} */
|
|
|
|
} // namespace xrpl::telemetry
|