PSPDFKit Server Logs
PSPDFKit Server has been deprecated and replaced by PSPDFKit Document Engine. All PSPDFKit Server and PSPDFKit for Web Server-Backed licenses will work as before and be supported until 15 May 2024 (we will contact you about license migration). To start using Document Engine, refer to the migration guide. With Document Engine, you’ll have access to robust new capabilities (read the blog for more information).
PSPDFKit Server is packaged as a Docker container, which allows you to use standardized Docker tooling to capture logs written by Server to the standard output. In addition, if you deploy Server in the cloud, all major cloud providers offer support for logs emitted by Docker containers running on their infrastructure with their log aggregation systems.
See the following:
Correlating Logs Using a Request ID
Log messages associated with HTTP requests are marked with a
request_id=<request-id> label. Logs correlated with the same request have the same request ID. This helps you determine which request triggered a specific response and what errors or warnings were emitted during request processing.
Here’s an example request and response log with a matching request ID:
[info] 2021-02-05 12:00:34.097 POST /api/documents request_id=FmDYakNs2xDF1NkAAASC [info] 2021-02-05 12:00:34.168 Sent 200 in 70ms request_id=FmDYakNs2xDF1NkAAASC
You can also customize the
request_id label by providing your own ID via the
X-Request-Id request header. The custom request ID needs to be between 20 and 200 characters long.