Skip to content

Commit

Permalink
Revert "Add optional structured logs of RPC related events"
Browse files Browse the repository at this point in the history 
This reverts commit 4e0dfce.
  • Loading branch information
@shesek
shesek authored Feb 24, 2024
1 parent 8e730b1 commit 7dd7e8f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 92 deletions.
36 changes: 0 additions & 36 deletions src/config.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ pub struct Config {
pub utxos_limit: usize,
pub electrum_txs_limit: usize,
pub electrum_banner: String,
pub rpc_logging: Option<RpcLogging>,

#[cfg(feature = "liquid")]
pub parent_network: BNetwork,
Expand All @@ -66,10 +65,6 @@ fn str_to_socketaddr(address: &str, what: &str) -> SocketAddr {
impl Config {
pub fn from_args() -> Config {
let network_help = format!("Select network type ({})", Network::names().join(", "));
let rpc_logging_help = format!(
"Select RPC logging option ({})",
RpcLogging::options().join(", ")
);

let args = App::new("Electrum Rust Server")
.version(crate_version!())
Expand Down Expand Up @@ -186,11 +181,6 @@ impl Config {
.long("electrum-banner")
.help("Welcome banner for the Electrum server, shown in the console to clients.")
.takes_value(true)
).arg(
Arg::with_name("rpc_logging")
.long("rpc-logging")
.help(&rpc_logging_help)
.takes_value(true),
);

#[cfg(unix)]
Expand Down Expand Up @@ -391,9 +381,6 @@ impl Config {
electrum_rpc_addr,
electrum_txs_limit: value_t_or_exit!(m, "electrum_txs_limit", usize),
electrum_banner,
rpc_logging: m
.value_of("rpc_logging")
.map(|option| RpcLogging::from(option)),
http_addr,
http_socket_file,
monitoring_addr,
Expand Down Expand Up @@ -433,29 +420,6 @@ impl Config {
}
}

#[derive(Debug, Clone)]
pub enum RpcLogging {
Full,
NoParams,
}

impl RpcLogging {
pub fn options() -> Vec<String> {
return vec!["full".to_string(), "no-params".to_string()];
}
}

impl From<&str> for RpcLogging {
fn from(option: &str) -> Self {
match option {
"full" => RpcLogging::Full,
"no-params" => RpcLogging::NoParams,

_ => panic!("unsupported RPC logging option: {:?}", option),
}
}
}

pub fn get_network_subdir(network: Network) -> Option<&'static str> {
match network {
#[cfg(not(feature = "liquid"))]
Expand Down
58 changes: 2 additions & 56 deletions src/electrum/server.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use bitcoin::consensus::encode::serialize_hex;
use elements::encode::serialize_hex;

use crate::chain::Txid;
use crate::config::{Config, RpcLogging};
use crate::config::Config;
use crate::electrum::{get_electrum_height, ProtocolVersion};
use crate::errors::*;
use crate::metrics::{Gauge, HistogramOpts, HistogramVec, MetricOpts, Metrics};
Expand Down Expand Up @@ -101,7 +101,6 @@ struct Connection {
txs_limit: usize,
#[cfg(feature = "electrum-discovery")]
discovery: Option<Arc<DiscoveryManager>>,
rpc_logging: Option<RpcLogging>,
}

impl Connection {
Expand All @@ -112,7 +111,6 @@ impl Connection {
stats: Arc<Stats>,
txs_limit: usize,
#[cfg(feature = "electrum-discovery")] discovery: Option<Arc<DiscoveryManager>>,
rpc_logging: Option<RpcLogging>,
) -> Connection {
Connection {
query,
Expand All @@ -125,7 +123,6 @@ impl Connection {
txs_limit,
#[cfg(feature = "electrum-discovery")]
discovery,
rpc_logging,
}
}

Expand Down Expand Up @@ -493,27 +490,6 @@ impl Connection {
Ok(result)
}

fn log_rpc_event(&self, entries: &Vec<(&str, Value)>) {
if let Some(_) = self.rpc_logging {
let mut log = json!({});

if let Some(log_map) = log.as_object_mut() {
entries.into_iter().for_each(|e| {
log_map.insert(e.0.to_string(), e.1.clone());
});
log_map.insert(
"source".to_string(),
json!({
"ip": self.addr.ip().to_string(),
"port": self.addr.port(),
}),
);
}

info!("{}", log);
}
}

fn send_values(&mut self, values: &[Value]) -> Result<()> {
for value in values {
let line = value.to_string() + "\n";
Expand All @@ -531,7 +507,6 @@ impl Connection {
trace!("RPC {:?}", msg);
match msg {
Message::Request(line) => {
let method_info: String;
let cmd: Value = from_str(&line).chain_err(|| "invalid JSON format")?;
let reply = match (
cmd.get("method"),
Expand All @@ -542,30 +517,9 @@ impl Connection {
Some(&Value::String(ref method)),
&Value::Array(ref params),
Some(ref id),
) => {
let mut log_entries =
vec![("event", json!("rpc request")), ("method", json!(method))];

if let Some(RpcLogging::Full) = self.rpc_logging {
log_entries.push(("params", json!(params)));
}

self.log_rpc_event(&log_entries);
method_info = method.clone();

self.handle_command(method, params, id)?
}
) => self.handle_command(method, params, id)?,
_ => bail!("invalid command: {}", cmd),
};

let line = reply.to_string() + "\n";

self.log_rpc_event(&vec![
("event", json!("rpc response")),
("payload_size", json!(line.as_bytes().len())),
("method", json!(method_info)),
]);

self.send_values(&[reply])?
}
Message::PeriodicUpdate => {
Expand Down Expand Up @@ -609,9 +563,6 @@ impl Connection {

pub fn run(mut self) {
self.stats.clients.inc();

self.log_rpc_event(&vec![("event", json!("connection established"))]);

let reader = BufReader::new(self.stream.try_clone().expect("failed to clone TcpStream"));
let tx = self.chan.sender();
let child = spawn_thread("reader", || Connection::handle_requests(reader, tx));
Expand All @@ -628,9 +579,6 @@ impl Connection {
.sub(self.status_hashes.len() as i64);

debug!("[{}] shutting down connection", self.addr);

self.log_rpc_event(&vec![("event", json!("connection closed"))]);

let _ = self.stream.shutdown(Shutdown::Both);
if let Err(err) = child.join().expect("receiver panicked") {
error!("[{}] receiver failed: {}", self.addr, err);
Expand Down Expand Up @@ -793,7 +741,6 @@ impl RPC {
let garbage_sender = garbage_sender.clone();
#[cfg(feature = "electrum-discovery")]
let discovery = discovery.clone();
let rpc_logging = config.rpc_logging.clone();

let spawned = spawn_thread("peer", move || {
info!("[{}] connected peer", addr);
Expand All @@ -805,7 +752,6 @@ impl RPC {
txs_limit,
#[cfg(feature = "electrum-discovery")]
discovery,
rpc_logging,
);
senders.lock().unwrap().push(conn.chan.sender());
conn.run();
Expand Down

0 comments on commit 7dd7e8f

Please sign in to comment.