Remove getMetrics endpoint

Author: lpahlavi

Cargo.lock

@@ -60,6 +60,7 @@ evm_rpc_client = { path = "evm_rpc_client" }
 ic-crypto-test-utils-reproducible-rng = { git = "https://github.com/dfinity/ic", rev = "release-2024-09-26_01-31-base" }
 ic-error-types = { workspace = true }
 ic-management-canister-types = { workspace = true }
+ic-metrics-assert = { workspace = true }
 ic-test-utilities-load-wasm = { git = "https://github.com/dfinity/ic", rev = "release-2024-09-26_01-31-base" }
 maplit = "1"
 pocket-ic = { workspace = true }
@@ -94,6 +95,7 @@ ic-cdk-macros = "0.17.2"
 ic-certified-map = "0.4"
 ic-error-types = "0.2"
 ic-management-canister-types = "0.3"
+ic-metrics-assert = { version = "0.1.1", features = ["pocket_ic"] }
 ic-metrics-encoder = "1.1"
 ic-stable-structures = "0.6.8"
 itertools = "0.14.0"

Cargo.toml

@@ -138,14 +138,6 @@ type LogEntry = record {
   logIndex : opt nat;
   removed : bool;
 };
-type Metrics = record {
-  requests : vec record { record { text; text }; nat64 };
-  responses : vec record { record { text; text; text }; nat64 };
-  inconsistentResponses : vec record { record { text; text }; nat64 };
-  cyclesCharged : vec record { record { text; text }; nat };
-  errHttpOutcall : vec record { record { text; text; RejectionCode }; nat64 };
-  errMaxResponseSizeExceeded : vec record { record { text; text }; nat64 };
-};
 type MultiFeeHistoryResult = variant {
   Consistent : FeeHistoryResult;
   Inconsistent : vec record { RpcService; FeeHistoryResult };
@@ -312,10 +304,7 @@ service : (InstallArgs) -> {
   eth_call : (RpcServices, opt RpcConfig, CallArgs) -> (MultiCallResult);
   request : (RpcService, json : text, maxResponseBytes : nat64) -> (RequestResult);
   requestCost : (RpcService, json : text, maxResponseBytes : nat64) -> (RequestCostResult) query;
-  
-  // DEBUG endpoint to retrieve metrics accumulated by the EVM RPC canister.
-  // NOTE: this method exists for debugging purposes, backward compatibility is not guaranteed.
-  getMetrics : () -> (Metrics) query;
+
   getNodesInSubnet : () -> (numberOfNodes : nat32) query;
   getProviders : () -> (vec Provider) query;
   getServiceProviderMap : () -> (vec record { RpcService; ProviderId }) query;

candid/evm_rpc.did

@@ -1,22 +1,21 @@
 use candid::candid_method;
-use canhttp::multi::Timestamp;
-use canhttp::{CyclesChargingPolicy, CyclesCostEstimator};
+use canhttp::{multi::Timestamp, CyclesChargingPolicy, CyclesCostEstimator};
 use canlog::{Log, Sort};
-use evm_rpc::candid_rpc::CandidRpcClient;
-use evm_rpc::http::{service_request_builder, ChargingPolicyWithCollateral};
-use evm_rpc::logs::{Priority, INFO};
-use evm_rpc::memory::{
-    get_num_subnet_nodes, insert_api_key, is_api_key_principal, is_demo_active, remove_api_key,
-    set_api_key_principals, set_demo_active, set_log_filter, set_num_subnet_nodes,
-    set_override_provider,
-};
-use evm_rpc::metrics::encode_metrics;
-use evm_rpc::providers::{find_provider, resolve_rpc_service, PROVIDERS, SERVICE_PROVIDER_MAP};
-use evm_rpc::types::{OverrideProvider, Provider, ProviderId, RpcAccess, RpcAuth};
 use evm_rpc::{
-    http::{json_rpc_request, json_rpc_request_arg, transform_http_request},
-    memory::UNSTABLE_METRICS,
-    types::Metrics,
+    candid_rpc::CandidRpcClient,
+    http::{
+        json_rpc_request, json_rpc_request_arg, service_request_builder, transform_http_request,
+        ChargingPolicyWithCollateral,
+    },
+    logs::{Priority, INFO},
+    memory::{
+        get_num_subnet_nodes, insert_api_key, is_api_key_principal, is_demo_active, remove_api_key,
+        set_api_key_principals, set_demo_active, set_log_filter, set_num_subnet_nodes,
+        set_override_provider,
+    },
+    metrics::encode_metrics,
+    providers::{find_provider, resolve_rpc_service, PROVIDERS, SERVICE_PROVIDER_MAP},
+    types::{OverrideProvider, Provider, ProviderId, RpcAccess, RpcAuth},
 };
 use evm_rpc_types::{Hex32, HttpOutcallError, MultiRpcResult, RpcConfig, RpcResult};
 use ic_canister_log::log;
@@ -406,12 +405,6 @@ fn http_request(request: HttpRequest) -> HttpResponse {
     }
 }
 
-#[query(name = "getMetrics")]
-#[candid_method(query, rename = "getMetrics")]
-fn get_metrics() -> Metrics {
-    UNSTABLE_METRICS.with(|metrics| (*metrics.borrow()).clone())
-}
-
 fn now() -> Timestamp {
     Timestamp::from_nanos_since_unix_epoch(ic_cdk::api::time())
 }

src/main.rs

@@ -104,6 +104,11 @@ pub fn encode_metrics(w: &mut ic_metrics_encoder::MetricsEncoder<Vec<u8>>) -> st
             &m.err_http_outcall,
             "Number of unsuccessful HTTP outcalls",
         );
+        w.counter_entries(
+            "evmrpc_err_max_response_size_exceeded",
+            &m.err_max_response_size_exceeded,
+            "Number of HTTP outcalls with max response size exceeded",
+        );
 
         Ok(())
     })

src/metrics.rs

@@ -5,7 +5,6 @@ use crate::{
 };
 use candid::{CandidType, Decode, Encode, Nat, Principal};
 use canlog::{Log, LogEntry};
-use evm_rpc::types::Metrics;
 use evm_rpc::{
     logs::Priority,
     providers::PROVIDERS,
@@ -16,6 +15,8 @@ use evm_rpc_types::{InstallArgs, Provider, RpcResult, RpcService};
 use ic_cdk::api::management_canister::main::CanisterId;
 use ic_http_types::{HttpRequest, HttpResponse};
 use ic_management_canister_types::CanisterSettings;
+use ic_metrics_assert::{MetricsAssert, PocketIcAsyncHttpQuery};
+use pocket_ic::nonblocking::PocketIc;
 use pocket_ic::{nonblocking, ErrorCode, PocketIcBuilder};
 use serde::de::DeserializeOwned;
 use std::sync::{Arc, Mutex};
@@ -169,11 +170,6 @@ impl EvmRpcSetup {
             .entries
     }
 
-    pub async fn get_metrics(&self) -> Metrics {
-        self.call_query("getMetrics", Encode!().unwrap(), Principal::anonymous())
-            .await
-    }
-
     pub async fn get_service_provider_map(&self) -> Vec<(RpcService, ProviderId)> {
         self.call_query(
             "getServiceProviderMap",
@@ -197,6 +193,10 @@ impl EvmRpcSetup {
         .await
     }
 
+    pub async fn check_metrics(self) -> MetricsAssert<Self> {
+        MetricsAssert::from_async_http_query(self).await
+    }
+
     // Legacy endpoint, not supported by the `evm_rpc_client::EvmRpcClient`
     pub async fn request(
         &self,
@@ -258,3 +258,13 @@ impl EvmRpcSetup {
         Decode!(candid, R).expect("error while decoding Candid response from query call")
     }
 }
+
+impl PocketIcAsyncHttpQuery for EvmRpcSetup {
+    fn get_pocket_ic(&self) -> &PocketIc {
+        &self.env
+    }
+
+    fn get_canister_id(&self) -> ic_management_canister_types::CanisterId {
+        self.canister_id
+    }
+}