jmx4py

A Python Client for the Jolokia JMX Agent

Overview

Jolokia is a JMX-HTTP bridge giving an alternative to JSR-160 connectors. It is an agent based approach with support for many platforms. In addition to basic JMX operations it enhances JMX remoting with unique features like bulk requests or fine grained security policies.

jmx4py offers a client API similar to the existing Jolokia clients for Perl (jmx4perl), Java and Javascript. Additionally, it'll build upon the basic API and offer further features related to monitoring and controlling JVMs via JMX using Python.

Setup

To create a working directory for this project, follow these steps on a POSIX system:

git clone "https://github.com/jhermann/jmx4py.git"
cd "jmx4py"
. .env --yes --develop
invoke build --docs test check

The .env script creates a virtualenv and installs the necessary tools into it. See the script for details.

Now you can explore the API by simply issuing the following command:

invoke explore

For that to succeed, you must also have a working Java + Maven environment, since a small test application is built and then started in the background, so you can work against a live JVM.

See CONTRIBUTING for more.

Installation

TODO: pip install / dh-virtualenv

Usage

jmx4py offers the following command line tools... TODO

For using jmx4py from Python, consult the API documentation available at TODO

Known Limitations & Issues

• The API is subject to change for 0.x, until enough practical experience is gained.
• Only Jolokia 1.0 and up (Protocol v6) is supported.
• GET requests aren't supported.
• Bulk requests aren't supported.
• Python 2.7 is used for development, and 2.7 and 3.4 are tested in continuous integration.

References

Project

• jmx4py @ PyPI
• jmx4py @ Open HUB
• Jolokia

Tools

• Cookiecutter
• PyInvoke
• pytest
• tox
• Pylint
• twine
• bpython
• yolk3k

Packages

• Rituals
• Click

Acknowledgements

…