Difference between revisions of "Jolokia"

(One intermediate revision by the same user not shown)
Line 1: Line 1:
<div class="title">Jolokia</div>
'''Summary:''' This article tells you to use Jolokia, a JMX bridge, that is available vom AppSuite v7.4.0 on.
= How to interact with Jolokia for Open-Xchange=
Open-Xchange does support Jolokia as a remote JMX-Bridge over HTTP.
By Version 7.4.0 ongoing, it is located inside Open-Xchange Bundle and configured by jolokia.properties
Additional information can be found at http://www.jolokia.org/ .
== jolokia.properties ==
{|width="100%" style="table-layout: fixed" class='wikitable sortable' border='1'
! scope="col" width="30%" | Key
! scope="col" width="20%" | Default value
! scope="col" width="35%" | Comment
| com.openexchange.jolokia.start
| false
| start switch for jolokia
| com.openexchange.jolokia.servlet.name
| /monitoring/jolokia
| <nowiki>Under what servlet name jolokia will be published, please bear in mind that this should not be forwarded by apache and kept internal</nowiki>
| com.openexchange.jolokia.user
| <nowiki>User used for authentication with HTTP Basic Authentication. If not given, Jolokia will not start!</nowiki>
| com.openexchange.jolokia.password
| <nowiki>Password used for authentification, if not set "secret" is used.</nowiki>
| com.openexchange.jolokia.restrict.to.localhost
| true
| <nowiki>This setting will restrict jolokia access to localhost. It is completly ignored when a jolokia-access.xml is present</nowiki>
Keep in mind that Jolokia will not start unless you set <code> com.openexchange.jolokia.start = true </code> , <code> com.openexchange.jolokia.user = yourUser</code> and to <code> com.openexchange.jolokia.password = yourPassword</code>.
When using Munin-Scripts with Jolokia, this user and password also need to be changed.
== Running Jolokia ==
As Jolokia represents a JMX-Interface it is highly recommended '''not''' to forward it to the internet!
This is by default set through the use of <code>com.openexchange.jolokia.restrict.to.localhost = true</code> and can be changed by either setting it to <code>false</code> or providing a <code>jolokia-access.xml</code> inside <code>/opt/open-xchange/etc/</code>
For further information how to setup this file, http://www.jolokia.org/reference/html/security.html is a good start as all those settings are usable.
=== Jolokia with Grizzly ===
When using Grizzly and munin scripts on the same machine, you can connect to jolokia directly with the servers address, e.g.: <code>http://localhost:8009/monitoring/jolokia</code>.
When connecting through another machine, a best practise is to use the same forwarding as described below.
== Example ==
For a more detailed example, see https://oxpedia.org/wiki/index.php?title=Jolokia_LoginCounter_HOWTO

Latest revision as of 11:23, 29 October 2018


The content on this page has moved to https://documentation.open-xchange.com/7.10.0/middleware/components/monitoring/jolokia.html.

Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (https://documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.