Skip to content

Commit

Permalink
wildfly-*: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
markuslf committed Sep 18, 2023
1 parent 1342192 commit cdbe40e
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 232 deletions.
30 changes: 30 additions & 0 deletions PLUGINS-WILDFLY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Notes on all wildfly Plugins
============================

Authentication
--------------

To create a monitoring user, do this:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
25 changes: 2 additions & 23 deletions check-plugins/wildfly-deployment-status/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,9 @@ This check plugin monitors the deployment status of a WildFly server, using its

Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down
27 changes: 3 additions & 24 deletions check-plugins/wildfly-gc-status/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,11 @@ Overview

This check plugin prints the garbage collector of a WildFly server, using its HTTP-JSON based API (JBossAS REST Management API). This allows us to monitor the application server without any additional configuration and installation - no need to deploy WAR-Agents like Jolokia. The plugin supports both standalone mode and domain mode.

Tested with WildFly 11 and WildFly 23.
Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down
30 changes: 4 additions & 26 deletions check-plugins/wildfly-memory-pool-usage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ This check plugin monitors the memory pool usage of a WildFly server, using its

Tested with WildFly 11 and WildFly 23+.

`How is the java memory pool divided? <https://stackoverflow.com/questions/1262328/how-is-the-java-memory-pool-divided>`_
Hints:

* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_
* `How is the java memory pool divided? <https://stackoverflow.com/questions/1262328/how-is-the-java-memory-pool-divided>`_

**Heap memory** is the runtime data area from which the Java VM allocates memory for all class instances and arrays. The heap may be of a fixed or variable size. The garbage collector is an automatic memory management system that reclaims heap memory for objects.

Expand All @@ -23,31 +26,6 @@ Tested with WildFly 11 and WildFly 23+.
* Compressed Class Space
* Metaspace

To create a monitoring user, do this:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no

Fact Sheet
----------
Expand Down
27 changes: 3 additions & 24 deletions check-plugins/wildfly-memory-usage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,11 @@ Overview

This check plugin monitors the heap and non-heap memory usage of a WildFly server, using its HTTP-JSON based API (JBossAS REST Management API). This allows us to monitor the application server without any additional configuration and installation - no need to deploy WAR-Agents like Jolokia. The plugin supports both standalone mode and domain mode.

Tested with WildFly 11 and WildFly 23.
Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down
39 changes: 8 additions & 31 deletions check-plugins/wildfly-non-xa-datasource-stats/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,16 @@ This check plugin returns metrics of Non-XA datasources of a WildFly server, usi

Tested with WildFly 11 and WildFly 23+.

The check recognizes if a datasource does not support statistics.
Hints:

To create a monitoring user, do this:
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_
* The check recognizes if a datasource does not support statistics.
* To enable database statistics:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
To enable database statistics:

* Open the WildFly Admin Console
* Go to Configuration > Subsystems > Datasources & Drivers > Datasources
* Select your datasource
* Click on View > Tab Attributes > Edit "Statistics Enabled"
* Open the WildFly Admin Console
* Go to Configuration > Subsystems > Datasources & Drivers > Datasources
* Select your datasource
* Click on View > Tab Attributes > Edit "Statistics Enabled"


Fact Sheet
Expand Down
27 changes: 3 additions & 24 deletions check-plugins/wildfly-server-status/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,11 @@ Overview

This check plugin monitors a WildFly server, using its HTTP-JSON based API (JBossAS REST Management API). This allows us to monitor the application server without any additional configuration and installation - no need to deploy WAR-Agents like Jolokia. The plugin supports both standalone mode and domain mode.

Tested with WildFly 11 and WildFly 23.
Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down
27 changes: 3 additions & 24 deletions check-plugins/wildfly-thread-usage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,11 @@ Overview

This check plugin monitors the thread statistics of a WildFly server, using its HTTP-JSON based API (JBossAS REST Management API). This allows us to monitor the application server without any additional configuration and installation - no need to deploy WAR-Agents like Jolokia. The plugin supports both standalone mode and domain mode.

Tested with WildFly 11 and WildFly 23.
Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down
28 changes: 3 additions & 25 deletions check-plugins/wildfly-uptime/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,11 @@ Overview

This check plugin monitors the uptime of a WildFly server, using its HTTP-JSON based API (JBossAS REST Management API). This allows us to monitor the application server without any additional configuration and installation - no need to deploy WAR-Agents like Jolokia. The plugin supports both standalone mode and domain mode.

Tested with WildFly 11 and WildFly 23.
Tested with WildFly 11 and WildFly 23+.

To create a monitoring user, do this:
Hints:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_


Fact Sheet
Expand Down Expand Up @@ -76,7 +55,6 @@ Help
--warning WARN Set the warning threshold.
Usage Examples
--------------

Expand Down
39 changes: 8 additions & 31 deletions check-plugins/wildfly-xa-datasource-stats/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,39 +8,16 @@ This check plugin returns metrics of XA datasources of a WildFly server, using i

Tested with WildFly 11 and WildFly 23+.

The check recognizes if a datasource does not support statistics.
Hints:

To create a monitoring user, do this:
* See `additional notes for all wildfly monitoring plugins <https://github.com/Linuxfabrik/monitoring-plugins/blob/main/PLUGINS-WILDFLY.rst>`_
* The check recognizes if a datasource does not support statistics.
* To enable database statistics:

.. code-block:: bash
/opt/wildfly/bin/add-user.sh
.. code-block:: text
What type of user do you wish to add?
a) Management User (mgmt-users.properties)
b) Application User (application-users.properties)
(a): a
Enter the details of the new user to add.
Using realm 'ManagementRealm' as discovered from the existing property files.
Username : wildfly-monitoring
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[ ]:
About to add user 'wildfly-monitoring' for realm 'ManagementRealm'
Is this correct yes/no? yes
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server Jakarta Enterprise Beans calls.
yes/no? no
To enable database statistics:

* Open the WildFly Admin Console
* Go to Configuration > Subsystems > Datasources & Drivers > Datasources
* Select your datasource
* Click on View > Tab Attributes > Edit "Statistics Enabled"
* Open the WildFly Admin Console
* Go to Configuration > Subsystems > Datasources & Drivers > Datasources
* Select your datasource
* Click on View > Tab Attributes > Edit "Statistics Enabled"


Fact Sheet
Expand Down

0 comments on commit cdbe40e

Please sign in to comment.