Skip to content

Commit

Permalink
docs: add note on log level (#191)
Browse files Browse the repository at this point in the history
* docs: add note on log level

* updates
  • Loading branch information
julienrbrt authored Sep 24, 2024
1 parent 3b685a1 commit 0dfc11b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 24 deletions.
20 changes: 4 additions & 16 deletions .github/workflows/copy-md.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Copy MD Files
on:
workflow_dispatch:
schedule:
- cron: '0 0,12 * * *'
- cron: "0 0,12 * * *"

env:
PR_BRANCH_NAME: "sync-docs-${{ github.sha }}"
Expand All @@ -21,7 +21,7 @@ jobs:

- name: Checkout Repository
uses: actions/checkout@v4

- name: Set Up Node.js
uses: actions/setup-node@v3
with:
Expand All @@ -30,7 +30,7 @@ jobs:
- name: Install Dependencies
run: |
yarn install --frozen-lockfile
- name: Run Sync Script
run: |
chmod +x sync_script.sh
Expand All @@ -41,21 +41,10 @@ jobs:
chmod +x tutorials-script.sh
./tutorials-script.sh
# - name: Add And Commit
# uses: EndBug/add-and-commit@v9
# with:
# new_branch: ${{ env.PR_BRANCH_NAME }}
# message: 'Updated MD File Changes from cosmos-sdk/docs'

# - name: Push To Sync-Docs
# uses: ad-m/github-push-action@master
# with:
# branch: ${{ env.PR_BRANCH_NAME }}

- uses: peter-evans/create-pull-request@v6
with:
commit-message: "chore: Sync docs from cosmos-sdk/docs"
title: "chore: update documenation from cosmos-sdk/docs"
title: "chore: update documentation from cosmos-sdk/docs"
base: main
branch: ${{ env.PR_BRANCH_NAME }}
delete-branch: false
Expand All @@ -79,4 +68,3 @@ jobs:
SLACK_COLOR: danger
SLACK_MESSAGE: Copying docs is failing
SLACK_FOOTER: ""

5 changes: 0 additions & 5 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@ name: Test deployment

on:
pull_request:
branches:
- '**'
push:
branches:
- '**'

jobs:
test-deploy:
Expand Down
16 changes: 13 additions & 3 deletions docs/user/run-node/01-run-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,16 +166,26 @@ and set `rpc.laddr` in `config.toml` to the CometBFT node's RPC address.

## Logging

Logging provides a way to see what is going on with a node. By default the info level is set. This is a global level and all info logs will be outputted to the terminal. If you would like to filter specific logs to the terminal instead of all, then setting `module:log_level` is how this can work.
Logging provides a way to see what is going on with a node. By default the `info` level is set. This is a global level and all info logs will be outputted to the terminal.

If you would like to filter specific logs to the terminal instead of all, then setting `<module>:<log_level>` is how this can work.
Example:

In config.toml:
In `config.toml`:

```toml
log_level: "state:info,p2p:info,consensus:info,x/staking:info,x/ibc:info,*error"
log_level: "state:info,p2p:info,consensus:info,x/staking:info,x/ibc:info,*:error"
```

Or directly in the command line:

```bash
<appd> start --log_level "state:info,p2p:info,consensus:info,x/staking:info,x/ibc:info,*:error"
```

The above will show info logs for the state, p2p, consensus, staking, and ibc modules, and error logs for all other modules.
When no log filtering is required, simply use one of the supported global log levels: `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic` or `disabled`.

## State Sync

State sync is the act in which a node syncs the latest or close to the latest state of a blockchain. This is useful for users who don't want to sync all the blocks in history. Read more in [CometBFT documentation](https://docs.cometbft.com/v0.37/core/state-sync).
Expand Down

0 comments on commit 0dfc11b

Please sign in to comment.