Nuxeo Server

Monitoring and Maintenance

Updated: March 18, 2024

Monitoring Nuxeo

Nuxeo JMX Monitoring

The Nuxeo Platform exposes a lot of metrics, either through JMX or through the Coda Hale Metrics library. See the Metrics and Monitoring page for more details.

Nuxeo Server Running and Components Loading Statuses

The Nuxeo Platform provides an URL for monitoring the server status. This method is actually also used by the Launcher to follow the server startup status, after checking the Java process status.

  • http://NUXEO_SERVER/nuxeo/runningstatus will be available at last. While it isn't reachable, the server is stopped or still starting.
  • http://NUXEO_SERVER/nuxeo/runningstatus?info=started returns true if the server finished starting and the Nuxeo runtime is fine with its components.
  • http://NUXEO_SERVER/nuxeo/runningstatus?info=summary&key=xxx returns true or false (see "info=started") and a detailed summary about components. Access to this URL is restricted by an access key configurable in nuxeo.conf (see "server.status.key" in Configuration Parameters Index (nuxeo.conf)).

Sample output if something was wrong at startup (for instance, missing RelationService)

= Nuxeo EP Started
= Component Loading Status: Pending: 7 / Unstarted: 0 / Total: 462
  * requires []
  * service:org.nuxeo.ecm.annotations.graph requires []
  * service:org.nuxeo.ecm.platform.relations.jena requires []
  * service:org.nuxeo.ecm.annotations.repository.graph requires []
  * service:org.nuxeo.ecm.platform.publisher.relations.contrib requires []
  * requires []
  * service:org.nuxeo.ecm.platform.comment.service.CommentServiceConfig requires []

You can get that information with ./bin/nuxeoctl status (see nuxeoctl and Control Panel Usage).