forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #6267: feat(stats): split off transmission to
RawSender, impl…
…ement batching and queueing support, add streamlined prefix and suffix support cc1a75a docs: add release notes (Kittywhiskers Van Gogh) 39625f1 stats: drop copyright notice from `stats/client.cpp` (Kittywhiskers Van Gogh) 18a2e48 stats: rename `statsns` to clearer `statsprefix` (Kittywhiskers Van Gogh) 42918c2 stats: rename `statshostname` to more appropriate `statssuffix` (Kittywhiskers Van Gogh) f3a4844 stats: implicitly treat stats as enabled if `statshost` is specified (Kittywhiskers Van Gogh) 69603a8 stats: miscellaneous changes and housekeeping (Kittywhiskers Van Gogh) 3e12ac0 stats: deduplicate `send` and `sendDouble` logic (Kittywhiskers Van Gogh) bf44fc3 feat(stats): introduce support for batching messages (Kittywhiskers Van Gogh) 38b1643 feat(stats): introduce support for queuing messages (Kittywhiskers Van Gogh) fc4a736 stats: move message sending logic to `RawSender` (Kittywhiskers Van Gogh) 9269068 stats: move `statsd_client` to `stats` directory (Kittywhiskers Van Gogh) f782dfd stats: remove double indentation in header file (Kittywhiskers Van Gogh) Pull request description: ## Motivation This pull request achieves the goal originally set out in [dash#5167](#5167), to migrate the base of our Statsd client implementation to one that is actively maintained. Statoshi ([source](https://github.com/jlopp/statoshi/blob/54c3ffdcf0f85af1795d5398ca362744464a7b06/src/statsd_client.cpp)) utilizes [talebook/statsd-client-cpp](https://github.com/talebook/statsd-client-cpp), which in turn is inherited by Dash. As Statsd is the only cross-platform reporting mechanism available (USDT requires a Linux host with superuser privileges and RPCs don't provide as much flexibility as desired), emphasis is placed on using Statsd as the primary way for the Dash daemon to report metrics related to node and network health. As part of maintaining our Statsd client, this PR aims to migrate the base of our implementation to [vthiery/cpp-statsd-client](https://github.com/vthiery/cpp-statsd-client), a streamlined implementation that embraces C++11 with a thread-safe implementation of queueing and batching, which reduces the number of packets used to transmit stats. These capabilities are optional and users can opt not to use them by setting `-statsduration=0` to disable queueing (which will also disable batching) or `-statsbatchsize=0`, which will disable batching (but will not disable queueing unless requested explicitly). ## Additional Information * Dependent on #5167 * `RawSender` (and by extension, `RawMessage`) strive to remain as unopinionated as possible, moving the responsibility to construct valid Statsd messages onto `StatsdClient`. This is to ensure that `RawSender` can be reused down the line or independently extended without impacting the Statsd client. * `RawMessage` exists to provide extensions to `std::vector<uint8_t>` that make it easier to abstract away strings while also implementing some of its semantics like `append()` (and its alias, `+=`). * `InitStatsClient()` was introduced to keep `StatsdClient` indifferent to _how_ arguments are obtained and sanitized before they're supplied to the constructor. This is to keep it indifferent to all the backwards-compatibility code for deprecated arguments still work. * When constructing the Statsd message, we can use `%f` without having to specify a precision as tinyformat automatically assumes a precision of 6 ([source](https://github.com/dashpay/dash/blob/17110f50b3adb1b8a51348259e752a760ab3ee0a/src/tinyformat.h#L673)) and problems don't seem to be observed when using `%f` with integers ([source](#6267 (comment))). * As a guardrail, there is a `static_assert` to ensure that a specialization of `send()` involving a non-arithmetic type will raise alarm when compiling ([source](https://github.com/dashpay/dash/blob/a0ce720207cf010cf8af8be7acd30561ed970b30/src/stats/client.cpp#L145)). ## Breaking changes * `-statsenabled` (replaced with specifying `-statshost`), `-statshostname` (replaced by `-statssuffix`) and `-statsns` (replaced by `-statsprefix`) have been deprecated and will be removed in a future release. ## Checklist: - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have added or updated relevant unit/integration/functional/e2e tests **(note: N/A)** - [x] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: knst: utACK cc1a75a UdjinM6: utACK cc1a75a Tree-SHA512: b038419f2b6d807dac40a04d23c5046fbaa95beedb88f5a9e4c06a7042c2f5da7e01c72c4a2744bce10878cafc747136d6599dcd86ae1be0782ad4194d5b7bec
- Loading branch information
Showing
17 changed files
with
584 additions
and
299 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Statistics | ||
| ----------- | ||
|
|
||
| ### New Features | ||
|
|
||
| - The Statsd client now supports queueing and batching messages, reducing the number of packets and the rate at which | ||
| they are sent to the Statsd daemon. | ||
|
|
||
| - The maximum size of each batch of messages (default, 1KiB) can be adjusted using `-statsbatchsize` (in bytes) | ||
| and the frequency at which queued messages are sent to the daemon (default, 1 second) can be adjusted using | ||
| `-statsduration` (in milliseconds) | ||
| - `-statsduration` has no bearing on `-statsperiod`, which dictates how frequently some stats are _collected_. | ||
|
|
||
| ### Deprecations | ||
|
|
||
| - `-statsenabled` has been deprecated and enablement will now be implied by the presence of `-statshost`. `-statsenabled` | ||
| will be removed in a future release. | ||
|
|
||
| - `-statshostname` has been deprecated and replaced with `-statssuffix` as the latter is better representative of the | ||
| argument's purpose. They behave identically to each other. `-statshostname` will be removed in a future | ||
| release. | ||
|
|
||
| - `-statsns` has been deprecated and replaced with `-statsprefix` as the latter is better representative of the | ||
| argument's purpose. `-statsprefix`, unlike `-statsns`, will enforce the usage of a delimiter between the prefix | ||
| and key. `-statsns` will be removed in a future release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| // Copyright (c) 2014-2017 Statoshi Developers | ||
| // Copyright (c) 2017-2023 Vincent Thiery | ||
| // Copyright (c) 2020-2024 The Dash Core developers | ||
| // Distributed under the MIT software license, see the accompanying | ||
| // file COPYING or http://www.opensource.org/licenses/mit-license.php. | ||
|
|
||
| #include <stats/client.h> | ||
|
|
||
| #include <stats/rawsender.h> | ||
| #include <util/system.h> | ||
|
|
||
| #include <cmath> | ||
| #include <cstdio> | ||
| #include <random> | ||
|
|
||
| namespace { | ||
| /** Threshold below which a value is considered effectively zero */ | ||
| static constexpr float EPSILON{0.0001f}; | ||
|
|
||
| /** Delimiter segmenting two fully formed Statsd messages */ | ||
| static constexpr char STATSD_MSG_DELIMITER{'\n'}; | ||
| /** Delimiter segmenting namespaces in a Statsd key */ | ||
| static constexpr char STATSD_NS_DELIMITER{'.'}; | ||
| /** Character used to denote Statsd message type as count */ | ||
| static constexpr char STATSD_METRIC_COUNT[]{"c"}; | ||
| /** Character used to denote Statsd message type as gauge */ | ||
| static constexpr char STATSD_METRIC_GAUGE[]{"g"}; | ||
| /** Characters used to denote Statsd message type as timing */ | ||
| static constexpr char STATSD_METRIC_TIMING[]{"ms"}; | ||
| } // anonymous namespace | ||
|
|
||
| std::unique_ptr<StatsdClient> g_stats_client; | ||
|
|
||
| std::unique_ptr<StatsdClient> InitStatsClient(const ArgsManager& args) | ||
| { | ||
| auto is_enabled = args.GetBoolArg("-statsenabled", /*fDefault=*/false); | ||
| auto host = args.GetArg("-statshost", /*fDefault=*/""); | ||
|
|
||
| if (is_enabled && host.empty()) { | ||
| // Stats are enabled but host has not been specified, then use | ||
| // default host. This is to preserve old behavior. | ||
| host = DEFAULT_STATSD_HOST; | ||
| } else if (!host.empty()) { | ||
| // Host is specified but stats are not explcitly enabled. Assume | ||
| // that if a host has been specified, we want stats enabled. This | ||
| // is new behaviour and will substitute old behaviour in a future | ||
| // release. | ||
| is_enabled = true; | ||
| } | ||
|
|
||
| auto sanitize_string = [](std::string& string) { | ||
| // Remove key delimiters from the front and back as they're added back | ||
| if (!string.empty()) { | ||
| if (string.front() == STATSD_NS_DELIMITER) string.erase(string.begin()); | ||
| if (string.back() == STATSD_NS_DELIMITER) string.pop_back(); | ||
| } | ||
| }; | ||
|
|
||
| // Get our prefix and suffix and if we get nothing, try again with the | ||
| // deprecated argument. If we still get nothing, that's fine, they're optional. | ||
| auto prefix = args.GetArg("-statsprefix", DEFAULT_STATSD_PREFIX); | ||
| if (prefix.empty()) { | ||
| prefix = args.GetArg("-statsns", DEFAULT_STATSD_PREFIX); | ||
| } else { | ||
| // We restrict sanitization logic to our newly added arguments to | ||
| // prevent breaking changes. | ||
| sanitize_string(prefix); | ||
| // We need to add the delimiter here for backwards compatibility with | ||
| // the deprecated argument. | ||
| // | ||
| // TODO: Move this step into the constructor when removing deprecated | ||
| // args support | ||
| prefix += STATSD_NS_DELIMITER; | ||
| } | ||
|
|
||
| auto suffix = args.GetArg("-statssuffix", DEFAULT_STATSD_SUFFIX); | ||
| if (suffix.empty()) { | ||
| suffix = args.GetArg("-statshostname", DEFAULT_STATSD_SUFFIX); | ||
| } else { | ||
| // We restrict sanitization logic to our newly added arguments to | ||
| // prevent breaking changes. | ||
| sanitize_string(suffix); | ||
| } | ||
|
|
||
| return std::make_unique<StatsdClient>( | ||
| host, | ||
| args.GetArg("-statsport", DEFAULT_STATSD_PORT), | ||
| args.GetArg("-statsbatchsize", DEFAULT_STATSD_BATCH_SIZE), | ||
| args.GetArg("-statsduration", DEFAULT_STATSD_DURATION), | ||
| prefix, | ||
| suffix, | ||
| is_enabled | ||
| ); | ||
| } | ||
|
|
||
| StatsdClient::StatsdClient(const std::string& host, uint16_t port, uint64_t batch_size, uint64_t interval_ms, | ||
| const std::string& prefix, const std::string& suffix, bool enabled) : | ||
| m_prefix{prefix}, | ||
| m_suffix{[suffix]() { return !suffix.empty() ? STATSD_NS_DELIMITER + suffix : suffix; }()} | ||
| { | ||
| if (!enabled) { | ||
| LogPrintf("Transmitting stats are disabled, will not init StatsdClient\n"); | ||
| return; | ||
| } | ||
|
|
||
| std::optional<std::string> error_opt; | ||
| m_sender = std::make_unique<RawSender>(host, port, | ||
| std::make_pair(batch_size, static_cast<uint8_t>(STATSD_MSG_DELIMITER)), | ||
| interval_ms, error_opt); | ||
| if (error_opt.has_value()) { | ||
| LogPrintf("ERROR: %s, cannot initialize StatsdClient.\n", error_opt.value()); | ||
| m_sender.reset(); | ||
| return; | ||
| } | ||
|
|
||
| LogPrintf("StatsdClient initialized to transmit stats to %s:%d\n", host, port); | ||
| } | ||
|
|
||
| StatsdClient::~StatsdClient() {} | ||
|
|
||
| bool StatsdClient::dec(const std::string& key, float sample_rate) { return count(key, -1, sample_rate); } | ||
|
|
||
| bool StatsdClient::inc(const std::string& key, float sample_rate) { return count(key, 1, sample_rate); } | ||
|
|
||
| bool StatsdClient::count(const std::string& key, int64_t delta, float sample_rate) | ||
| { | ||
| return send(key, delta, STATSD_METRIC_COUNT, sample_rate); | ||
| } | ||
|
|
||
| bool StatsdClient::gauge(const std::string& key, int64_t value, float sample_rate) | ||
| { | ||
| return send(key, value, STATSD_METRIC_GAUGE, sample_rate); | ||
| } | ||
|
|
||
| bool StatsdClient::gaugeDouble(const std::string& key, double value, float sample_rate) | ||
| { | ||
| return send(key, value, STATSD_METRIC_GAUGE, sample_rate); | ||
| } | ||
|
|
||
| bool StatsdClient::timing(const std::string& key, uint64_t ms, float sample_rate) | ||
| { | ||
| return send(key, ms, STATSD_METRIC_TIMING, sample_rate); | ||
| } | ||
|
|
||
| template <typename T1> | ||
| bool StatsdClient::send(const std::string& key, T1 value, const std::string& type, float sample_rate) | ||
| { | ||
| static_assert(std::is_arithmetic<T1>::value, "Must specialize to an arithmetic type"); | ||
|
|
||
| if (!m_sender) { | ||
| return false; | ||
| } | ||
|
|
||
| // Determine if we should send the message at all but claim that we did even if we don't | ||
| sample_rate = std::clamp(sample_rate, 0.f, 1.f); | ||
| bool always_send = std::fabs(sample_rate - 1.f) < EPSILON; | ||
| bool never_send = std::fabs(sample_rate) < EPSILON; | ||
| if (never_send || (!always_send && | ||
| WITH_LOCK(cs, return sample_rate < std::uniform_real_distribution<float>(0.f, 1.f)(insecure_rand)))) { | ||
| return true; | ||
| } | ||
|
|
||
| // Construct the message and if our message isn't always-send, report the sample rate | ||
| RawMessage msg{strprintf("%s%s%s:%f|%s", m_prefix, key, m_suffix, value, type)}; | ||
| if (!always_send) { | ||
| msg += strprintf("|@%.2f", sample_rate); | ||
| } | ||
|
|
||
| // Send it and report an error if we encounter one | ||
| if (auto error_opt = m_sender->Send(msg); error_opt.has_value()) { | ||
| LogPrintf("ERROR: %s.\n", error_opt.value()); | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| template bool StatsdClient::send(const std::string& key, double value, const std::string& type, float sample_rate); | ||
| template bool StatsdClient::send(const std::string& key, int32_t value, const std::string& type, float sample_rate); | ||
| template bool StatsdClient::send(const std::string& key, int64_t value, const std::string& type, float sample_rate); | ||
| template bool StatsdClient::send(const std::string& key, uint32_t value, const std::string& type, float sample_rate); | ||
| template bool StatsdClient::send(const std::string& key, uint64_t value, const std::string& type, float sample_rate); |
Oops, something went wrong.