/** * Parser for the [telemetry] section of xrpld.cfg. * * Reads configuration values from the config file and populates a * Telemetry::Setup struct. All options have sensible defaults so the * section can be minimal or omitted entirely. * * See cfg/xrpld-example.cfg for the full list of available options. */ #include #include #include #include #include #include #include namespace xrpl::telemetry { namespace { /** * Config key names for the [telemetry] section. * * Each must match the corresponding option documented in * cfg/xrpld-example.cfg verbatim. Defined as `char const*` so they * pass to Section::valueOr() (which takes `std::string const&`) * without an explicit conversion, exactly as a literal would. */ namespace key { constexpr char const* enabled = "enabled"; constexpr char const* serviceName = "service_name"; constexpr char const* serviceInstanceId = "service_instance_id"; constexpr char const* endpoint = "endpoint"; constexpr char const* useTls = "use_tls"; constexpr char const* tlsCaCert = "tls_ca_cert"; constexpr char const* tlsClientCert = "tls_client_cert"; constexpr char const* tlsClientKey = "tls_client_key"; constexpr char const* batchSize = "batch_size"; constexpr char const* batchDelayMs = "batch_delay_ms"; constexpr char const* maxQueueSize = "max_queue_size"; constexpr char const* traceTransactions = "trace_transactions"; constexpr char const* traceConsensus = "trace_consensus"; constexpr char const* traceRpc = "trace_rpc"; constexpr char const* tracePeer = "trace_peer"; constexpr char const* traceLedger = "trace_ledger"; } // namespace key /** * Default values applied when a key is absent from the config. * * @note serviceName mirrors SystemParameters' systemName() ("xrpld") but * is duplicated here as a literal: the telemetry module deliberately does * not link xrpl.libxrpl.protocol, so including SystemParameters.h would * introduce an undeclared cross-module dependency. */ namespace dflt { constexpr char const* serviceName = "xrpld"; constexpr char const* endpoint = "http://localhost:4318/v1/traces"; constexpr std::uint32_t batchSize = 512u; constexpr std::uint32_t batchDelayMs = 5000u; constexpr std::uint32_t maxQueueSize = 2048u; } // namespace dflt } // namespace /** * Derive a human-readable network type label from the numeric network ID. * * Declared in Telemetry.h; shared by the trace and metric export paths so * both stamp the same xrpl.network.type resource attribute value. * * @param networkId The network identifier from [network_id] config. * @return "mainnet", "testnet", "devnet", or "unknown" for other values. */ std::string networkTypeFromId(std::uint32_t networkId) { switch (networkId) { case 0: return "mainnet"; case 1: return "testnet"; case 2: return "devnet"; default: return "unknown"; } } Telemetry::Setup makeTelemetrySetup( Section const& section, std::string const& nodePublicKey, std::string const& version, std::uint32_t networkId) { Telemetry::Setup setup; setup.enabled = section.valueOr(key::enabled, 0) != 0; setup.serviceName = section.valueOr(key::serviceName, dflt::serviceName); setup.serviceVersion = version; setup.serviceInstanceId = section.valueOr(key::serviceInstanceId, nodePublicKey); setup.exporterEndpoint = section.valueOr(key::endpoint, dflt::endpoint); setup.useTls = section.valueOr(key::useTls, 0) != 0; setup.tlsCertPath = section.valueOr(key::tlsCaCert, ""); setup.tlsClientCertPath = section.valueOr(key::tlsClientCert, ""); setup.tlsClientKeyPath = section.valueOr(key::tlsClientKey, ""); // Mutual TLS needs both the client certificate and its private key. // Supplying only one fails later with a cryptic SSL handshake error, so // reject the partial configuration here with an actionable message. if (setup.tlsClientCertPath.empty() != setup.tlsClientKeyPath.empty()) { Throw( "[telemetry] tls_client_cert and tls_client_key must be set together " "(set both for mutual TLS, or neither for one-way TLS)."); } // Mutual TLS only takes effect when TLS is on. Certificate paths set with // use_tls=0 would be silently ignored and the exporter would connect in // plaintext, so reject that contradiction instead of failing open. if (!setup.tlsClientCertPath.empty() && !setup.useTls) { Throw( "[telemetry] tls_client_cert/tls_client_key require use_tls=1 " "(set use_tls=1 to enable mutual TLS, or remove the cert paths)."); } // Head sampling is intentionally fixed at 1.0 (sample everything) and is // not read from config. A per-node ratio would let nodes make divergent // keep/drop decisions for the same distributed trace, producing broken // traces; volume reduction is delegated to the collector's tail sampling. // setup.samplingRatio is a const member fixed at 1.0; nothing to parse. setup.batchSize = section.valueOr(key::batchSize, dflt::batchSize); setup.batchDelay = std::chrono::milliseconds{ section.valueOr(key::batchDelayMs, dflt::batchDelayMs)}; setup.maxQueueSize = section.valueOr(key::maxQueueSize, dflt::maxQueueSize); setup.networkId = networkId; setup.networkType = networkTypeFromId(networkId); setup.traceTransactions = section.valueOr(key::traceTransactions, 1) != 0; setup.traceConsensus = section.valueOr(key::traceConsensus, 1) != 0; setup.traceRpc = section.valueOr(key::traceRpc, 1) != 0; setup.tracePeer = section.valueOr(key::tracePeer, 1) != 0; setup.traceLedger = section.valueOr(key::traceLedger, 1) != 0; setup.consensusTraceStrategy = section.valueOr("consensus_trace_strategy", "deterministic"); return setup; } } // namespace xrpl::telemetry