kylefang/stacks-puppet-node
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-04-29 04:05:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: histogram for signer -> node RPC latency

Browse Source
This commit is contained in:
Hank Stoever
2024-04-29 16:41:53 -07:00
parent 544fcf63cc
commit 9154bb7935
3 changed files with 61 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
stacks-signer/src/client/stacks_client.rs
View File

@@ -207,6 +207,9 @@ impl StacksClient {
estimated_len: Some(tx.tx_len()),
transaction_payload: to_hex(&tx.payload.serialize_to_vec()),
};
#[cfg(feature = "monitoring_prom")]
let timer =
crate::monitoring::new_rpc_call_timer(&self.fees_transaction_path(), &self.http_origin);
let send_request = || {
self.stacks_node_client
.post(self.fees_transaction_path())
@@ -215,6 +218,8 @@ impl StacksClient {
.send()
.map_err(backoff::Error::transient)
};
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
let response = retry_with_exponential_backoff(send_request)?;
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
@@ -268,6 +273,9 @@ impl StacksClient {
block,
chain_id: self.chain_id,
};
#[cfg(feature = "monitoring_prom")]
let timer =
crate::monitoring::new_rpc_call_timer(&self.block_proposal_path(), &self.http_origin);
let send_request = || {
self.stacks_node_client
.post(self.block_proposal_path())
@@ -279,6 +287,8 @@ impl StacksClient {
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -355,6 +365,9 @@ impl StacksClient {
/// Get the current peer info data from the stacks node
pub fn get_peer_info(&self) -> Result<RPCPeerInfoData, ClientError> {
debug!("Getting stacks node info...");
#[cfg(feature = "monitoring_prom")]
let timer =
crate::monitoring::new_rpc_call_timer(&self.core_info_path(), &self.http_origin);
let send_request = || {
self.stacks_node_client
.get(self.core_info_path())
@@ -362,6 +375,8 @@ impl StacksClient {
.map_err(backoff::Error::transient)
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -402,6 +417,11 @@ impl StacksClient {
reward_cycle: u64,
) -> Result<Option<Vec<NakamotoSignerEntry>>, ClientError> {
debug!("Getting reward set for reward cycle {reward_cycle}...");
#[cfg(feature = "monitoring_prom")]
let timer = crate::monitoring::new_rpc_call_timer(
&self.reward_set_path(reward_cycle),
&self.http_origin,
);
let send_request = || {
self.stacks_node_client
.get(self.reward_set_path(reward_cycle))
@@ -409,6 +429,8 @@ impl StacksClient {
.map_err(backoff::Error::transient)
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -419,6 +441,8 @@ impl StacksClient {
/// Retreive the current pox data from the stacks node
pub fn get_pox_data(&self) -> Result<RPCPoxInfoData, ClientError> {
debug!("Getting pox data...");
#[cfg(feature = "monitoring_prom")]
let timer = crate::monitoring::new_rpc_call_timer(&self.pox_path(), &self.http_origin);
let send_request = || {
self.stacks_node_client
.get(self.pox_path())
@@ -426,6 +450,8 @@ impl StacksClient {
.map_err(backoff::Error::transient)
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -463,6 +489,9 @@ impl StacksClient {
address: &StacksAddress,
) -> Result<AccountEntryResponse, ClientError> {
debug!("Getting account info...");
#[cfg(feature = "monitoring_prom")]
let timer =
crate::monitoring::new_rpc_call_timer(&self.accounts_path(address), &self.http_origin);
let send_request = || {
self.stacks_node_client
.get(self.accounts_path(address))
@@ -470,6 +499,8 @@ impl StacksClient {
.map_err(backoff::Error::transient)
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -536,6 +567,9 @@ impl StacksClient {
pub fn submit_transaction(&self, tx: &StacksTransaction) -> Result<Txid, ClientError> {
let txid = tx.txid();
let tx = tx.serialize_to_vec();
#[cfg(feature = "monitoring_prom")]
let timer =
crate::monitoring::new_rpc_call_timer(&self.transaction_path(), &self.http_origin);
let send_request = || {
self.stacks_node_client
.post(self.transaction_path())
@@ -548,6 +582,8 @@ impl StacksClient {
})
};
let response = retry_with_exponential_backoff(send_request)?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}
@@ -576,12 +612,16 @@ impl StacksClient {
let body =
json!({"sender": self.stacks_address.to_string(), "arguments": args}).to_string();
let path = self.read_only_path(contract_addr, contract_name, function_name);
#[cfg(feature = "monitoring_prom")]
let timer = crate::monitoring::new_rpc_call_timer(&path, &self.http_origin);
let response = self
.stacks_node_client
.post(path)
.header("Content-Type", "application/json")
.body(body)
.send()?;
#[cfg(feature = "monitoring_prom")]
timer.stop_and_record();
if !response.status().is_success() {
return Err(ClientError::RequestFailure(response.status()));
}

12
stacks-signer/src/monitoring/mod.rs
View File

@@ -14,6 +14,8 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#[cfg(feature = "monitoring_prom")]
use ::prometheus::HistogramTimer;
#[cfg(feature = "monitoring_prom")]
use slog::slog_error;
#[cfg(not(feature = "monitoring_prom"))]
@@ -136,6 +138,16 @@ pub fn update_signer_nonce(nonce: u64) {
prometheus::SIGNER_NONCE.set(nonce as i64);
}
/// Start a new RPC call timer.
/// The `origin` parameter is the base path of the RPC call, e.g. `http://node.com`.
/// The `origin` parameter is removed from `full_path` when storing in prometheus.
#[cfg(feature = "monitoring_prom")]
pub fn new_rpc_call_timer(full_path: &str, origin: &String) -> HistogramTimer {
let path = &full_path[origin.len()..];
let histogram = prometheus::SIGNER_RPC_CALL_LATENCIES_HISTOGRAM.with_label_values(&[path]);
histogram.start_timer()
}
/// Start serving monitoring metrics.
/// This will only serve the metrics if the `monitoring_prom` feature is enabled.
#[allow(unused_variables)]

11
stacks-signer/src/monitoring/prometheus.rs
View File

@@ -16,8 +16,9 @@
use lazy_static::lazy_static;
use prometheus::{
gather, opts, register_int_counter, register_int_counter_vec, register_int_gauge, Encoder,
IntCounter, IntCounterVec, IntGauge, TextEncoder,
gather, histogram_opts, opts, register_histogram_vec, register_int_counter,
register_int_counter_vec, register_int_gauge, Encoder, HistogramVec, IntCounter, IntCounterVec,
IntGauge, TextEncoder,
};
lazy_static! {
@@ -87,6 +88,12 @@ lazy_static! {
"stacks_signer_nonce",
"The current nonce of the signer"
)).unwrap();
pub static ref SIGNER_RPC_CALL_LATENCIES_HISTOGRAM: HistogramVec = register_histogram_vec!(histogram_opts!(
"stacks_signer_node_rpc_call_latencies_histogram",
"Time (seconds) measuring round-trip RPC call latency to the Stacks node"
// Will use DEFAULT_BUCKETS = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1.0, 2.5, 5.0, 10.0] by default
), &["path"]).unwrap();
}
pub fn gather_metrics_string() -> String {