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

Added more documentation to README #671

Closed
wants to merge 1 commit into from
Closed

Added more documentation to README #671

wants to merge 1 commit into from

Conversation

davidmpaz
Copy link

Hi,

could we please add this to main stream, for dummies like me? In my case it was not straight clear what to do in order to get things up and running. I think this could contribute to newbies to get onboard better.

Thanks and cheers.
David


Changes:

Added suggestions on running the agent when getting Exceptions:

io.prometheus.jmx.shaded.io.prometheus.jmx.JmxCollector.collect JMX scrape failed:
java.io.IOException: Failed to retrieve RMIServer stub: javax.naming.NoInitialContextException:
Can not instantiate class: org.apache.naming.java.javaURLContextFactory

Added more steps to use it as http server.

Added suggestions on running the agent when getting Exceptions:

io.prometheus.jmx.shaded.io.prometheus.jmx.JmxCollector.collect JMX scrape failed:
java.io.IOException: Failed to retrieve RMIServer stub: javax.naming.NoInitialContextException:
Can not instantiate class: org.apache.naming.java.javaURLContextFactory

Added more steps to use it as http server.

resolves: #666

Signed-off-by: David Paz <david.paz@lbbw.de>
@dhoard
Copy link
Collaborator

dhoard commented Jan 16, 2022

@davidmpaz Updating the README makes sense, but I don't feel we should reference a GitHub issue in the documentation.

@davidmpaz
Copy link
Author

@davidmpaz Updating the README makes sense, but I don't feel we should reference a GitHub issue in the documentation.

Should i update the Pull Request ?

@dhoard
Copy link
Collaborator

dhoard commented Jan 16, 2022

Should i update the Pull Request ?

Please. Here is what I would suggest... something like https://github.com/dhoard/jmx_exporter/tree/update-readme

@davidmpaz
Copy link
Author

I am fine with that. Just one small suggestion please. I think it is still usefull to tell explicitly it is needed to build the project to get a http server release in place, that or include it in the downloadable artifacts alonside with the agent :)

Besides that we can close this PR right away.

Thanks for your time on this,
cheers,
David

@davidmpaz davidmpaz closed this Jan 16, 2022
@dhoard
Copy link
Collaborator

dhoard commented Jan 16, 2022

@davidmpaz the HTTP server is embedded in the agent jar.

@davidmpaz
Copy link
Author

oh, good to know :) it was not obvious for me at start. Thanks! 😅

@fstab
Copy link
Member

fstab commented Jan 16, 2022

Thanks a lot. @dhoard please create a PR out of your branch.

BTW this ticket got me thinking we should terminate with an error if jmx_exporter is started as an agent but jmxUrl or hostPort is configured. I created #673 for that. Let me know if I'm missing a valid scenario where you want this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants