# Configuration

**JOLOKIA INSTALLATION**

Download the Jolokia agent from the official website: https://jolokia.org/download.html

Jolokia Agent Securisation (WAR)

You can assign security policies to restrict both access and use of the options available in the Jolokia agent.

These restrictions can be specified in a policy XML file. This file is divided into sections with which you can control various parameters:

IP-based restrictions  
General access can be allowed based on the IP address of an HTTP client. This restriction is specified in the&lt;remote&gt; section, it will contain &lt;host&gt; elements. The source can be an IP address, a hostname, or a network in CIDR format.

The following example allows access from localhost and all clients on the network  
10.0.0.0/16:

```
<remote>
<host>localhost</host>
<host>10.0.0.0/16</host>
</remote>
```

Command Restrictions

You can restrict the commands that will be allowed to be executed in a general way, by specifying which commands are allowed. To do this, use the &lt;commands&gt; section by specifying each command with a &lt;command&gt; element.

The following example enables the commands READ, LIST, SEARCH and VERSION . The other commands ( WRITE, EXEC ) would not be available:

```
<commands>
<command>read</command>
<command>list</command>
<command>version</command>
<command>search</command>
</commands>
```

There are restrictions on mbeans queries and request sources. Full help is available at the following link: https://jolokia.org/reference/html/security.html

https://pandorafms.com/guides/public/link/233#bkmrk-ejemplo-de-pol%C3%ADtica-  
  
Example security policy

This example allows connection from localhost and network 10.0.0.0.0/16. The available commands are also limited to READ,LIST,VERSION and SEARCH.

```
<?xml version="1.0" encoding="UTF-8"?>
<restrict>
<remote>
<host>127.0.0.1</host>
<host>localhost</host>
<host>10.0.0.0/16</host>
</remote>
<commands>
<command>read</command>
<command>list</command>
<command>version</command>
<command>search</command>
</commands>
<http>
<method>post</method>
</http>
</restrict>
```

Inclusion of a security policy

To repackage a policy in the WAR file of the Jolokia agent, you must follow these steps  
following steps:

```
# Donwload war agent
$ jolokia
```

Note: You can download it manually from: [http://search.maven.org/remotecontent?filepath=org/jolokia/jolokia-war/1.5.0/jolokiawar-1.5.0.war](http://search.maven.org/remotecontent?filepath=org/jolokia/jolokia-war/1.5.0/jolokiawar-1.5.0.war)

```
# Download the sample policy template
# in the local directory as "jolokia-access.xml".
$ jolokia download --policy
```

Note : If you received errors when executing the previous steps, you can download the sample policy from http://www.jolokia.org/templates/jolokia-access.xml.

Edit the policy and place the jolokia-war-VERSION.war file and the jolokia-access.xml file in the same directory.

```
# Repack the to add the policy file 'jolokia-access.xml' form the cwd
$ jolokia repack --policy jolokia.war
```

You should receive an output similar to the following:

```
$ jolokia repack --policy jolokia-war-1.5.0.war
* Adding policy WEB-INF/classes/jolokia-access.xml to
jolokia-war-1.5.0.war
```

[![image-1626162151046.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162151046.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162151046.png)

You can perform a verification of the contents of the WAR file with the following command:

```
# Show current state (policy file include: yes/no)
$ jolokia jolokia.war
```

**Jolokia on WebSphere**

To install the proxy on IBM Websphere. Perform the following steps:  
Select from the side menu:  
Applications &gt; New Application

[![image-1626162310635.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162310635.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162310635.png)

Select the Jolokia WAR file.

[![image-1626162342696.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162342696.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162342696.png)

Press next .

[![image-1626162379452.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162379452.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162379452.png)

Keep the default options and press next.

[![image-1626162412810.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162412810.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162412810.png)

Modify the name of the application to "jolokia", no further changes are necessary on this screen. Press next.

[![image-1626162445456.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162445456.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162445456.png)

Select the check box to map the new application to the desired server. Click next.

[![image-1626162556452.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162556452.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162556452.png)

Select the check box to map the default virtual host. Click Next.

[![image-1626162605409.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162605409.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162605409.png)

Set the root context of the application to /jolokia.  
Press next.  
Check the summary. Press finish.

[![image-1626162641824.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162641824.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162641824.png)

Verify in the presented log that the application has been installed successfully. If so, press "Save directly to master configuration".

The application is now deployed. We will have to start it to be able to interact with it from the JMX plugin.

Navigate to the list of applications and select "Jolokia".

[![image-1626162679119.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162679119.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162679119.png)

You should receive a message that the application has started successfully:

[![image-1626162757402.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162757402.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162757402.png)

You can validate the installation of Jolokia at the following link:

https://localhost:9443/jolokia

You should receive an output in JSON format with general information about the Jolokia agent.

[![image-1626162796600.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162796600.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162796600.png)

**Jolokia on WebSphere with security enabled**

To use the JMX plugin for data extraction from security-enabled IBM WebSphere environments, it will be necessary to make modifications to the Jolokia application (Jolokia file).  
enabled environments, modifications to the Jolokia application (WAR file) are required.  
WAR FILE).

<span style="text-decoration: underline;">Enable role-specific security mapping</span>

This step adds the information for the role mapping to the jolokia.war file, which we will subsequently  
later deployed on our application server.

[![image-1626162849849.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162849849.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162849849.png)

<span style="text-decoration: underline;">IBM WebSphere Application Server Configuration</span>

You will need to create a user with monitoring permissions. Users and groups &gt; Manage users &gt; Create user

[![image-1626162885353.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162885353.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162885353.png)

And assign it the specific role "Monitor": Users and Groups &gt; Manage User Roles &gt; Add

[![image-1626162914432.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162914432.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162914432.png)

Once the user has been created and the correct role has been assigned, we carry out the mapping in the Jolokia application configuration:  
Applications &gt; Company applications &gt; Jolokia &gt; Security role mapping to user/group.

[![image-1626162946991.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162946991.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162946991.png)

Once the configuration is done, save the changes and restart the Jolokia application.

NOTE : It has been confirmed that in older versions of IBM WebSphere, there is a need to perform the user mapping by adding the ALL group to the mapping with the supervisor role  
mapping of users by adding the ALL group to the mapping with supervisor role:

https://pandorafms.com/guides/public/link/233#bkmrk-los-cambios-a-realiz  
  
The changes to be made are:

Activate "all" and "all authenticated" in the JMX - user mapping in the configuration of  
Jolokia configuration:

[![image-1626162996442.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626162996442.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626162996442.png)

Link the requests of the "All" group in group management:

[![image-1626163024800.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163024800.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163024800.png)

**Jolokia on Weblogic**

<span style="text-decoration: underline;">Previous steps</span>

To ensure full functionality of the JMX plugin in Weblogic, you should check a number of previous configurations. If you decide to skip these steps, monitoring may be limited.

<span style="text-decoration: underline;">Note :</span> If your monitoring needs are limited to application listing, status, number of invocations, resource consumption and general application server status, you can ignore this section.

Access the server configuration screen at:

Base Domain &gt; Environment &gt; Servers

[![image-1626163090059.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163090059.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163090059.png)

Press Lock and Edit to enable editing of the configuration:

[![image-1626163152631.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163152631.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163152631.png)

Click on the server where the Jolokia application will be deployed:

[![image-1626163186857.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163186857.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163186857.png)

Habilite IIOP

[![image-1626163208884.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163208884.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163208884.png)

Press save .  
Select Base Domain from the menu

[![image-1626163249802.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163249802.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163249802.png)

On the Security tab, enable Anonymous Admin Lookup:

[![image-1626163274391.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163274391.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163274391.png)

<span style="text-decoration: underline;">Deployment of Jolokia</span>

Go to the menu section  
Domain structure &gt; Deployments

[![image-1626163307119.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163307119.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163307119.png)

On the screen that appears, select the Install option.

[![image-1626163336700.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163336700.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163336700.png)

Select the upload your file(s) link to display the file upload form:

[![image-1626163369156.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163369156.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163369156.png)

Select the Jolokia WAR file from your computer and press next :

[![image-1626163396252.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163396252.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163396252.png)

The location will be populated with the WAR file upload path. Press next  
to start the installation process.

[![image-1626163426983.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163426983.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163426983.png)

Select the custom role security model and press next .

[![image-1626163454508.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163454508.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163454508.png)

Update the name of the deployment and keep the proposed configuration.  
Press Next .

[![image-1626163483322.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163483322.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163483322.png)

Click Finish .  
At this step, the application is deployed on the JMX application server. In  
the Configuration tab, select the entry point from where the service will be served, by configuring the  
service, configuring the "root context":

[![image-1626163521604.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163521604.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163521604.png)

[![image-1626163528992.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163528992.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163528992.png)

Press save to save your changes.

https://pandorafms.com/guides/public/link/233#bkmrk-presione-activar-cam  
  
Press Activate changes to apply the changes.

[![image-1626163568251.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163568251.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163568251.png)

Once the changes have been applied, the Jolokia application will be displayed ready to be started.  
to be started:

[![image-1626163607191.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163607191.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163607191.png)

Select the checkbox and click start &gt; Start all requests

[![image-1626163639102.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163639102.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163639102.png)

After the start-up process, the application will appear as Active .

[![image-1626163686299.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163686299.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163686299.png)

Edite el rol de seguridad de la aplicación para agregar las condiciones de acceso que desee (permitir grupos, usuarios, etc.)

[![image-1626163707893.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163707893.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163707893.png)

[![image-1626163722260.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163722260.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163722260.png)

You can validate the installation of Jolokia at the following link:

https://localhost:7001/jolokia

You should receive an output in JSON format with general information about the Jolokia agent.

[![image-1626163765493.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163765493.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163765493.png)

**Jolokia in Apache Kafka**

To monitor an Apache Kafka server, the JVM agent Jolokia is required instead of the WAR agent. Just download it from the official website:

https://jolokia.org/download.html

Get the PID of the Apache Kafka server:

[![image-1626163812587.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/scaled-1680-/image-1626163812587.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-07/image-1626163812587.png)

And we relate the JVM agent to the server by means of the server with

```
$ java –jar agente.jar start pid
```

You can validate the installation of Jolokia at the following link:

http://localhost:8778/jolokia/

**JMX4PERL INSTALLATION**

On the computer where you will run the JMX plugin you will need to install the necessary Perl libraries:

```
JMX::Jmx4Perl
JMX::Jmx4Perl::Alias
JMX::Jmx4Perl::Request
```

To install the libraries you need an internet connection and CPAN.

```
# cpan install JMX::Jmx4Perl
```

Although the following applications are extremely useful for exploring the mbean of our application servers, it is possible that they may conflict because of libraries or packages yet to be installed.

```
jmx4perl
check_jmx4perl
j4psh
```

j4psh  
https://pandorafms.com/guides/public/link/233#bkmrk-en-un-entorno-de-pro  
  
In a production environment we recommend ignoring suggestions for additional applications and installing only the JMX::Jmx4Perl library.

Do not respond to all requests to install additional components:

```
Install 'jmx4perl' ? (y/n) [y ]n
Install 'check_jmx4perl' ? (y/n) [y ]n
Install 'cacti_jmx4perl' ? (y/n) [y ]n
Install 'j4psh' ? (y/n) [y ]n
```