From 30afdec8836b1b39c6cf253555b9b73cc1c6c117 Mon Sep 17 00:00:00 2001 From: axaysagathiya Date: Fri, 23 Jun 2023 14:08:16 +0530 Subject: [PATCH] modify Docs --- cmd/gossamer/README.md | 8 +++++++- docs/docs/testing-and-debugging/debugging.md | 4 ++-- docs/docs/usage/command-line.md | 17 +++++++---------- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/cmd/gossamer/README.md b/cmd/gossamer/README.md index d0574fb187..e27e878603 100644 --- a/cmd/gossamer/README.md +++ b/cmd/gossamer/README.md @@ -75,7 +75,13 @@ Here are the list of basic flags for the `gossamer` command: --key: The keypair to use for the node. --name: The name of the node. --id: The id of the node. ---log-level: The global log level. Supported levels are `crit`, `error`, `warn`, `info`, `debug` and `trace`. +--log: Set a logging filter. + Syntax is a list of 'module=logLevel' (comma separated) + e.g. --log sync=debug,core=trace + Modules are global, core, digest, sync, network, rpc, state, runtime, babe, grandpa, wasmer. + Log levels (least to most verbose) are error, warn, info, debug, and trace. + By default, all modules log 'info'. + The global log level can be set with --log global=debug --prometheus-port: The port to expose prometheus metrics. --retain-blocks: retain number of block from latest block while pruning --pruning: The pruning strategy to use. Supported strategiey: `archive` diff --git a/docs/docs/testing-and-debugging/debugging.md b/docs/docs/testing-and-debugging/debugging.md index abfe18c2d9..7103b67da0 100644 --- a/docs/docs/testing-and-debugging/debugging.md +++ b/docs/docs/testing-and-debugging/debugging.md @@ -22,7 +22,7 @@ grandpa = "trace | debug | info | warn | error | crit" ``` ## Logging Global Flags -```--log value Supports levels crit (silent) to trce (trace) (default: "info")``` +```--log global=value Supports levels crit (silent) to trce (trace) (default: "info")``` ## Running node with log level as `DEBUG` -```./bin/gossamer --config chain/gssmr/config.toml --log debug``` +```./bin/gossamer --config chain/gssmr/config.toml --log global=debug``` diff --git a/docs/docs/usage/command-line.md b/docs/docs/usage/command-line.md index e919c6d4d8..33dbf3b7e2 100644 --- a/docs/docs/usage/command-line.md +++ b/docs/docs/usage/command-line.md @@ -23,17 +23,14 @@ These are the flags that can be used with the `gossamer` command --help help for gossamer --id Identifier used to identify this node in the network --key Key to use for the node ---lbabe Log level for BABE module (default 'info') ---lcore Log level for core module (default 'info') ---ldigest Log level for digest module (default 'info') ---lgrandpa Log level for GRANDPA module (default 'info') --listen-addr Overrides the listen address used for peer to peer networking ---lnetwork Log level for network module (default 'info') ---log Global log level (default 'info') ---lrpc Log level for RPC module (default 'info') ---lruntime Log level for runtime module (default 'info') ---lstate Log level for state module (default 'info') ---lsync Log level for sync module (default 'info') +--log: Set a logging filter. + Syntax is a list of 'module=logLevel' (comma separated) + e.g. --log sync=debug,core=trace + Modules are global, core, digest, sync, network, rpc, state, runtime, babe, grandpa, wasmer. + Log levels (least to most verbose) are error, warn, info, debug, and trace. + By default, all modules log 'info'. + The global log level can be set with --log global=debug --max-peers Maximum number of peers to connect to (default 50) --min-peers Minimum number of peers to connect to (default 5) --name Name of the node