feat: Update documentation with detailed logging configuration

aptos/README.md

@@ -23,6 +23,21 @@ The workspace is divided into the following:
 - `aptos-programs`: A library that exposes the Sphinx programs used to generate proofs for our light client.*
 - `programs/*`: Actual implementations of the Sphinx programs.
 
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off
+
 ## Development
 
 When developing, you might have to update the programs' implementation. The programs implementations are located in

aptos/docs/src/run/configuration.md

@@ -41,3 +41,18 @@ sudo apt update && sudo apt-get install -y build-essential libssl-dev pkg-config
 ```
 
 For non-Ubuntu/non-Debian based distros, make sure to install the equivalent packages.
+
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off

aptos/docs/src/run/setup_proof_server.md

@@ -56,3 +56,9 @@ git clone [email protected]:argumentcomputer/zk-light-clients.git && \
   cd zk-light-clients/aptos/proof-server && \
   SHARD_BATCH_SIZE=0 RUSTFLAGS="-C target-cpu=native --cfg tokio_unstable -C opt-level=3" cargo run --release --bin proof_server -- --mode "split" -a <NETWORK_ADDESS> --snd-addr <SECONDARY_SERVER_ADDRESS>
 ```
+
+> **Note**
+>
+> Logging can be configured via `RUST_LOG` for Rust logging and `SP1_GO_LOG` for Go FFI logging.
+> For example: `RUST_LOG=debug SP1_GO_LOG=debug cargo run ...`
+> See the [configuration documentation](./configuration.md#logging-configuration) for more details.

ethereum/README.md

@@ -28,6 +28,21 @@ The workspace is divided into the following:
 - `ethereum-programs`: A library that exposes the Sphinx programs used to generate proofs for our light client.
 - `programs/*`: Actual implementations of the Sphinx programs.
 
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off
+
 ## Development
 
 When developing, you might have to update the programs' implementation. The

ethereum/docs/src/run/configuration.md

@@ -41,3 +41,18 @@ sudo apt update && sudo apt-get install -y build-essential libssl-dev pkg-config
 ```
 
 For non-Ubuntu/non-Debian based distros, make sure to install the equivalent packages.
+
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off

ethereum/docs/src/run/setup_proof_server.md

@@ -46,3 +46,9 @@ git clone [email protected]:argumentcomputer/zk-light-clients.git && \
   cd zk-light-clients/ethereum/light-client && \
   RECONSTRUCT_COMMITMENTS=false SHARD_BATCH_SIZE=0 SHARD_CHUNKING_MULTIPLIER=64 SHARD_SIZE=4194304 RUSTFLAGS="-C target-cpu=native -C opt-level=3" cargo run --release --bin proof_server -- --mode "split" -a <NETWORK_ADDESS> --snd-addr <SECONDARY_SERVER_ADDRESS>
 ```
+
+> **Note**
+>
+> Logging can be configured via `RUST_LOG` for Rust logging and `SP1_GO_LOG` for Go FFI logging.
+> For example: `RUST_LOG=debug SP1_GO_LOG=debug cargo run ...`
+> See the [configuration documentation](./configuration.md#logging-configuration) for more details.

kadena/README.md

@@ -22,6 +22,21 @@ The workspace is divided into the following:
 - `kadena-programs`: A library that exposes the Sphinx programs used to generate proofs for our light client.
 - `programs/*`: Actual implementations of the Sphinx programs.
 
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off
+
 ## Development
 
 When developing, you might have to update the programs' implementation. The programs implementations are located in

kadena/docs/src/run/configuration.md

@@ -41,3 +41,18 @@ sudo apt update && sudo apt-get install -y build-essential libssl-dev pkg-config
 ```
 
 For non-Ubuntu/non-Debian based distros, make sure to install the equivalent packages.
+
+## Logging Configuration
+
+The light client uses two logging systems:
+
+- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
+- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.
+
+To set a global log level (e.g. warn), configure both variables:
+
+```bash
+RUST_LOG=warn SP1_GO_LOG=warn cargo run ...
+```
+
+Valid log levels are: error, warn, info, debug, trace, off

kadena/docs/src/run/setup_proof_server.md

@@ -40,3 +40,9 @@ git clone https://github.com/argumentcomputer/zk-light-clients.git && \
   cd zk-light-clients/kadena/light-client && \
   RECONSTRUCT_COMMITMENTS=false SHARD_BATCH_SIZE=0 SHARD_CHUNKING_MULTIPLIER=64 SHARD_SIZE=4194304 RUSTFLAGS="-C target-cpu=native -C opt-level=3" cargo run --release --bin proof_server -- --mode "split" -a <NETWORK_ADDESS> --snd-addr <SECONDARY_SERVER_ADDRESS>
 ```
+
+> **Note**
+>
+> Logging can be configured via `RUST_LOG` for Rust logging and `SP1_GO_LOG` for Go FFI logging.
+> For example: `RUST_LOG=debug SP1_GO_LOG=debug cargo run ...`
+> See the [configuration documentation](./configuration.md#logging-configuration) for more details.