Skip to content

Commit 33c8969

Browse files
authored
Merge pull request freqtrade#11697 from froggleston/frog_logs_docs_1
Improve logging docs in 101 and advanced setup
2 parents f568d63 + d90666d commit 33c8969

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

docs/advanced-setup.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -189,13 +189,15 @@ as the watchdog.
189189
## Advanced Logging
190190

191191
Freqtrade uses the default logging module provided by python.
192-
Python allows for extensive [logging configuration](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig) in this regards - way more than what can be covered here.
192+
Python allows for extensive [logging configuration](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig) in this regard - way more than what can be covered here.
193193

194-
Default logging (Colored terminal output) is setup by default if no `log_config` is provided.
194+
Default logging format (coloured terminal output) is set up by default if no `log_config` is provided in your freqtrade configuration.
195195
Using `--logfile logfile.log` will enable the RotatingFileHandler.
196-
If you're not content with the log format - or with the default settings provided for the RotatingFileHandler, you can customize logging to your liking.
197196

198-
The default configuration looks roughly like the below - with the file handler being provided - but not enabled.
197+
If you're not content with the log format, or with the default settings provided for the RotatingFileHandler, you can customize logging to your liking by adding the `log_config` configuration to your freqtrade configuration file(s).
198+
199+
The default configuration looks roughly like the below, with the file handler being provided but not enabled as the `filename` is commented out.
200+
Uncomment this line and supply a valid path/filename to enable it.
199201

200202
``` json hl_lines="5-7 13-16 27"
201203
{
@@ -237,12 +239,12 @@ The default configuration looks roughly like the below - with the file handler b
237239
Highlighted lines in the above code-block define the Rich handler and belong together.
238240
The formatter "standard" and "file" will belong to the FileHandler.
239241

240-
Each handler must use one of the defined formatters (by name) - and it's class must be available and a valid logging class.
241-
To actually use a handler - it must be in the "handlers" section inside the "root" segment.
242+
Each handler must use one of the defined formatters (by name), its class must be available, and must be a valid logging class.
243+
To actually use a handler, it must be in the "handlers" section inside the "root" segment.
242244
If this section is left out, freqtrade will provide no output (in the non-configured handler, anyway).
243245

244246
!!! Tip "Explicit log configuration"
245-
We recommend to extract the logging configuration from your main configuration, and provide it to your bot via [multiple configuration files](configuration.md#multiple-configuration-files) functionality. This will avoid unnecessary code duplication.
247+
We recommend to extract the logging configuration from your main freqtrade configuration file, and provide it to your bot via [multiple configuration files](configuration.md#multiple-configuration-files) functionality. This will avoid unnecessary code duplication.
246248

247249
---
248250

docs/strategy-101.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,18 +165,23 @@ If there is any significant difference, verify that your entry and exit signals
165165

166166
## Controlling or monitoring a running bot
167167

168-
Once your bot is running in dry or live mode, Freqtrade has five mechanisms to control or monitor a running bot:
168+
Once your bot is running in dry or live mode, Freqtrade has six mechanisms to control or monitor a running bot:
169169

170170
- **[FreqUI](freq-ui.md)**: The easiest to get started with, FreqUI is a web interface to see and control current activity of your bot.
171171
- **[Telegram](telegram-usage.md)**: On mobile devices, Telegram integration is available to get alerts about your bot activity and to control certain aspects.
172172
- **[FTUI](https://github.com/freqtrade/ftui)**: FTUI is a terminal (command line) interface to Freqtrade, and allows monitoring of a running bot only.
173-
- **[REST API](rest-api.md)**: The REST API allows programmers to develop their own tools to interact with a Freqtrade bot.
173+
- **[freqtrade-client](rest-api.md#consuming-the-api)**: A python implementation of the REST API, making it easy to make requests and consume bot responses from your python apps or the command line.
174+
- **[REST API endpoints](rest-api.md#available-endpoints)**: The REST API allows programmers to develop their own tools to interact with a Freqtrade bot.
174175
- **[Webhooks](webhook-config.md)**: Freqtrade can send information to other services, e.g. discord, by webhooks.
175176

176177
### Logs
177178

178179
Freqtrade generates extensive debugging logs to help you understand what's happening. Please familiarise yourself with the information and error messages you might see in your bot logs.
179180

181+
Logging by default occurs on standard out (the command line). If you want to write out to a file instead, many freqtrade commands, including the `trade` command, accept the `--logfile` option to write to a file.
182+
183+
Check the [FAQ](faq.md#how-do-i-search-the-bot-logs-for-something) for examples.
184+
180185
## Final Thoughts
181186

182187
Algo trading is difficult, and most public strategies are not good performers due to the time and effort to make a strategy work profitably in multiple scenarios.

0 commit comments

Comments
 (0)