Monitoring Options¶

Admin Tool¶

The engine’s web interface, at http://example.com:port, gives an overview of the engine’s status. For more information on this feature refer to Admin Tool Interface.

Discovery Log File¶

The engine’s log file is available in the engine’s working directory named log. The Discovery log file is named discovery.log and rotated versions are named discovery.log.[0-9].

Customers can tail the log file for insight into engine activity.

As of version 3.13, the Discovery engine uses the SLF4J logging system and comes preconfigured to use log4j. You can specify your own log configuration by setting the log4j.configuration system property. If you are using our startup scripts then you can do this by adding the following line to discovery.properties:

jvm.args = -Dlog4j.configuration=file:///path/to/log4j.properties

For more information on engine installation directories, refer to Recommended Installation Directory Hierarchy.

System State Web Service¶

The status of the engine is also exposed as a web service at http://example.com:port/ws/info/system-state which, if running properly, returns:

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type='text/xsl'
       href='/doc/style/xmlverbatim/xmlverbatimwrapper.xsl'?>
<system-state>
    <running>
        <true />
    </running>
    <queryable>
        <true />
    </queryable>
</system-state>

If the running element’s child has a value of true, then the engine is fully functioning and ready to receive queries.

For more information on the System State web service, refer to System State.

Munin plugin¶

The Discovery Search Engine exposes a number of data points that are of interest on a web service at /ws/statistics. The statistics exposed are transient, all counters will reset when the engine stops.

For more information on using the munin plugin refer to the description of the Statistics web service.