/ 
jmx4perl-0.90_1
River stage one • 1 direct dependent • 1 total dependent
/ j4p_agent_manager

NAME

j4p_agent_manager - Utility for managing Jolokia agents used by jmx4perl

SYNOPSIS

# Execute command 'command' with options and additional, command specific 
# arguments
j4p_agent_manager [options] <command> <arg1> <arg2> ...

# Download the latest Jolokia WAR agent compatible with this jmx4perl release
# into the local directory as 'jolokia.war'
j4p_agent_manager download

# Print information about a downloaded agent (i.e. its version)
j4p_agent_manager info jolokia.war

# Current Jmx4Perl version
j4p_agent_manager --version

# Online help
j4p_agent_manager --help

Options:

Command 'download':
   --agent <type>[:<version>]  Agent to download. <type> must be one of "war", "osgi", 
                               "osgi-bundle", "mule" or "jdk6". An optional Jolokia version 
                               can be added after a colon.
   --outdir <dir>              Output directory for the agent downloaded (default: ".")
   --repository <repo-url>     Repository URL from where to fetch the Jolokia agent. 
                               (default is taken from meta data)

Command 'info':
   --verify                    Check signature of given file
   
General:
   --quiet            No output on the standard out
   --verbose          Print verbose
   --no-color         Don't use colors
   --no-cache         Fetch meta information afresh from www.jolokia.org
   --proxy            Proxy-URL for HTTP(S) requests
   --proxy-user       Proxy user for proxy authentication
   --proxy-password   Proxy password for proxy authentication
   --help             Print online help (and exit)
   --version          Current Jmx4Perl version

DESCRIPTION

j4p_agent_manager is a command line utility for managing the Jolokia agent, which is used by jmx4perl for accessing remote JMX information. Several commands are available

download (default)

This mode allows for downloading the latest Jolokia agent version compatible with this Jmx4Perl installation or any other agent version. PGP is used optionally for verifying the integrity of the downloaded artifacts.

info

For a given Jolokia agent, this manager gives you information about the version of the agent and also allows for PGP validation.

META-DATA

Meta-data about the available Jolokia agents and their compatibility to given Jmx4Perl versions is obtained from http://www.jolokia.org/jolokia.meta. This meta data is cached locally in ~/.jolokia_meta and only fetched once a day. The meta download can be forced by using the option --no-cache.

VALIDATION

j4p_agent_manager uses PGP for validating all files downloaded. For this to work, the CPAN module Crypt::OpenPGP must be installed. If it is not available, validation falls back to simple checksum validation with a SHA1 alogrithm, or, if this is not possible to an MD5 check. Since the checksums are also downloaded over an insecure channel, using PGP is highly recommended. The public key used for the signature check is contained locally in JMX::Jmx4Perl::Agent::Manager::Verifier::OpenPGPVerifier so there is no need to add the key manually or to download it from an PGP key server.

COMMANDS

download

This commands allows for downloading a certain Jolokia agent from Jolokia's Maven repository. The repository URL is taken from the meta descriptor, but can be overridden with the --repository option. Agents come in several flavors:

  • war

    The WAR agent is the most popular one and is used for instrumenting an JEE application server. It is a simple web application which needs to deployed on the target server

  • osgi, osgi-bundle

    The OSGi agents can be used to access OSGi containers

  • mule

    For accessing a Mule ESB, this agent is the proper choice

  • jdk6

    For all other Java server, which don't contain a servlet container, this agent can be used. The only prerequisite is, that the application must run with an Oracle Java 6 virtual machine

Much more information about those agents can be found at http://www.jolokia.org/agent.html.

By default, the war agent is downloaded. The agent type ("war", "osgi", "osgi-bundle", "mule" or "jdk6" can be specified with the --agent option.

Also by default, the latest agent version compatible with the installed Jmx4Perl release is downloaded. A specific version can be given on the command line also with the --agent option, added after the agent type with a ':'. E.g. --agent osgi:0.82 will download the OSGi agent with version 0.82.

The output directory for the agent can be specified with the --outdir option. By default, the agent is stored in the current working directory.

info

In order to determine the version number of an already downloaded agent, the info command can be used. It takes as single argument the path to the agent, e.g.

j4p_agent_manager info ./jolokia.war

With the option --verify an additional signature check can be performed, where the signature is fetched from the Jolokia repository.

SEE ALSO

check_jmx4perl - a production ready Nagios check using JMX::Jmx4Perl

jmx4perl - CLI for accessing the agents

j4psh - readline based JMX shell with context sensitive command line completion.

LICENSE

This file is part of jmx4perl.

Jmx4perl is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

jmx4perl is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with jmx4perl. If not, see <http://www.gnu.org/licenses/>.

AUTHOR

roland@cpan.org