Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
218 lines (208 sloc) 7.67 KB
title review labels toc confluence tree_item_index version_override history
Monitoring and Maintenance
comment date status
2017-12-14
ok
content-review-lts2016
monitoring
datasource
bdelbosc
monitoring-component
lts2017-ok
true
ajs-parent-page-id ajs-parent-page-title ajs-space-key ajs-space-name canonical canonical_source page_id shortlink shortlink_source source_link
31033314
Nuxeo Server
NXDOC
Nuxeo Platform Developer Documentation
Monitoring+and+Maintenance
950318
LoAO
/display/NXDOC/Monitoring+and+Maintenance
300
LTS 2015 6.0 5.8
710/admindoc/monitoring-and-maintenance
60/admindoc/monitoring-and-maintenance
58/admindoc/monitoring-and-maintenance
author date message version
Mathieu Guillaume
2015-12-08 12:02
25
author date message version
Solen Guitter
2015-02-05 13:25
24
author date message version
Benoit Delbosc
2015-02-04 10:40
remove deprecated info, add new page reporting problem
23
author date message version
Benoit Delbosc
2015-02-04 10:37
Reverted from v. 18
22
author date message version
Benoit Delbosc
2015-02-04 10:21
21
author date message version
Benoit Delbosc
2015-02-04 09:54
20
author date message version
Benoit Delbosc
2015-02-03 14:35
Add jvm command useful for support
19
author date message version
Manon Lumeau
2014-12-10 16:06
18
author date message version
Solen Guitter
2013-10-14 17:25
17
author date message version
Solen Guitter
2013-08-06 11:25
16
author date message version
Solen Guitter
2013-05-22 11:37
15
author date message version
Solen Guitter
2013-05-22 11:36
14
author date message version
Solen Guitter
2013-05-22 11:36
13
author date message version
Thierry Delprat
2012-10-01 18:27
12
author date message version
Thierry Delprat
2012-10-01 11:20
11
author date message version
Mathieu Guillaume
2012-02-09 13:50
Migrated to Confluence 4.0
10
author date message version
Mathieu Guillaume
2012-02-09 13:50
svn -> hg
9
author date message version
Mathieu Guillaume
2011-11-29 13:17
replaced 5.4.3 with 5.5
8
author date message version
Solen Guitter
2011-11-14 15:27
replaced 5.4.3 with 5.5
7
author date message version
Benoit Delbosc
2011-08-22 15:20
6
author date message version
Julien Carsique
2011-08-11 18:23
5
author date message version
Julien Carsique
2011-08-11 18:16
4
author date message version
Solen Guitter
2011-03-04 17:32
3
author date message version
Solen Guitter
2011-03-03 17:22
2
author date message version
Admin name placeholder
2010-03-01 00:58
1

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 page='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. The server checks the status of all the probes that are registered to be evaluated for this health check. It returns either:
    • HTTP 200 if all checks pass and a JSON with the detailed status like:
        {
         "s3BinaryManagerStatus":"ok",
         "runtimeStatus":"ok",
         "elasticSearchStatus":"ok",
         "ldapDirectories":"ok",
         "repositoryStatus":"ok"
         }
    or
    • HTTP 500 if at least one check fails:
      {
      "s3BinaryManagerStatus":"failed",
      "runtimeStatus":"ok",
      "elasticSearchStatus":"ok",
      "ldapDirectories":"ok",
      "repositoryStatus":"ok"
      }
    A probe is only run if the last execution time was more than 20s ago. For intervals less than 20s, the last execution status is returned as part of the response. See details about ( [probes in Metrics and monitoring ]({{page page='metrics-and-monitoring'}}#probes)) for the list of probes evaluated for the healthCheck and how to contribute new checks.
  • http://NUXEO_SERVER/nuxeo/runningstatus?info=probe&key=xxx where key can be any probe registered to be evaluated for the health check returns 200 OK if the check passes
  • 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)]({{page page='configuration-parameters-index-nuxeoconf'}})).

{{#> panel type='code' heading='Sample output if something was wrong at startup (for instance, missing RelationService)'}}

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

{{/panel}}

You can get that information with ./bin/nuxeoctl status (see [nuxeoctl and Control Panel Usage]({{page page='nuxeoctl-and-control-panel-usage'}})).

 

You can’t perform that action at this time.