Skip to content

Commit fd23a55

Browse files
committed
merge docs
1 parent ea868c2 commit fd23a55

File tree

6 files changed

+48
-119
lines changed

6 files changed

+48
-119
lines changed

content/guides/troubleshooting.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,54 @@ If you already have a stack trace but need to decode it, you can use the
126126

127127
{{< /note >}}
128128

129+
## Adjusting Log Levels for Debugging
130+
131+
When troubleshooting issues with your ESPHome device, increasing the log level can provide more detailed information about what's happening internally. This is particularly useful for diagnosing component-specific problems or understanding the data flow between components.
132+
133+
### Setting Global Log Level
134+
135+
To increase the verbosity of logs globally, adjust the `level` in your {{< docref "/components/logger" >}} configuration:
136+
137+
```yaml
138+
logger:
139+
level: VERBOSE # or VERY_VERBOSE for maximum detail
140+
```
141+
142+
Available log levels from least to most verbose:
143+
144+
- `NONE` - No messages logged
145+
- `ERROR` - Only errors
146+
- `WARN` - Warnings and above
147+
- `INFO` - Informational messages and above
148+
- `DEBUG` - Debug messages and above (default)
149+
- `VERBOSE` - Detailed debug messages and above
150+
- `VERY_VERBOSE` - All internal messages including data bus traffic
151+
152+
{{< warning >}}
153+
Using `VERY_VERBOSE` can significantly slow down your device and may cause connectivity issues due to the volume of log messages generated. Use it only for short debugging sessions.
154+
{{< /warning >}}
155+
156+
### ESP-IDF Framework Log Level
157+
158+
When using the ESP-IDF framework on {{< docref "/components/esp32" >}}, you can also adjust the framework's internal log level to get more detailed information from the underlying system:
159+
160+
```yaml
161+
esp32:
162+
framework:
163+
type: esp-idf
164+
log_level: VERBOSE # Framework log level
165+
```
166+
167+
Available ESP-IDF log levels: `NONE`, `ERROR` (default), `WARN`, `INFO`, `DEBUG`, `VERBOSE`
168+
169+
### Component-Specific Log Levels
170+
171+
You can also configure log levels for specific components to reduce noise or get more detail from individual components. See the {{< docref "/components/logger#manual-tag-specific-log-levels" "logger manual tag-specific log levels" >}} documentation for detailed information and examples.
172+
173+
{{< important >}}
174+
The global log level determines which messages are compiled into the binary. Component-specific log levels can only reduce verbosity, not increase it beyond the global level. For example, if the global level is `INFO`, setting a component to `DEBUG` will have no effect.
175+
{{< /important >}}
176+
129177
## Performance Troubleshooting
130178

131179
If your device is experiencing performance issues such as:

esp32_phy_docs_pr.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

esp32_s2_docs_pr.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

idf_ota_web_server_docs_pr.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

runtime_stats_docs_pr.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

troubleshooting_with_logs_pr.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)