Skip to content

Commit 250d76a

Browse files
mathieucarboumathieucarbou
authored
Merge pull request #281 from ESP32Async/logging
Logging refactoring to supports macros redefinition and -D USE_ESP_IDF_LOG
2 parents af50210 + e323ae1 commit 250d76a

13 files changed

+244
-121
lines changed

‎.github/workflows/build-esp32.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,8 @@ jobs:
226226
env:
227227
- ci-arduino-rc-asynctcp
228228
- ci-arduino-3-no-json
229+
- ci-arduino-2-esp-idf-log
230+
- ci-arduino-3-esp-idf-log
229231

230232
steps:
231233
- name: Checkout

‎examples/ChunkRetryResponse/ChunkRetryResponse.ino‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ void setup() {
174174
return 0; // 0 means we are done
175175
}
176176

177-
// log_d("UART answered!");
177+
// async_ws_log_d("UART answered!");
178178

179179
String answer = "You typed: ";
180180
answer.concat((char)key);
@@ -193,18 +193,18 @@ void setup() {
193193
},
194194
NULL, // upload handler is not used so it should be NULL
195195
[](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) {
196-
// log_d("Body: index: %u, len: %u, total: %u", index, len, total);
196+
// async_ws_log_d("Body: index: %u, len: %u, total: %u", index, len, total);
197197

198198
if (!index) {
199-
// log_d("Start body parsing");
199+
// async_ws_log_d("Start body parsing");
200200
request->_tempObject = new String();
201201
// cast request->_tempObject pointer to String and reserve total size
202202
((String *)request->_tempObject)->reserve(total);
203203
// set timeout 30s
204204
request->client()->setRxTimeout(30);
205205
}
206206

207-
// log_d("Append body data");
207+
// async_ws_log_d("Append body data");
208208
((String *)request->_tempObject)->concat((const char *)data, len);
209209
}
210210
);
@@ -217,13 +217,13 @@ void setup() {
217217
void loop() {
218218
if (triggerUART.length() && key == -1) {
219219
Serial.println(triggerUART);
220-
// log_d("Waiting for UART input...");
220+
// async_ws_log_d("Waiting for UART input...");
221221
while (!Serial.available()) {
222222
delay(100);
223223
}
224224
key = Serial.read();
225225
Serial.flush();
226-
// log_d("UART input: %c", key);
226+
// async_ws_log_d("UART input: %c", key);
227227
triggerUART = emptyString;
228228
}
229229
}

‎platformio.ini‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ build_flags =
5252
-D CONFIG_ASYNC_TCP_RUNNING_CORE=1
5353
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096
5454
; -D CONFIG_ASYNC_TCP_USE_WDT=0
55+
; -D CONFIG_ARDUHAL_LOG_COLORS
56+
; -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE
57+
; -D USE_ESP_IDF_LOG=1
58+
; -D TAG=\"core\"
59+
; -D LOG_LOCAL_LEVEL=ESP_LOG_VERBOSE
60+
; -D ASYNCWEBSERVER_LOG_DEBUG
5561
upload_protocol = esptool
5662
monitor_speed = 115200
5763
monitor_filters = esp32_exception_decoder, log2file
@@ -135,6 +141,20 @@ board = ${sysenv.PIO_BOARD}
135141
platform = https://github.com/pioarduino/platform-espressif32/releases/download/54.03.20-rc2/platform-espressif32.zip
136142
board = ${sysenv.PIO_BOARD}
137143

144+
[env:ci-arduino-2-esp-idf-log]
145+
platform = espressif32@6.12.0
146+
board = ${sysenv.PIO_BOARD}
147+
build_flags =
148+
${env.build_flags}
149+
-D USE_ESP_IDF_LOG=1
150+
-D TAG=\"core\"
151+
152+
[env:ci-arduino-3-esp-idf-log]
153+
board = ${sysenv.PIO_BOARD}
154+
build_flags =
155+
${env.build_flags}
156+
-D USE_ESP_IDF_LOG=1
157+
138158
[env:ci-arduino-3-no-json]
139159
board = ${sysenv.PIO_BOARD}
140160
lib_deps =

‎src/AsyncEventSource.cpp‎

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
// SPDX-License-Identifier: LGPL-3.0-or-later
22
// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov
33

4-
#include "Arduino.h"
5-
#if defined(ESP32)
6-
#include <rom/ets_sys.h>
7-
#endif
84
#include "AsyncEventSource.h"
5+
#include "AsyncWebServerLogging.h"
96

107
#define ASYNC_SSE_NEW_LINE_CHAR (char)0xa
118

@@ -25,9 +22,7 @@ static String generateEventMessage(const char *message, const char *event, uint3
2522
len += 42; // give it some overhead
2623

2724
if (!str.reserve(len)) {
28-
#ifdef ESP32
29-
log_e("Failed to allocate");
30-
#endif
25+
async_ws_log_e("Failed to allocate");
3126
return emptyString;
3227
}
3328

@@ -201,11 +196,7 @@ AsyncEventSourceClient::~AsyncEventSourceClient() {
201196

202197
bool AsyncEventSourceClient::_queueMessage(const char *message, size_t len) {
203198
if (_messageQueue.size() >= SSE_MAX_QUEUED_MESSAGES) {
204-
#ifdef ESP8266
205-
ets_printf(String(F("ERROR: Too many messages queued\n")).c_str());
206-
#elif defined(ESP32)
207-
log_e("Event message queue overflow: discard message");
208-
#endif
199+
async_ws_log_e("Event message queue overflow: discard message");
209200
return false;
210201
}
211202

@@ -231,11 +222,7 @@ bool AsyncEventSourceClient::_queueMessage(const char *message, size_t len) {
231222

232223
bool AsyncEventSourceClient::_queueMessage(AsyncEvent_SharedData_t &&msg) {
233224
if (_messageQueue.size() >= SSE_MAX_QUEUED_MESSAGES) {
234-
#ifdef ESP8266
235-
ets_printf(String(F("ERROR: Too many messages queued\n")).c_str());
236-
#elif defined(ESP32)
237-
log_e("Event message queue overflow: discard message");
238-
#endif
225+
async_ws_log_e("Event message queue overflow: discard message");
239226
return false;
240227
}
241228

‎src/AsyncJson.cpp‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov
33

44
#include "AsyncJson.h"
5+
#include "AsyncWebServerLogging.h"
56

67
#if ASYNC_JSON_SUPPORT == 1
78

@@ -123,9 +124,7 @@ void AsyncCallbackJsonWebHandler::handleRequest(AsyncWebServerRequest *request)
123124
// POST / PUT / ... requests:
124125
// check if JSON body is too large, if it is, don't deserialize
125126
if (request->contentLength() > _maxContentLength) {
126-
#ifdef ESP32
127-
log_e("Content length exceeds maximum allowed");
128-
#endif
127+
async_ws_log_e("Content length exceeds maximum allowed");
129128
request->send(413);
130129
return;
131130
}
@@ -172,9 +171,7 @@ void AsyncCallbackJsonWebHandler::handleBody(AsyncWebServerRequest *request, uin
172171
if (request->_tempObject == NULL) {
173172
request->_tempObject = calloc(total + 1, sizeof(uint8_t)); // null-terminated string
174173
if (request->_tempObject == NULL) {
175-
#ifdef ESP32
176-
log_e("Failed to allocate");
177-
#endif
174+
async_ws_log_e("Failed to allocate");
178175
request->abort();
179176
return;
180177
}

‎src/AsyncMessagePack.cpp‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov
33

44
#include "AsyncMessagePack.h"
5+
#include "AsyncWebServerLogging.h"
56

67
#if ASYNC_MSG_PACK_SUPPORT == 1
78

@@ -103,9 +104,7 @@ void AsyncCallbackMessagePackWebHandler::handleBody(AsyncWebServerRequest *reque
103104
if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) {
104105
request->_tempObject = malloc(total);
105106
if (request->_tempObject == NULL) {
106-
#ifdef ESP32
107-
log_e("Failed to allocate");
108-
#endif
107+
async_ws_log_e("Failed to allocate");
109108
request->abort();
110109
return;
111110
}

‎src/AsyncWebServerLogging.h‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
// SPDX-License-Identifier: LGPL-3.0-or-later
2+
// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov
3+
4+
#pragma once
5+
6+
#ifdef ASYNCWEBSERVER_LOG_CUSTOM
7+
// The user must provide the following macros in AsyncWebServerLoggingCustom.h:
8+
// async_ws_log_e, async_ws_log_w, async_ws_log_i, async_ws_log_d, async_ws_log_v
9+
#include <AsyncWebServerLoggingCustom.h>
10+
11+
#elif defined(ASYNCWEBSERVER_LOG_DEBUG)
12+
// Local Debug logging
13+
#include <HardwareSerial.h>
14+
#define async_ws_log_e(format, ...) Serial.printf("E async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
15+
#define async_ws_log_w(format, ...) Serial.printf("W async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
16+
#define async_ws_log_i(format, ...) Serial.printf("I async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
17+
#define async_ws_log_d(format, ...) Serial.printf("D async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
18+
#define async_ws_log_v(format, ...) Serial.printf("V async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
19+
20+
#else
21+
// Framework-based logging
22+
23+
/**
24+
* LibreTiny specific configurations
25+
*/
26+
#if defined(LIBRETINY)
27+
#include <Arduino.h>
28+
#define async_ws_log_e(format, ...) log_e(format, ##__VA_ARGS__)
29+
#define async_ws_log_w(format, ...) log_w(format, ##__VA_ARGS__)
30+
#define async_ws_log_i(format, ...) log_i(format, ##__VA_ARGS__)
31+
#define async_ws_log_d(format, ...) log_d(format, ##__VA_ARGS__)
32+
#define async_ws_log_v(format, ...) log_v(format, ##__VA_ARGS__)
33+
34+
/**
35+
* Raspberry Pi Pico specific configurations
36+
*/
37+
#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350)
38+
#include <HardwareSerial.h>
39+
// define log levels
40+
#define ASYNC_WS_LOG_NONE 0 /*!< No log output */
41+
#define ASYNC_WS_LOG_ERROR 1 /*!< Critical errors, software module can not recover on its own */
42+
#define ASYNC_WS_LOG_WARN 2 /*!< Error conditions from which recovery measures have been taken */
43+
#define ASYNC_WS_LOG_INFO 3 /*!< Information messages which describe normal flow of events */
44+
#define ASYNC_WS_LOG_DEBUG 4 /*!< Extra information which is not necessary for normal use (values, pointers, sizes, etc). */
45+
#define ASYNC_WS_LOG_VERBOSE 5 /*!< Verbose information for debugging purposes */
46+
#define ASYNC_WS_LOG_MAX 6 /*!< Number of levels supported */
47+
// set default log level
48+
#ifndef ASYNCWEBSERVER_LOG_LEVEL
49+
#define ASYNCWEBSERVER_LOG_LEVEL ASYNC_WS_LOG_INFO
50+
#endif
51+
// error
52+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_ERROR
53+
#define async_ws_log_e(format, ...) Serial.printf("E async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
54+
#else
55+
#define async_ws_log_e(format, ...)
56+
#endif
57+
// warn
58+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_WARN
59+
#define async_ws_log_w(format, ...) Serial.printf("W async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
60+
#else
61+
#define async_ws_log_w(format, ...)
62+
#endif
63+
// info
64+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_INFO
65+
#define async_ws_log_i(format, ...) Serial.printf("I async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
66+
#else
67+
#define async_ws_log_i(format, ...)
68+
#endif
69+
// debug
70+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_DEBUG
71+
#define async_ws_log_d(format, ...) Serial.printf("D async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
72+
#else
73+
#define async_ws_log_d(format, ...)
74+
#endif
75+
// verbose
76+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_VERBOSE
77+
#define async_ws_log_v(format, ...) Serial.printf("V async_ws %s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__);
78+
#else
79+
#define async_ws_log_v(format, ...)
80+
#endif
81+
82+
/**
83+
* ESP8266 specific configurations
84+
*/
85+
#elif defined(ESP8266)
86+
#include <ets_sys.h>
87+
// define log levels
88+
#define ASYNC_WS_LOG_NONE 0 /*!< No log output */
89+
#define ASYNC_WS_LOG_ERROR 1 /*!< Critical errors, software module can not recover on its own */
90+
#define ASYNC_WS_LOG_WARN 2 /*!< Error conditions from which recovery measures have been taken */
91+
#define ASYNC_WS_LOG_INFO 3 /*!< Information messages which describe normal flow of events */
92+
#define ASYNC_WS_LOG_DEBUG 4 /*!< Extra information which is not necessary for normal use (values, pointers, sizes, etc). */
93+
#define ASYNC_WS_LOG_VERBOSE 5 /*!< Verbose information for debugging purposes */
94+
#define ASYNC_WS_LOG_MAX 6 /*!< Number of levels supported */
95+
// set default log level
96+
#ifndef ASYNCWEBSERVER_LOG_LEVEL
97+
#define ASYNCWEBSERVER_LOG_LEVEL ASYNC_WS_LOG_INFO
98+
#endif
99+
// error
100+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_ERROR
101+
#define async_ws_log_e(format, ...) ets_printf(String(F("E async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__);
102+
#else
103+
#define async_ws_log_e(format, ...)
104+
#endif
105+
// warn
106+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_WARN
107+
#define async_ws_log_w(format, ...) ets_printf(String(F("W async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__);
108+
#else
109+
#define async_ws_log_w(format, ...)
110+
#endif
111+
// info
112+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_INFO
113+
#define async_ws_log_i(format, ...) ets_printf(String(F("I async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__);
114+
#else
115+
#define async_ws_log_i(format, ...)
116+
#endif
117+
// debug
118+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_DEBUG
119+
#define async_ws_log_d(format, ...) ets_printf(String(F("D async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__);
120+
#else
121+
#define async_ws_log_d(format, ...)
122+
#endif
123+
// verbose
124+
#if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_VERBOSE
125+
#define async_ws_log_v(format, ...) ets_printf(String(F("V async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__);
126+
#else
127+
#define async_ws_log_v(format, ...)
128+
#endif
129+
130+
/**
131+
* Arduino specific configurations
132+
*/
133+
#elif defined(ARDUINO)
134+
#if defined(USE_ESP_IDF_LOG)
135+
#include <esp_log.h>
136+
#define async_ws_log_e(format, ...) ESP_LOGE("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
137+
#define async_ws_log_w(format, ...) ESP_LOGW("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
138+
#define async_ws_log_i(format, ...) ESP_LOGI("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
139+
#define async_ws_log_d(format, ...) ESP_LOGD("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
140+
#define async_ws_log_v(format, ...) ESP_LOGV("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
141+
142+
#else
143+
#include <esp32-hal-log.h>
144+
#define async_ws_log_e(format, ...) log_e(format, ##__VA_ARGS__)
145+
#define async_ws_log_w(format, ...) log_w(format, ##__VA_ARGS__)
146+
#define async_ws_log_i(format, ...) log_i(format, ##__VA_ARGS__)
147+
#define async_ws_log_d(format, ...) log_d(format, ##__VA_ARGS__)
148+
#define async_ws_log_v(format, ...) log_v(format, ##__VA_ARGS__)
149+
#endif // USE_ESP_IDF_LOG
150+
151+
/**
152+
* ESP-IDF specific configurations
153+
*/
154+
#else
155+
#include <esp_log.h>
156+
#define async_ws_log_e(format, ...) ESP_LOGE("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
157+
#define async_ws_log_w(format, ...) ESP_LOGW("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
158+
#define async_ws_log_i(format, ...) ESP_LOGI("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
159+
#define async_ws_log_d(format, ...) ESP_LOGD("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
160+
#define async_ws_log_v(format, ...) ESP_LOGV("async_ws", "%s() %d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
161+
#endif // !LIBRETINY && !ARDUINO
162+
163+
#endif // ASYNCWEBSERVER_LOG_CUSTOM

0 commit comments

Comments
 (0)