codechain-io / codechain-agent-client

CodeChain monitoring tool

This project is moved to https://github.com/CodeChain-io/codechain-dashboard

CodeChain Agent

Requirements

The following are the software dependencies required to install and run CodeChain-agent:

• CodeChain
• CodeChain-agent-server

Install dependencies (Ubuntu)

sudo apt install pkg-config libssl-dev

Run

To run CodeChain-agent, just run

cargo run -- --agent-hub-url <agent-hub-url> --codechain-dir <codechain-dir> --codechain-p2p-address <codechain-p2p-address> --name <name>

Formatting

Make sure you run rustfmt before creating a PR to the repo. You need to install the nightly-2018-12-06 version of rustfmt.

rustup toolchain install nightly-2018-12-06
rustup component add rustfmt-preview --toolchain nightly-2018-12-06

To run rustfmt,

cargo +nightly-2018-12-06 fmt

User Manual

Under docs folder, run following command.

make html

User manual will be generated at docs/_build/html.

codechain-agent-client's Issues

Too high CPU usages

The below screenshot is from t2.micro (corgi1 machine)

The health checking logic is strange

#2018-09-21 09:48:02  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
   Compiling codechain-vm v0.1.0 (file:///Users/gilyoungkim/Documents/workspace/codechain/vm)
#2018-09-21 09:48:03  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
#2018-09-21 09:48:04  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
#2018-09-21 09:48:05  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
   Compiling codechain-network v0.1.0 (file:///Users/gilyoungkim/Documents/workspace/codechain/network)
#2018-09-21 09:48:06  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
   Compiling codechain-keystore v0.1.0 (file:///Users/gilyoungkim/Documents/workspace/codechain/keystore)
   Compiling codechain-stratum v1.11.0 (file:///Users/gilyoungkim/Documents/workspace/codechain/stratum)
#2018-09-21 09:48:07  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))
#2018-09-21 09:48:08  process INFO agent  Ok(Object({"id": Number(1), "result": String("pong")}))

The node status always returns "Run" while compiling the CodeChain.
It has to return "Starting" status according to the spec documents.

Rotate the log

Currently, CodeChain's log is saved in the agent.log file.

We should rotate the file to manage it.

Use sha256 instead of sha1 for checksum

Sometimes the Agent panic while calling mpsc::recv_timeout

The issue is already filed in rust.

https://github.com/rust-lang/rust/issues/39364

May we try crossbeam's channel.