Configure Agent Client Collector Apache Tomcat monitoring

task brazil Updated Sep 10, 2026 1 min read acc-apache-tomcat-monitoring.md
Raw file servicenow.com

To configure the Agent Client Collector to perform Apache Tomcat monitoring, set the following configurations in the Apache Tomcat application.

Before you begin

Role required: agent_client_collector_admin

Procedure

  1. Open a management JMX port when starting the server:

    1. In a Linux environment:

      1. In bin directory in the Tomcat home directory, create a setenv.sh file.

      2. Ensure that the file contains the following:

        Shell
        export CATALINA_OPTS=$CATALINA_OPTS"-Dcom.sun.management.jmxremote=true-Dcom.sun.management.jmxremote.port={PORT NUMBER}-Dcom.sun.management.jmxremote.rmi.port={PORT NUMBER}-Dcom.sun.management.jmxremote.ssl=false-Dcom.sun.management.jmxremote.authenticate=false-Djava.rmi.server.hostname=127.0.0.1"
      3. Run chmod 755 setenv.sh to give the setenv.sh file executable permissions.

    2. In a Windows environment:

      1. In bin directory in the Tomcat home directory, create a setenv.bat file.

      2. Ensure that the file contains the following:

        Shell
        @echo=offif defined CATALINA_OPTS (set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote=true) else (set CATALINA_OPTS=-Dcom.sun.management.jmxremote=true)set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.port={PORT NUMBER}set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.rmi.port={PORT NUMBER}set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.authenticate=falseset CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.ssl=falseset CATALINA_OPTS=%CATALINA_OPTS% -Djava.rmi.server.hostname=127.0.0.1

        {PORT NUMBER} represents the number of the port you open for JMX RMI monitoring. The default value created by the check definition is 9000.

  2. Restart Tomcat.

    1. In a Linux environment: Run the shutdown.sh script, followed by the startup.sh script.

    2. In a Windows environment: Run the shutdown.bat script, followed by the startup.bat script.

Search documentation
Search document titles and file paths on the brazil branch