Skip to content

Feat/improve logs #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Feat/improve logs #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eee0a61
Improves logs. Creates error and application log files.
ltardivo Jan 14, 2025
e9740c2
Adds parameter changes to docs
ltardivo Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions packages/docs/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ You can configure several options by editing the `.env` file.
<font size=1>

```bash
# Chain: BTC, LTC or PEPE
# Chain: BTC, LTC, DOGE or PEPE
BCN_CHAIN='LTC'
# Network: mainnet, testnet, or regtest
BCN_NETWORK='regtest'
Expand Down Expand Up @@ -195,11 +195,13 @@ BITCOIN_RPC_PROTOCOL='http'
# Default wallet name
BITCOIN_DEFAULT_WALLET='defaultwallet'

# Bitcoin Computer Node (BCN) Settings
# Port for Bitcoin Computer Node
BCN_PORT='1031'

# Setup the environment to prod or dev
BCN_ENV=dev
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -211,14 +213,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -229,8 +234,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
18 changes: 11 additions & 7 deletions packages/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ You can configure several options by editing the `.env` file.
<font size=1>

```bash
# Chain: BTC, LTC or PEPE
# Chain: BTC, LTC, DOGE or PEPE
BCN_CHAIN='LTC'
# Network: mainnet, testnet, or regtest
BCN_NETWORK='regtest'
Expand Down Expand Up @@ -215,11 +215,13 @@ BITCOIN_RPC_PROTOCOL='http'
# Default wallet name
BITCOIN_DEFAULT_WALLET='defaultwallet'

# Bitcoin Computer Node (BCN) Settings
# Port for Bitcoin Computer Node
BCN_PORT='1031'

# Setup the environment to prod or dev
BCN_ENV=dev
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -231,14 +233,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -249,8 +254,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/BTC/mainnet/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -47,14 +45,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -65,8 +66,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/BTC/regtest/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ BITCOIN_DEFAULT_WALLET='defaultwallet'
# Port for Bitcoin Computer Node
BCN_PORT='1031'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -45,14 +43,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -63,8 +64,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/BTC/testnet/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -49,14 +47,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -67,8 +68,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/DOGE/mainnet/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -48,14 +46,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -66,8 +67,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/DOGE/regtest/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -49,14 +47,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -67,8 +68,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/DOGE/testnet/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -49,14 +47,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -67,8 +68,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
12 changes: 6 additions & 6 deletions packages/node/chain-setup/LTC/mainnet/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ BCN_PORT='1031'
# Enable to launch with fixed number of parallel workers
# BCN_NUM_WORKERS='6'

# Setup the environment to prod or dev
BCN_ENV=dev
BCN_ZMQ_URL='tcp://node:28332'
BCN_ZMQ_PORT='28332'
# Height of the block at which the zmq connection should start
Expand All @@ -48,14 +46,17 @@ BCN_URL='http://127.0.0.1:1031'
# Allowed RPC Methods
BCN_ALLOWED_RPC_METHODS='^get|^gen|^send|^lis'

# Setup the environment to 'prod' (no console logs) or 'dev'
BCN_ENV='dev'

# Winston Logger Settings
# Debug mode
# Log levels
# 0: Error logs only
# 1: Error and warning logs
# 2: Error, warning and info logs
# 3: Error, warning, info and http logs
# 4: Error, warning, info, http and debug logs
BCN_DEBUG_MODE='4'
BCN_LOG_LEVEL='2'
# Maximum number of logs to keep. If not set, no logs will be removed. This can be
# a number of files or number of days. If using days, add 'd' as the suffix.
BCN_LOG_MAX_FILES='14d'
Expand All @@ -66,8 +67,7 @@ BCN_LOG_MAX_SIZE='20m'
# A boolean to define whether or not to gzip archived log files.
BCN_LOG_ZIP='false'

# Show logs attached to the Console transport.
BCN_SHOW_CONSOLE_LOGS='true'
# Show logs at db service
BCN_SHOW_DB_LOGS='false'

# Rate Limiting Settings
Expand Down
Loading