Skip to content

Commit f057710

Browse files
authored
fix: update readme to better explain how to enable the new request logging (#144)
1 parent 8abf1f2 commit f057710

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,17 @@ This will remove all docker images created by the server during the build proces
106106

107107
# Request Logging
108108

109-
Request logging can be enabled by setting `SHARDEUM_JSONRPC_ENABLE_REQUEST_LOGGING=true` in your environment. When enabled:
109+
Request logging is disabled by default. To enable it, set `SHARDEUM_JSONRPC_ENABLE_REQUEST_LOGGING=true` in your environment.
110110

111-
- File logging is enabled by default and logs are written to `logs/requests.log`
112-
- Can be disabled by explicitly setting `SHARDEUM_JSONRPC_FILE_LOGGING=false`
111+
When request logging is enabled:
112+
- Logs will be written to a file at `logs/requests.log` by default
113+
- You can disable file logging by setting `SHARDEUM_JSONRPC_FILE_LOGGING=false`
113114
- The logging directory can be configured using `SHARDEUM_JSONRPC_LOGGING_DIR` (defaults to `logs`)
114115
- The logs can be viewed by running `npm run tail-request-logs`
115116
- Console logging is disabled by default
116-
- Can be enabled by setting `SHARDEUM_JSONRPC_CONSOLE_LOGGING=true`
117+
- You can enable console logging by setting `SHARDEUM_JSONRPC_CONSOLE_LOGGING=true`
117118

119+
Note: Request logging is disabled by default in production environments to prevent log files from growing too large. Consider implementing log rotation if enabling request logging in production.
118120

119121
# DEBUG Endpoints
120122

0 commit comments

Comments
 (0)