Fortinet black logo

User Guide

Tomcat (Legacy)

24.2.0
Copy Link
Copy Doc ID af1daa65-c273-11ec-9fd1-fa163e15d75b:648358
Download PDF

Tomcat (Legacy)

The Tomcat plugin lets you monitor a number of metrics on your web server. If you can not find this plugin in the /usr/lib/fm-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

Agent Configuration

Once the agent is installed, you will need to add the following information to the agent config file (/etc/fm-agent/fm_agent.cfg):

[tomcat]

username = <USERNAME>

password = <PASSWORD>

console_url = http://<IP>:<PORT>

The console_url is the URL that you use to access your Tomcat web server. Replace <IP> with your server’s IP address, and <PORT> with the port tomcat is listening to (this will be 8080 by default).

If you do not know the username and password required to sign in to your Tomcat URL, then you can find them in the conf/tomcat-users.xml file. The user you choose must be of the manager-gui role.

Control Panel Configuration

To use the Tomcat plugin, first select “Tomcat” from the monitoring catalog.

There are a number of metrics available to monitor.

Metric

Unit

Action/Classloadingtime

Action/Errorcount

Action/Loadtime

Action/Maxtime

Action/Processingtime

Action/Requestcount

Average total memory

seconds

Count of errors

errors

Count of expired sessions

sessions

Count of requests

requests

Current count of busy threads

threads

Current count of threads

threads

Default/Classloadingtime

Default/Errorcount

Default/Loadtime

Default/Maxtime

Default/Processingtime

Default/Requestcount

DynamicJAXWSServlet/Classloadingtime

DynamicJAXWSServlet/Errorcount

DynamicJAXWSServlet/Loadtime

DynamicJAXWSServlet/Maxtime

DynamicJAXWSServlet/Processingtime

DynamicJAXWSServlet/Requestcount

GC/Classloadingtime

GC/Errorcount

GC/Loadtime

GC/Maxtime

GC/Processingtime

GC/Requestcount

HTMLManager/Classloadingtime

HTMLManager/Errorcount

HTMLManager/Loadtime

HTMLManager/Maxtime

HTMLManager/Processingtime

HTMLManager/Requestcount

J4p-agent/Classloadingtime

J4p-agent/Errorcount

J4p-agent/Loadtime

J4p-agent/Maxtime

J4p-agent/Processingtime

J4p-agent/Requestcount

JMXProxy/Classloadingtime

JMXProxy/Errorcount

JMXProxy/Loadtime

MXProxy/Maxtime

JMXProxy/Processingtime

JMXProxy/Requestcount

Jsp/Classloadingtime

Jsp/Errorcount

Jsp/Loadtime

Jsp/Maxtime

Jsp/Processingtime

Jsp/Requestcount

JVM maximum memory

megabytes

JVM total memory

megabytes

Longest sessions alive time

seconds

Manager/Classloadingtime

Manager/Errorcount

Manager/Loadtime

Manager/Maxtime

Manager/Processingtime

Manager/Requestcount

Maximum number of active sessions

sessions

Maximum number of threads

threads

Maximum processing time

milliseconds

Mem/Classloadingtime

Mem/Errorcount

Mem/Loadtime

Mem/Maxtime

Mem/Processingtime

Mem/Requestcount

Memory used

MB

Number of loaded JSPs

JSPs

Number of reloaded JSPs

JSPs

Params/Classloadingtime

Params/Errorcount

Params/Loadtime

Params/Maxtime

Params/Processingtime

Params/Requestcount

Rejected sessions creations

sessions

RSDispatcher/Classloadingtime

RSDispatcher/Errorcount

RSDispatcher/Loadtime

RSDispatcher/Maxtime

RSDispatcher/Processingtime

RSDispatcher/Requestcount

ShutdownRestart/Classloadingtime

ShutdownRestart/Errorcount

ShutdownRestart/Loadtime

ShutdownRestart/Maxtime

ShutdownRestart/Processingtime

ShutdownRestart/Requestcount

Status/Classloadingtime

Status/Errorcount

Status/Loadtime

Status/Maxtime

Status/Processingtime

Status/Requestcount

Time to start up

milliseconds

Total active sessions

sessions

Total bytes received

bytes

Total bytes sent

bytes

Total number of active sessions since startup

Total number of rejected sessions since startup

Total number of requests served since startup

Total processing time

seconds

Total processing time (in milliseconds) since startup

Total sessions count

sessions

Total/Averagesessionalivetime

Total/Bytesreceived

Total/Bytessent

Total/Currentthreadbusy

Total/Currentthreadcount

Total/Errorcount

Total/Expiredsessions

Total/Freememory

Total/JSPsloaded

Total/JSPsreloaded

Total/Longestsessionalivetime

Total/Maxactivesessions

Total/Maxmemory

Total/Maxprocessingtime

Total/Maxthreads

Total/Requestcount

Total/Totalmemory

WSServlet/Classloadingtime

WSServlet/Errorcount

WSServlet/Loadtime

WSServlet/Maxtime

WSServlet/Processingtime

WSServlet/Requestcount

If you would like to inspect the Tomcat plugin in more detail you can find the python script for it in the /usr/lib/fm-agent/plugins folder.

Tomcat (Legacy)

The Tomcat plugin lets you monitor a number of metrics on your web server. If you can not find this plugin in the /usr/lib/fm-agent/plugins folder, then your version of the Agent is out of date and you should update it to gain access to this feature.

Agent Configuration

Once the agent is installed, you will need to add the following information to the agent config file (/etc/fm-agent/fm_agent.cfg):

[tomcat]

username = <USERNAME>

password = <PASSWORD>

console_url = http://<IP>:<PORT>

The console_url is the URL that you use to access your Tomcat web server. Replace <IP> with your server’s IP address, and <PORT> with the port tomcat is listening to (this will be 8080 by default).

If you do not know the username and password required to sign in to your Tomcat URL, then you can find them in the conf/tomcat-users.xml file. The user you choose must be of the manager-gui role.

Control Panel Configuration

To use the Tomcat plugin, first select “Tomcat” from the monitoring catalog.

There are a number of metrics available to monitor.

Metric

Unit

Action/Classloadingtime

Action/Errorcount

Action/Loadtime

Action/Maxtime

Action/Processingtime

Action/Requestcount

Average total memory

seconds

Count of errors

errors

Count of expired sessions

sessions

Count of requests

requests

Current count of busy threads

threads

Current count of threads

threads

Default/Classloadingtime

Default/Errorcount

Default/Loadtime

Default/Maxtime

Default/Processingtime

Default/Requestcount

DynamicJAXWSServlet/Classloadingtime

DynamicJAXWSServlet/Errorcount

DynamicJAXWSServlet/Loadtime

DynamicJAXWSServlet/Maxtime

DynamicJAXWSServlet/Processingtime

DynamicJAXWSServlet/Requestcount

GC/Classloadingtime

GC/Errorcount

GC/Loadtime

GC/Maxtime

GC/Processingtime

GC/Requestcount

HTMLManager/Classloadingtime

HTMLManager/Errorcount

HTMLManager/Loadtime

HTMLManager/Maxtime

HTMLManager/Processingtime

HTMLManager/Requestcount

J4p-agent/Classloadingtime

J4p-agent/Errorcount

J4p-agent/Loadtime

J4p-agent/Maxtime

J4p-agent/Processingtime

J4p-agent/Requestcount

JMXProxy/Classloadingtime

JMXProxy/Errorcount

JMXProxy/Loadtime

MXProxy/Maxtime

JMXProxy/Processingtime

JMXProxy/Requestcount

Jsp/Classloadingtime

Jsp/Errorcount

Jsp/Loadtime

Jsp/Maxtime

Jsp/Processingtime

Jsp/Requestcount

JVM maximum memory

megabytes

JVM total memory

megabytes

Longest sessions alive time

seconds

Manager/Classloadingtime

Manager/Errorcount

Manager/Loadtime

Manager/Maxtime

Manager/Processingtime

Manager/Requestcount

Maximum number of active sessions

sessions

Maximum number of threads

threads

Maximum processing time

milliseconds

Mem/Classloadingtime

Mem/Errorcount

Mem/Loadtime

Mem/Maxtime

Mem/Processingtime

Mem/Requestcount

Memory used

MB

Number of loaded JSPs

JSPs

Number of reloaded JSPs

JSPs

Params/Classloadingtime

Params/Errorcount

Params/Loadtime

Params/Maxtime

Params/Processingtime

Params/Requestcount

Rejected sessions creations

sessions

RSDispatcher/Classloadingtime

RSDispatcher/Errorcount

RSDispatcher/Loadtime

RSDispatcher/Maxtime

RSDispatcher/Processingtime

RSDispatcher/Requestcount

ShutdownRestart/Classloadingtime

ShutdownRestart/Errorcount

ShutdownRestart/Loadtime

ShutdownRestart/Maxtime

ShutdownRestart/Processingtime

ShutdownRestart/Requestcount

Status/Classloadingtime

Status/Errorcount

Status/Loadtime

Status/Maxtime

Status/Processingtime

Status/Requestcount

Time to start up

milliseconds

Total active sessions

sessions

Total bytes received

bytes

Total bytes sent

bytes

Total number of active sessions since startup

Total number of rejected sessions since startup

Total number of requests served since startup

Total processing time

seconds

Total processing time (in milliseconds) since startup

Total sessions count

sessions

Total/Averagesessionalivetime

Total/Bytesreceived

Total/Bytessent

Total/Currentthreadbusy

Total/Currentthreadcount

Total/Errorcount

Total/Expiredsessions

Total/Freememory

Total/JSPsloaded

Total/JSPsreloaded

Total/Longestsessionalivetime

Total/Maxactivesessions

Total/Maxmemory

Total/Maxprocessingtime

Total/Maxthreads

Total/Requestcount

Total/Totalmemory

WSServlet/Classloadingtime

WSServlet/Errorcount

WSServlet/Loadtime

WSServlet/Maxtime

WSServlet/Processingtime

WSServlet/Requestcount

If you would like to inspect the Tomcat plugin in more detail you can find the python script for it in the /usr/lib/fm-agent/plugins folder.