Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call out Jolokia agent installation requirement in metricbeat documentation #4344

Closed
ppf2 opened this issue May 18, 2017 · 3 comments
Closed
Labels
docs Metricbeat Metricbeat module Team:Integrations Label for the Integrations team

Comments

@ppf2
Copy link
Member

ppf2 commented May 18, 2017

Users out there may not have heard of Jolokia before.

Currently, our documentation does not reference their installation guide or call out the Jolokia agent as a pre-requisite for this metricbeat module (we have users looking at our metricset named "jmx" and expecting it to work directly against any jmx server).

In the https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-metricset-jolokia-jmx.html section, we simply mention that this is tested against Jolokia 1.3.4.

It will be helpful to call out Jolokia agent being required. In fact, we don't link to Jolokia documentation other than in the limitations section of our guide.

The following will be helpful to provide as a reference:

https://jolokia.org/reference/html/agents.html

Jolokia is an agent based approach to JMX, which requires that clients install an extra piece of software, the so-called agent. This software either needs to be deployed on the target server which should be accessed via remote JMX (Section 2.1, “Agent mode”), or it can be installed on a dedicated proxy server (Section 2.2, “Proxy Mode”).

i.e. Users must first install the agent either on the target server, or on a dedicated proxy server.

We probably also want to have a short paragraph in the doc that talks about how we interact with Jolokia, eg.

Metricbeat simply communicates with the Jolokia HTTP/REST endpoint made available by the Jolokia agent (installed either as an agent running on the target JMX sever, or on a dedicated proxy server). This HTTP/REST endpoint will expose the JMX metrics over HTTP/REST/JSON for consumption by the metricbeat.

@ppf2 ppf2 added docs Metricbeat Metricbeat labels May 18, 2017
@Budman17r
Copy link

+1

@ppf2
Copy link
Member Author

ppf2 commented May 30, 2017

Furthermore, I just found out from @ruflin that our Jolokia module implementation does not currently support communicating with a Jolokia agent when the agent is installed using the proxy mode.

https://jolokia.org/reference/html/agents.html
Jolokia is an agent based approach to JMX, which requires that clients install an extra piece of software, the so-called agent. This software either needs to be deployed on the target server which should be accessed via remote JMX (Section 2.1, “Agent mode”), or it can be installed on a dedicated proxy server (Section 2.2, “Proxy Mode”).

So in addition to adding general pre-requisite information to the documentation on Jolokia agent installation, let's call out the agent mode as the only mode we support today.

@dedemorton
Copy link
Contributor

This was fixed in #7969, but didn't get closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Metricbeat Metricbeat module Team:Integrations Label for the Integrations team
Projects
None yet
Development

No branches or pull requests

4 participants