AppSuite:DocumentsMonitoring

OX Documents / OX Documentconverter Monitoring

General

The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange Middleware (aka groupware backend) including OX Documents and Documentconverter.

For general information about the JMX interface see https://oxpedia.org/wiki/index.php?title=OX_monitoring_interface

The usage of Jolokia to access monitoring data is described here https://oxpedia.org/wiki/index.php?title=Jolokia

Plugins are available for integration in the munin monitoring framework. https://oxpedia.org/wiki/index.php?title=OX_munin_scripts

OX Documentconverter

Monitoring data for OX Documentconverter can be obtained after installation of the package open-xchange-munin-scripts-jolokia. It uses Jolokia (preferred) if available and configured. A fallback is to call "showruntimeestats" otherwise.

Here is a list of sample data provided by

# /opt/open-xchange/sbin/showruntimestats --port 9998 -y
CacheHitRatio = 0.8764556962025316
ErrorCacheHitRatio = 0.8372093023255814
JobsProcessed = 1975
JobErrorsTotal = 172
JobErrorsTimeout = 124
PeakJobCountInQueue_Background = 2
PeakJobCountInQueue_Low = 0
PeakJobCountInQueue_Medium = 1
PeakJobCountInQueue_High = 0
PeakJobCountInQueue_Instant = 5
PeakJobCountInQueue_Total = 6
MedianQueueTimeMillis_Background = 1
MedianQueueTimeMillis_Low = 0
MedianQueueTimeMillis_Medium = 1
MedianQueueTimeMillis_High = 0
MedianQueueTimeMillis_Instant = 1
MedianQueueTimeMillis_Total = 3
MedianConversionTimeMillis_Background = 1006
MedianConversionTimeMillis_Low = 0
MedianConversionTimeMillis_Medium = 663
MedianConversionTimeMillis_High = 0
MedianConversionTimeMillis_Instant = 159
MedianConversionTimeMillis_Total = 1828
MedianJobTimeMillis_Background = 1006
MedianJobTimeMillis_Low = 0
MedianJobTimeMillis_Medium = 664
MedianJobTimeMillis_High = 0
MedianJobTimeMillis_Instant = 162
MedianJobTimeMillis_Total = 1832

OX Documentconverter and munin

The Documentconverter uses a different port to provide monitoring data via Jolokia. The corresponding oxJolokiaURL is has to be configured with an entry in the settings.

[ox_documentconverter*]
env.oxJolokiaUrl http://localhost:8008/monitoring/jolokia

OX Documents

Monitoring data for OX Documents can be obtained after installation of the package open-xchange-documents-monitoring.

Here is a list of sample data provided by

#  /opt/open-xchange/sbin/showruntimestats -f
DocumentsSizeMedian_Spreadsheet = 0
DocumentsCreated_Presentation = 2
DocumentsCreated_Spreadsheet = 2
RestoreDocCurrent = 40
RestoreDocRestoredSuccess = 0
RestoreDocRestoredFailure = 0
DocumentsSizeMedian_Text = 0
DocumentsSizeMedian_Presentation = 0
RestoreDocCreated_Total = 40
RestoreDocRemoved_Total = 0
DocumentsSizeMedian_Total = 0
DocumentsCreated_Total = 4
DocumentsCreated_Text = 0
DocumentsClosed_Text_Timeout = 0
DocumentsSaved_Text_Total = 2
DocumentsSaved_Text_Close = 2
DocumentsSaved_Text_100ops = 0
DocumentsSaved_Text_15mins = 0
DocumentsOperations_Text_Incoming = 8
DocumentsOperations_Text_Distributed = 0
DocumentsOpened_Text_Total = 2
DocumentsOpened_Text_OOXML = 1
DocumentsOpened_Text_Binary = 0
DocumentsOpened_Text_ODF = 1
DocumentsClosed_Text_Total = 2
DocumentsOpened_Spreadsheet_Total = 22
DocumentsOpened_Spreadsheet_OOXML = 16
DocumentsOpened_Spreadsheet_Binary = 0
DocumentsOpened_Spreadsheet_ODF = 6
DocumentsClosed_Spreadsheet_Total = 19
DocumentsClosed_Spreadsheet_Timeout = 0
DocumentsSaved_Spreadsheet_Total = 10
DocumentsSaved_Spreadsheet_Close = 10
DocumentsSaved_Spreadsheet_100ops = 0
DocumentsSaved_Spreadsheet_15mins = 0
DocumentsOperations_Spreadsheet_Incoming = 46
DocumentsOperations_Spreadsheet_Distributed = 0

Further Reading

Further details about accessing JMX data via Jolokia are described in this article https://oxpedia.org/wiki/index.php?title=Jolokia_LoginCounter_HOWTO A call derived from this example for OX Documentconverter looks like

$ curl http://yourname:yourpassword@localhost:8008/monitoring/jolokia/read/com.openexchange.documentconverter:name=DocumentConverterInformation/JobsProcessed
{"timestamp":1471868314,"status":200,"request":{"mbean":"com.openexchange.documentconverter:name=DocumentConverterInformation","attribute":"JobsProcessed","type":"read"},"value":6616}