Monitoring PSPDFKit Server
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).
Question: How should I monitor the PSPDFKit application?
PSPDFKit Server behaves like a normal Docker container, so depending on the deployment infrastructure it can be monitored with the https://docs.docker.com/engine/reference/commandline/stats and https://docs.docker.com/engine/reference/commandline/ps tooling for memory, cpu and disk usage. The image definition also includes a HEALTHCHECK parameter (see https://docs.docker.com/engine/reference/builder/#healthcheck), so that it’s automatically monitored by Docker itself.
API endpoints are described in the documentation https://pspdfkit.com/guides/server/server-api/overview and https://pspdfkit.com/guides/server/client-api/overview. In general it’s important to keep an eye on the number of http responses in the 500 and 4xx ranges (which can be done from the application that interacts with PSPDFKit Server).
Please feel free to reach out with specific information if you need anything else.