Jolokia: Difference between revisions

From Open-Xchange
No edit summary
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= How to interact with Jolokia for Open-Xchange=
{{Migration|title=Jolokia|link=https://documentation.open-xchange.com/7.10.0/middleware/components/monitoring/jolokia.html}}
 
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, no authentication is used.</nowiki>
|-
| com.openexchange.jolokia.password
|
| <nowiki>Password used for authentification, if not set "secret" is used. Only needed if com.openexchange.jolokia.user 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>
|}
 
== Things to mention about Jolokia ==
 
As Jolokia represents a JMX-Interface it is highly recommended to not 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, you can connect to jolokia directly with the servers address, e.g.: http://oxserver1:8009/monitoring/jolokia
 
=== Jolokia with AJP ===
 
When using AJP, you need to enable forwarding for each server, keep in mind that those should be only accessable inside your intranet.
 
An Apache proxy_ajp.conf could look like this:
<code>
    <Location /internal>
        # restrict access to internal
        Order Deny,Allow
        Deny from all
        Allow from 127.0.0.1
        # you might add more ip addresses / networks here
        # if the apache is not on the same machine as the OX-server
        # Allow from 192.168 10 172.16
    </Location>
    ...
    <Proxy /internal/ox1/monitoring>
        ProxyPass ajp://oxhost1:8009/monitoring
    </Proxy>
    ...
</code>
 
Jolokia on oxhost1 is accessable by http://apacheaddress/internal/ox1/monitoring/jolokia .

Latest revision as of 11:23, 29 October 2018

Jolokia

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.