How can I test to see if a Plugin Server is running and responsive?

This knowledge article may contain information that does not apply to version 21.05 or later which runs in a container environment. Please refer to Article Number 000385088 for more information about troubleshooting BMC products in containers.

The "AR System Plugin Server Test Program"   can be used to test the connection directly to a plugin server.
Download the attached PluginserverLiveTestSuite.zip, which contains the readme file and a zipped file with the utility.
Extract PluginserverLiveTestSuite.zip into a local directory.


This utility verifies that a plugin server running on the given host and port number is up and running.
It simply checks to see if the plugin server is processing RPC calls. It does not check if the plugins themselves are working.
This utility creates an RPC TCP client connection to the given plugin server and triggers a simple inexpensive call ArEsSignal. 
It is a no-op for plugin server. If no error it means the plugin server is up and running and accepting RPC calls.
If there is an exception, it means that the clients can’t talk to the plugin server or the plugin server is too busy to
process RPC calls.

=======
INSTALL
=======

1.  Extract all of the files from this distribution (pluginserverlivetest.zip) into your file system, for example:
   "C:\RemedyUtilities\pluginserverlivetest"
  Let's call your install directory "<YourInstallDir>"

2. Ensure that <YourInstallDir> includes the following files.

• log4j.xml
• pluginserverlivetest.jar
• PluginserverLiveTest.bat
• pluginserverlivetest.sh

     And the subdirectory pluginserverlivetest_lib includes the following files:

• arapi81_build001.jar
• arapi88_build001.jar
• arapiext88_build001.jar
• arcmnapp88_build001.jar
• arutil88_build001.jar
• log4j-1.2.14.jar

  
3.  From <YourInstallDir>, locate "pluginserverlivetest.bat" file and update the 'JavaPath', 'server_name', 'plugin_server_port', and 'timeout' according to your configuration.
  The default primary plugin server  port is 9999 (see ar.cfg and pluginsvr_config.xml  or the Centralized Configuration).
  You can edit the batch file to run against multiple plugin servers. You can also run this from Windows to connect to a Unix plugin server.
    
Here is an example batch file:
 

rem ===================================================================== rem This batch file assumes it is being run from the same directory rem where below files/dir located rem pluginserverlivetest.jar rem pluginserverlivetest_lib rem ===================================================================== rem java -jar pluginserverlivetest.jar [server_name] [plugin_server_port] [timeout] rem [server_name] -- host where the pluginsr is running rem [plugin_server_port] -- from pluginsvr_config.xml file "<port>xxxx</port>" rem [timeout] -- unit is seconds, min is 5 seconds, max is 120 seconds. Any value set outside of the range will be set to 60 seconds. set JavaPath=C:\Program Files\Java\jre8\bin "%JavaPath%\java" -jar pluginserverlivetest.jar remedyprod 9999 60

==========
HOW TO USE
==========

 * On Windows system
      run pluginserverlivetest.bat batch file from <YourInstallDir>
      

 * Unix system
      run ./pluginserverlivetest.sh script file from <YourInstallDir>
    
      

 * Output when pluginsvr is up running:

      The server with the given name at the given port is up and running remedyprod:9999


================
TROUBLESHOOTING
================

 * If you see "java.lang.ArrayIndexOutOfBoundsException" it means not all 3 required program arguments were provided.
   Please see INSTALL section above.

 * Below error means plugin server with the port is not running or you did not provide correct server_name or plugin port.
 

Error communicating with the given plugin server remedyprod:9999 Connection refused: connect java.net.ConnectException: Connection refused: connect at java.net.DualStackPlainSocketImpl.connect0(Native Method) at java.net.DualStackPlainSocketImpl.socketConnect(Unknown Source) at java.net.AbstractPlainSocketImpl.doConnect(Unknown Source) at java.net.AbstractPlainSocketImpl.connectToAddress(Unknown Source) at java.net.AbstractPlainSocketImpl.connect(Unknown Source) at java.net.PlainSocketImpl.connect(Unknown Source) at java.net.SocksSocketImpl.connect(Unknown Source) at java.net.Socket.connect(Unknown Source) at java.net.Socket.connect(Unknown Source) at java.net.Socket.<init>(Unknown Source) at java.net.Socket.<init>(Unknown Source) at org.acplt.oncrpc.OncRpcTcpSocketHelper$Connectiator.run(OncRpcTcpSocketHelper.java:235)