Usage

General

In order to run JMX Extractor go to $JLUPIN_HOME/jmx-extractor/bin and execute the following script:

  • On Windows: jmx-extractor.cmd
  • On Linux: jmx-extractor.sh

according to the following syntax:

jmx-extractor <command> [<option> <value> ...]

where command is one from the following list:

  • -h - print help message (options are ignored in this case)
  • by-configuration - collect data basing on the runtime configuration
  • all - collect all data regardless the runtime configuration

and multiple options can be provided, that overwrites runtime configuration in scope of JMX connection properties and out format:

  • -a (or --address) - overwrites connection:address in runtime configuration
  • -jp (or --jmxPort) - overwrites connection:jmxPort in runtime configuration
  • -pt (or --printerType) - overwrites printer:type in runtime configuration
  • -ps (or --printerSeparator) - overwrites printer:separator in runtime configuration

Using on localhost only

If you want to use JMX locally and don't allow to connect remotely to JMX interfaces from the environment the following additional options to JMX options should be added:

-Djava.rmi.server.hostname=127.0.0.1 -Dcom.sun.management.jmxremote.host=127.0.0.1
  • in the initial JLupin Platform configuration (JMX_OPT in $JLUPIN_HOME/platform/start/configuration/setenv)
  • in the microservice configuration (jmxOptions in $JLUPIN_HOME/platform/application/<microservice>/configuration.yml or $JLUPIN_HOME/platform/application/<microservice>/servlet_configuration.yml depending on the type of microservice).

Output

Full example of microservice output object can be found here: native, servlet, queue, channel) and full example of Main Server output object can be found here).