Java Management Extension (JMX)
The Java Management Extension (JMX) can be used to access the webPDF server for administration and monitoring. Via JMX e.g. information about the embedded Tomcat server, the configured logging and the webPDF server itself can be retrieved. Via JMX, the webPDF server can also be integrated into monitoring tools, for example, to monitor the availability and utilization of the server.
Configuration of JMX
To configure JMX, parameters must be specified when starting the webPDF server for the Java environment. On Windows this is done via the configuration files webPDF.vmoptions or webPDF.service.vmoptions and on Linux directly via the startup script webpdf.sh or webpdf.service (see "Configuring the Java environment").
For example, enter the following lines in the webPDF.service.vmoptions under Windows:
After adjusting the parameters, the webPDF server service must be restarted.
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.local.only=false
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
Use -Dcom.sun.management.jmxremote.port to specify a free port on which you want to address JMX.
Please note that these are only exemplary settings that you should adjust. Especially TLS access and the use of a password for access should be adjusted in a production environment (see Monitoring and Management Using JMX Technology).
Java Mission Control (JMC)
To access the webPDF server using JMX, Java Mission Control (JMC) is especially useful. The tool can be found as an OpenSource project on the page https://github.com/openjdk/jmc. The corresponding versions from various providers are also listed there.
In this example we use the version of Eclipse Adoptium, because the webPDF server also uses the OpenJDK version from there.
Start JMC and create a new connection there.
In the JVM Connection dialog, enter the data from the above configuration:
Close the settings and then right-click on the new entry. There select Start JMX Console to establish the connection.
If the connection is established, then on the right side you will see all the information of the server. On the MBean Browser tab you can see the information about the Tomcat server (Catalina), logging (java.util.logging) and the webPDF server (webPDF).
