Log buffer #5583
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"> | ||
| <meta name="theme-color" content="#222222"> | ||
| <title>WLED Log Viewer</title> | ||
| <script> | ||
| // load common.js with retry on error | ||
| (function loadCommon() { | ||
| const l = document.createElement('script'); | ||
| l.src = 'common.js'; | ||
| l.onload = init; | ||
| l.onerror = () => setTimeout(loadCommon, 100); | ||
| document.head.appendChild(l); | ||
| })(); | ||
|
|
||
| var autoRefresh = null; | ||
|
|
||
| function init() { | ||
| getLoc(); | ||
| fetchLog(); | ||
| } | ||
|
|
||
| function fetchLog() { | ||
| fetch(getURL('/json/log')) | ||
| .then(r => { | ||
| if (!r.ok) { | ||
| if (r.status === 501) { | ||
| setStatus('Log buffer not available on this device (no PSRAM build).'); | ||
| } else if (r.status === 503) { | ||
| setStatus('Log buffer not ready \u2014 PSRAM not detected at runtime.'); | ||
| } else { | ||
| setStatus('Error fetching log: HTTP ' + r.status); | ||
| } | ||
| return null; | ||
| } | ||
| return r.text(); | ||
| }) | ||
| .then(txt => { | ||
| if (txt === null) return; | ||
| const ta = document.getElementById('log'); | ||
| ta.value = txt; | ||
| // Scroll to bottom so latest entries are visible | ||
| ta.scrollTop = ta.scrollHeight; | ||
| document.getElementById('sz').textContent = (txt.length / 1024).toFixed(1) + ' KB'; | ||
| }) | ||
| .catch(e => setStatus('Fetch error: ' + e)); | ||
| } | ||
|
|
||
| function clearLog() { | ||
| fetch(getURL('/json/log?clear')) | ||
| .then(r => r.text()) | ||
| .then(() => { | ||
| document.getElementById('log').value = ''; | ||
| document.getElementById('sz').textContent = '0 KB'; | ||
| setStatus('Log cleared.'); | ||
| }) | ||
| .catch(e => setStatus('Clear error: ' + e)); | ||
| } | ||
|
|
||
| function copyLog() { | ||
| const ta = document.getElementById('log'); | ||
| if (navigator.clipboard) { | ||
| navigator.clipboard.writeText(ta.value).then(() => setStatus('Copied to clipboard.')); | ||
| } else { | ||
| ta.select(); | ||
| document.execCommand('copy'); | ||
| setStatus('Copied to clipboard.'); | ||
| } | ||
| } | ||
|
|
||
| function toggleAuto() { | ||
| const btn = document.getElementById('autobtn'); | ||
| if (autoRefresh) { | ||
| clearInterval(autoRefresh); | ||
| autoRefresh = null; | ||
| btn.textContent = 'Auto-refresh: Off'; | ||
| btn.classList.remove('active'); | ||
| } else { | ||
| fetchLog(); | ||
| autoRefresh = setInterval(fetchLog, 5000); | ||
| btn.textContent = 'Auto-refresh: On'; | ||
| btn.classList.add('active'); | ||
| } | ||
| } | ||
|
|
||
| function setStatus(msg) { | ||
| document.getElementById('status').textContent = msg; | ||
| setTimeout(() => { document.getElementById('status').textContent = ''; }, 4000); | ||
| } | ||
| </script> | ||
| <style> | ||
| @import url("style.css"); | ||
| body { | ||
| margin: 0 auto; | ||
| max-width: 900px; | ||
| padding: 0 8px 8px; | ||
| box-sizing: border-box; | ||
| } | ||
| h2 { | ||
| margin: 8px 0 4px; | ||
| font-size: 1.2rem; | ||
| } | ||
| .toolbar { | ||
| display: flex; | ||
| flex-wrap: wrap; | ||
| gap: 6px; | ||
| margin-bottom: 6px; | ||
| align-items: center; | ||
| } | ||
| .toolbar button { | ||
| padding: 4px 12px; | ||
| border-radius: 4px; | ||
| font-size: 0.9rem; | ||
| cursor: pointer; | ||
| border: none; | ||
| background: var(--c-3, #444); | ||
| color: var(--c-f, #fff); | ||
| } | ||
| .toolbar button.active { | ||
| background: var(--c-6, #888); | ||
| } | ||
| #status { | ||
| font-size: 0.85rem; | ||
| color: var(--c-6, #aaa); | ||
| flex: 1; | ||
| text-align: right; | ||
| } | ||
| #sz { | ||
| font-size: 0.85rem; | ||
| color: var(--c-6, #aaa); | ||
| } | ||
| #log { | ||
| width: 100%; | ||
| height: calc(100vh - 120px); | ||
| min-height: 200px; | ||
| box-sizing: border-box; | ||
| font-family: monospace; | ||
| font-size: 0.8rem; | ||
| background: #111; | ||
| color: #cfc; | ||
| border: 1px solid #444; | ||
| border-radius: 4px; | ||
| resize: vertical; | ||
| padding: 6px; | ||
| white-space: pre; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <h2>WLED Log Viewer</h2> | ||
| <div class="toolbar"> | ||
| <button onclick="fetchLog()">Refresh</button> | ||
| <button id="autobtn" onclick="toggleAuto()">Auto-refresh: Off</button> | ||
| <button onclick="copyLog()">Copy</button> | ||
| <button onclick="clearLog()">Clear</button> | ||
| <button onclick="window.location=getURL('/')">Back</button> | ||
| <span id="sz">-- KB</span> | ||
| <span id="status"></span> | ||
| </div> | ||
| <textarea id="log" readonly spellcheck="false" placeholder="Loading log\u2026"></textarea> | ||
| </body> | ||
| </html> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| #pragma once | ||
| /* | ||
| * log_buffer.h — PSRAM-backed ring buffer for capturing log output. | ||
| * | ||
| * When a device has PSRAM (BOARD_HAS_PSRAM), a 32 KB ring buffer is | ||
| * allocated at runtime (after psramFound() confirms the hardware). | ||
| * Log entries written via WLED_LOG() / WLED_LOGF() are stored there and | ||
| * exposed through the /json/log HTTP endpoint and the /log web UI page, | ||
| * so end-users can retrieve diagnostic information without serial access | ||
| * or custom builds. | ||
| * | ||
| * Two thin helpers are provided: | ||
| * | ||
| * LogBuffer – bare ring buffer over a ps_malloc'd char array. | ||
| * LogPrint – Arduino Print subclass that writes into a LogBuffer. | ||
| * | ||
| * Thread / ISR safety: writes use a portMUX spinlock so the buffer | ||
| * remains coherent when both the main loop and the AsyncWebServer task | ||
| * call WLED_LOG() concurrently. | ||
| */ | ||
|
|
||
| #include <Arduino.h> | ||
| #include <Print.h> | ||
|
|
||
| class LogBuffer { | ||
| public: | ||
| // Default capacity stored in PSRAM. Raising this value is safe as long as | ||
| // the device has enough PSRAM; it has no effect when PSRAM is absent. | ||
| static constexpr size_t CAPACITY = 32 * 1024; // 32 KB | ||
|
|
||
| LogBuffer() | ||
| : _buf(nullptr), _head(0), _used(0) | ||
| { | ||
| _mux = portMUX_INITIALIZER_UNLOCKED; | ||
| } | ||
|
|
||
| // Allocate the PSRAM backing store. Call once after psramFound() == true. | ||
| // Returns true on success. | ||
| bool init() { | ||
| _buf = static_cast<char*>(ps_malloc(CAPACITY)); | ||
| return _buf != nullptr; | ||
| } | ||
|
|
||
| bool available() const { return _buf != nullptr; } | ||
| size_t size() const { return _used; } | ||
|
|
||
| // Write raw bytes into the ring buffer (overwrites oldest data when full). | ||
| void write(const char* data, size_t len) { | ||
| if (!_buf || !len) return; | ||
| portENTER_CRITICAL(&_mux); | ||
| for (size_t i = 0; i < len; i++) { | ||
| _buf[_head] = data[i]; | ||
| _head = (_head + 1) % CAPACITY; | ||
| if (_used < CAPACITY) _used++; | ||
| } | ||
| portEXIT_CRITICAL(&_mux); | ||
| } | ||
|
|
||
| // Stream the ring-buffer contents (oldest byte first) into any Print sink. | ||
| // Returns the number of bytes emitted. | ||
| size_t printTo(Print& out) const { | ||
| if (!_buf || !_used) return 0; | ||
| if (_used < CAPACITY) { | ||
| // Buffer has not wrapped yet — data starts at index 0. | ||
| out.write(reinterpret_cast<const uint8_t*>(_buf), _used); | ||
| return _used; | ||
| } | ||
| // Buffer has wrapped — oldest byte is at _head. | ||
| out.write(reinterpret_cast<const uint8_t*>(_buf + _head), CAPACITY - _head); | ||
| out.write(reinterpret_cast<const uint8_t*>(_buf), _head); | ||
| return CAPACITY; | ||
|
Comment on lines
+61
to
+71
Contributor
There was a problem hiding this comment. 🧩 Analysis chain🏁 Script executed: find . -name "log_buffer.h" -type fRepository: wled/WLED Length of output: 75 🏁 Script executed: cat -n wled00/log_buffer.hRepository: wled/WLED Length of output: 4446 🏁 Script executed: rg "p_malloc|ps_malloc|d_malloc" -t cpp -t h --max-count=20Repository: wled/WLED Length of output: 3367 🏁 Script executed: rg -A 3 -B 1 "p_malloc|ps_malloc" wled00/Repository: wled/WLED Length of output: 7029 Synchronize
Proposed fix (snapshot indices under lock) size_t printTo(Print& out) const {
if (!_buf || !_used) return 0;
+ size_t used;
+ size_t head;
+ portENTER_CRITICAL(const_cast<portMUX_TYPE*>(&_mux));
+ used = _used;
+ head = _head;
+ portEXIT_CRITICAL(const_cast<portMUX_TYPE*>(&_mux));
- if (_used < CAPACITY) {
+ if (used < CAPACITY) {
// Buffer has not wrapped yet — data starts at index 0.
- out.write(reinterpret_cast<const uint8_t*>(_buf), _used);
- return _used;
+ out.write(reinterpret_cast<const uint8_t*>(_buf), used);
+ return used;
}
// Buffer has wrapped — oldest byte is at _head.
- out.write(reinterpret_cast<const uint8_t*>(_buf + _head), CAPACITY - _head);
- out.write(reinterpret_cast<const uint8_t*>(_buf), _head);
+ out.write(reinterpret_cast<const uint8_t*>(_buf + head), CAPACITY - head);
+ out.write(reinterpret_cast<const uint8_t*>(_buf), head);
return CAPACITY;
}🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| void clear() { | ||
| portENTER_CRITICAL(&_mux); | ||
| _head = 0; | ||
| _used = 0; | ||
| portEXIT_CRITICAL(&_mux); | ||
| } | ||
|
|
||
| private: | ||
| char* _buf; // PSRAM allocation (nullptr until init()) | ||
| size_t _head; // Next write position (= oldest byte when full) | ||
| size_t _used; // Bytes written, capped at CAPACITY | ||
| portMUX_TYPE _mux; // Spinlock for concurrent write protection | ||
| }; | ||
|
|
||
|
|
||
| // Arduino Print subclass that forwards write() calls into a LogBuffer. | ||
| // Use this as the target of DEBUGOUT to capture all debug output. | ||
| class LogPrint : public Print { | ||
| public: | ||
| explicit LogPrint(LogBuffer& log) : _log(log) {} | ||
|
|
||
| size_t write(uint8_t c) override { | ||
| char ch = static_cast<char>(c); | ||
| _log.write(&ch, 1); | ||
| return 1; | ||
| } | ||
|
|
||
| size_t write(const uint8_t* buf, size_t size) override { | ||
| _log.write(reinterpret_cast<const char*>(buf), size); | ||
| return size; | ||
| } | ||
|
|
||
| LogBuffer& buffer() { return _log; } | ||
|
|
||
| private: | ||
| LogBuffer& _log; | ||
| }; | ||
|
|
||
|
|
||
| extern LogBuffer wledLogBuffer; // PSRAM ring buffer (allocated in wled.cpp) | ||
| extern LogPrint wledLog; // Print wrapper around wledLogBuffer | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check HTTP status before showing “Log cleared.”
On Line 53,
clearLog()ignoresr.ok, so failed clear requests still wipe the textarea and show success.Proposed fix
function clearLog() { fetch(getURL('/json/log?clear')) - .then(r => r.text()) - .then(() => { + .then(r => { + if (!r.ok) { + setStatus('Clear failed: HTTP ' + r.status); + return null; + } + return r.text(); + }) + .then(txt => { + if (txt === null) return; document.getElementById('log').value = ''; document.getElementById('sz').textContent = '0 KB'; setStatus('Log cleared.'); }) .catch(e => setStatus('Clear error: ' + e)); }🤖 Prompt for AI Agents