Monitor Tomcat services on Windows

This information is primarily for administrators and/or people who manage Zylinc solutions

Tomcat is a Java-based web server. Several of the software modules in a Zylinc solution use Tomcat, so those modules require Java and an instance of Tomcat to be able to run.

You can use the Zylinc Deployment Manager (that comes with the Zylinc solution) to create as many instances of Tomcat services as you need. Typically, you’ll have two instances.

Each instance can use arbitrary versions of Tomcat as well as Java. Several instances can co-exist, as long as you use distinct names and distinct network ports. You can also use Deployment Manager to install any of our Tomcat-based software modules on any of the Tomcat instances that you've created.

You should monitor some network ports that the Zylinc solution's Tomcat instances use.

Generally, each Tomcat instance listens on three or four ports, depending on whether you've enabled support for HTTPS or not.

If you use the port numbers that the installation guide for a typical Zylinc solution recommends, you'll want to monitor the following ports:

Tomcat instance 1 ports to monitor

  • Tcp/8005 (localhost only)

  • Tcp/8009

  • Tcp/8080

  • Tcp/8443

Tomcat instance 2 ports to monitor

  • Tcp/8006 (localhost only)

  • Tcp/8010

  • Tcp/8081

If you run the port monitoring agent from another host on the network, you can’t monitor the ports marked with (localhost only). In that case, you won't be able to monitor ports 8005 and 8006.

When you create Tomcat instances in Deployment Manager, a Windows service is created for each instance. The Tomcat Windows services will be given the name ZyMT_ApacheTomcat_x64_<version>_ followed by the name that you've entered for the instance.

For all Tomcat instances that you use, you should monitor that those Windows services are running.

If you use the instance names that we recommend in the installation guide for a typical Zylinc solution, you'll want to monitor the services that have the following names:

Tomcat instance 1 service name

  • ZyMT_ApacheTomcat_x64_8.0.42.0_ZyTomcat1-8080-8443

Tomcat instance 2 service name

  • ZyMT_ApacheTomcat_x64_8.0.42.0_ZyTomcat2-8081

Note that version number 8.0.42.0 is an example. The version number may be different on your installation.

Tomcat process names

The process name for all Tomcat instances is tomcat8.exe. To identify a process that belongs to a specific instance, you can use the PID for the running service and compare it to the PID of the tomcat8.exe processes.

You can monitor that some of our Tomcat-based software modules listen on their configured network ports. If more than one port exists, both ports should respond.

The following Tomcat modules use a specific network port that you should monitor, if you use the modules in your organization:

Client Manager

  • Tcp/35033

  • Tcp/35034

Messaging Portal

  • Tcp/35028 (optional module)

Zylinc Proxy

  • Tcp/35031 (optional module)

Zylinc Proxy Client

  • Tcp/35032 (optional module)

The rest of the Tomcat modules don't listen to a specific port. You can use active checks, as described in the following, to monitor them.

Active checks is a feature that's useful when you need to monitor that a web service located at a specific URL is responsive. The feature works in a way similar to the well-known wget command, and is available in many third-party monitoring tools, for example under the name check_http.

You can use active checks to validate that all your individual Tomcat modules are reachable and responsive.

If you use the instance names that we recommend in the installation guide for a typical Zylinc solution, the following table contains the information that you need to set up active checks in order to monitor all the Tomcat modules.

You should monitor all the modules that are marked as mandatory. Optional modules must be monitored if they're installed on your system.

The base URL for each tomcat instance is http://<server>:<port>/

Tomcat module name Server Port URL to get Expected result Mandatory
Admin Portal (zylinc-admin) Media 8080 /zylinc-admin 200 OK ×
Authentication Server App 8080 /Authentication 200 OK ×
ClientManager App 8080 /ClientManager 200 OK ×
Stat Portal App 8081 /StatisticsPortal 200 OK ×
ZyCore ID App 8080 /ZyCoreID 401 Unauthorized ×
ZyDataService App 8081 /ZyDataService 200 OK ×
Cisco Directory Sync. App 8080 /CiscoDirSync 401 Unauthorized  
Cisco User Proxy App 8080 /CiscoUserProxy 401 Unauthorized  
Lync Web Chat App 8080 /LyncWebChat 200 OK  
Messaging Portal App 8080 /MessagingPortal 200 OK  
Sametime Presence v2 App 8080 /SametimePresence 401 Unauthorized  
Zylinc Proxy App 8080 /ZylincProxy 200 OK  
Zylinc Proxy Client App 8080 /ZylincProxyClient 200 OK  
Zyte App 8080 /Zyte 200 OK  

Some examples of complete URLs to check:

  • http://<windows application server>:8080/ClientManager/

  • http://<windows application server>:8081/StatisticsPortal/

  • http://<MediaServer>:8080/zylinc-admin/