mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-10-19 11:19:36 +00:00
yhirose
9bfd2ddf1c
Bring the READMEs and the docs pages (en and ja) in line with the current header: - Fix the client sample that does not compile, the Transfer-Encoding statement for default headers, the verifier callback comment, the thread pool spawn rule, the sanitize_filename description, and the inverted Accept-Encoding sentence. - Describe recent behaviour: TLS errors behind Read/Write failures, Host validation, Connection: close for a body without length, content_reader rules, refused CONNECT, WebSocketClient proxies, CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT, the SSE event size limit, and the payload limit of the Stream API. - Complete the API references of WebSocket, WebSocketClient and the stream:: helpers, and the SSE reconnect rules. - Fix cookbook pages: keychain loading on every backend, received Close status, a multipart sample that trusted the client's file name, an echo sample that sent binary as text, SNI, pre-request handler scope, stop() with WebSocket handlers, and the thread pool notes. - Restore the mutex in the LLM app's Chapter 5 code.
71 lines
2.7 KiB
Markdown
71 lines
2.7 KiB
Markdown
---
|
|
title: "S15. Log Requests on the Server"
|
|
order: 34
|
|
status: "draft"
|
|
---
|
|
|
|
To log the requests the server receives and the responses it returns, use `Server::set_logger()`. The callback fires once per request, right before the response is written, making it the foundation for access logs and metrics collection.
|
|
|
|
## Basic usage
|
|
|
|
```cpp
|
|
svr.set_logger([](const httplib::Request &req, const httplib::Response &res) {
|
|
std::cout << req.remote_addr << " "
|
|
<< req.method << " " << req.path
|
|
<< " -> " << res.status << std::endl;
|
|
});
|
|
```
|
|
|
|
The log callback receives both the `Request` and the `Response`. You can grab the method, path, status, client IP, headers, body — whatever you need.
|
|
|
|
`req.path` is percent-decoded, so it may contain control characters such as CR/LF. Escape it before writing it to a log file, or a crafted request can forge log lines.
|
|
|
|
## Access-log style format
|
|
|
|
Here's an Apache/Nginx-ish access log format.
|
|
|
|
```cpp
|
|
svr.set_logger([](const auto &req, const auto &res) {
|
|
auto now = std::time(nullptr);
|
|
char timebuf[32];
|
|
std::strftime(timebuf, sizeof(timebuf), "%Y-%m-%d %H:%M:%S",
|
|
std::localtime(&now));
|
|
|
|
std::cout << timebuf << " "
|
|
<< req.remote_addr << " "
|
|
<< "\"" << req.method << " " << req.path << "\" "
|
|
<< res.status << " "
|
|
<< res.body.size() << "B"
|
|
<< std::endl;
|
|
});
|
|
```
|
|
|
|
For a response sent through a content provider, such as a file served from a mount point, `res.body` is empty here, so the size shows `0B`.
|
|
|
|
## Measure request time
|
|
|
|
To include request duration in the log, stash a start timestamp in `res.user_data` from a pre-routing handler, then subtract in the logger.
|
|
|
|
```cpp
|
|
svr.set_pre_routing_handler([](const auto &req, auto &res) {
|
|
res.user_data.set("start", std::chrono::steady_clock::now());
|
|
return httplib::Server::HandlerResponse::Unhandled;
|
|
});
|
|
|
|
svr.set_logger([](const httplib::Request &req, const httplib::Response &res) {
|
|
auto *start = res.user_data.get<std::chrono::steady_clock::time_point>("start");
|
|
auto elapsed = start
|
|
? std::chrono::duration_cast<std::chrono::milliseconds>(
|
|
std::chrono::steady_clock::now() - *start).count()
|
|
: 0;
|
|
std::cout << req.method << " " << req.path
|
|
<< " " << res.status << " " << elapsed << "ms" << std::endl;
|
|
});
|
|
```
|
|
|
|
Since the logger runs before the response is written, the time doesn't include sending the body.
|
|
|
|
For more on `user_data`, see [S12. Pass data between handlers with `res.user_data`](../s12-user-data).
|
|
|
|
> **Note:** The logger runs synchronously on the same thread as request processing, and all logger calls on a server share one lock. Heavy work inside it hurts throughput — push it to a queue and process asynchronously if you need anything expensive.
|