This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

armonitor

The Java based armonitor starts the BMC Remedy AR System server, BMC Remedy AR System plug-in server, Distributed Server Option (DSO) server, and processes specified in the armonitor.conf (armonitor.cfg) file. The armonitor provides capability to:

  • stop a process
  • start a process that was stopped earlier by using the stop signal or that failed to start
  • restart a process
  • monitor the armonitor.conf file for changes made to individual processes

On Windows, armonitor automatically runs as a service called BMC Remedy Action Request System Server.

On UNIX, the arsystem script usually controls armonitor. For more information, see arsystem.

Note

Each file name is listed by its UNIX name. If a Windows equivalent exists, it appears in parentheses after the UNIX name.

If a process terminates, armonitor restarts the process. But if the process terminates for more than four times in 30 seconds, armonitor does not restart that process. The following exception might occur when the AR System server ports are not free and the armonitor tries to start the AR System server:
Some of the ports on this machine are not free. Make sure all the ports required for running server as per documentation are available.

You must perform the following steps to free the ports for Microsoft Windows:

  1. Open Task Manager > Process tab.
  2. Click View > Select Column.
  3. Select the PID (Process Identifier) checkbox and Image Name in the Select Process Page column. 
    The Image Name helps in identifying the processes that points to a particular process under the AR Installation directory.
  4. Identify all the processes related to the AR System server. 
  5. End these processes.
  6. Restart the AR System server when the processes are not displayed in the task list.

The armonitor process maintains the following lists for the processes specified in the armonitor.conf (armonitor.cfg) file.

ListDescription
STARTED_PROCESSES_LISTLists the processes that are currently running
FAILED_TO_START_PROCESSES_LISTLists the processes which fail to start successfully
STOPPED_PROCESSES_LISTLists the processes stopped by the user by using the stopprocess <processname> (For more information see, armonitor.conf or armonitor.cfg).

Starting from BMC Remedy AR System 9.1, following enhancements are provided to armonitor file:

ARMonitor.properties file

The ARMonitor.properties file consists of following properties to manage the BMC Remedy AR System processes:

ARMonitor propertiesDescription
com.bmc.arsys.armonitor.RMIPort

The RMI Port is used by the ARMonitor_Admin to give instructions to armonitor. The property is configured by the ARMonitor.properties file, when the process is started or restarted.

com.bmc.arsys.armonitor.filewatchenabled

Allows the armonitor process to detect the changes made to the armonitor.conf (armonitor.cfg) file without affecting other BMC Remedy AR System processes.

Default value: False

This property can be set to true or false through the ARMonitor_Admin functions - enablefilemonitor & disablefilemonitor

com.bmc.arsys.armonitor.filewatchretrylimitDetermines the maximum number of attempts that are made to enable the file-monitor
com.bmc.arsys.armonitor.server.logintimeoutinseconds

Timeout value in seconds, for which armonitor will wait for receiving the startup signal from server.

If no signal received from server during this time, the server will not be considered as started and the server process, if running, will be stopped.

com.bmc.arsys.armonitor.server.startupretrylimitDetermines the maximum number of attempts until a server is started before terminating the process.
com.bmc.arsys.armonitor.process.startupretrylimitDetermines the maximum number of attempts until a non-server process is started before terminating the process.

ARMonitor_Admin.sh or ARMonitor_Admin.bat

The ARMonitor_Admin.sh (ARMonitor_Admin.bat) is an interface to communicate with the armonitor file using the arguments provided below.

Note

Before you use the ARMonitor_Admin.sh (ARMonitor_Admin.bat) file, ensure that the value of JAVA_HOME is set correctly.

The examples are provided for Microsoft Windows. From Windows Command Prompt, change to the AR System installation directory and enter the following commands:

ArgumentsDescription
isalive

Checks if the armonitor.conf (armonitor.cfg) file is running

For example:

Command:

ARMonitor_Admin.bat isalive

Output:

ARMonitor is running
stoparmonitor

Stops all the processes specified in the armonitor.conf (armonitor.cfg) file and stops armonitor process.

For example:

Command:

ARMonitor_Admin.bat stoparmonitor

Output:

Sending ARMonitor stop signal...
ARMonitor Stop signal sent!!
getstartedprocesses

Lists all processes that are currently running

For example:

Command:

ARMonitor_Admin.bat getstartedprocesses

Output:

Requesting list of started processes :
Process running on server are :
ARSERVER,Process_1,Process_2,Process_3,Process_4,]


allprocessesstatus

Lists all processes sorted according to whether the process is successfully started, whether it failed to start, or whether the user has stopped the process with ARMONITOR_ADMIN calls

For example:

Command:

ARMonitor_Admin.bat allprocessesstatus

Output:

Requesting status for all processes :
Processes status on server are : [ Started-Processes ->
ARSERVER,Process_1,Process_2,Process_3,Process_4, ]
[ Failed-To-Start Processes ->  ]
[ Stopped Processes ->  ]


stopprocess <processname>

Stops the specific process if the process is currently running

For example:

Command:

ARMonitor_Admin.bat stopprocess Process_4

Output:

Sending stop process signal for process [ Process_4 ]...
Stop signal for process [ Process_4 ] sent!!


startprocess <processname>

Starts a process if the process is not currently running

For example:

Command:

ARMonitor_Admin.bat startprocess Process_4

Output:

Sending start process signal for process [ Process_4 ]...
Start signal for process [ Process_4 ] sent!!


restartprocess <processname>

Restarts a process using the process name assigned to the process

For example:

Command:

ARMonitor_Admin.bat restartprocess Process_4

Output:

Sending restart process signal for process [ Process_4 ]...
Restart signal for process [ Process_4 ] sent!!


refreshprocess <processname>

Refreshes the process with a new process definition read from the armonitor.conf (armonitor.cfg) file. 

Note: The refershprocess command is not applicable for ARSERVER processes.

For example:

Command:

ARMonitor_Admin.bat refreshprocess Process_4

Output:

Sending refresh process signal for process [ Process_4 ]...
Refresh signal for process [ Process_4 ] sent!!


getprocesscommand <processname>

Provides the process command assigned to the process.

For example:

Command:

ARMonitor_Admin.bat getprocesscommand Process_4

Output:

Requesting execution-command for process [ Process_4 ]...
Execution-command for process [ Process_4 ] is [
"C:\Program Files\BMC Software\ARSystem\arplugin.exe"  -i
"C:\Program Files\BMC Software\ARSystem" -m ].


allprocessesdetails

Provides the process details for all the processes specified in the armonitor.conf (armonitor.cfg) file

For example:

Command:

ARMonitor_Admin.bat allprocessesdetails

Output:

Requesting all processes Name-Command mapping...
Details for All Processes processed by armonitor:
Process Name:
[ARSERVER]        Command:
"<Java path>" -jar "C:\Program
Files\BMC Software\ARSystem\arserver.jar"  -I "C:\Program
Files\BMC Software\ARSystem" -l "C:\Program Files\Common Files\AR
System\Licenses\<servername>" -m
Process Name:
[Process_1]       Command: "C:\Program
Files\BMC Software\ARSystem\arsvcdsp.exe"  -d "C:\Program
Files\BMC Software\ARSystem" -m

Process Name:
[Process_4]       Command: "C:\Program
Files\BMC Software\ARSystem\arplugin.exe"  -i "C:\Program
Files\BMC Software\ARSystem" -m

isfilemonitorenabled

Returns TRUE or FALSE based on whether the FILE_MONITOR option is enabled or disabled

For example:

Command:

ARMonitor_Admin.bat isfilemonitorenabled

Output:

Requesting File Monitor state...
File Monitor is : DISABLED


enablefilemonitor

Enables the FILE_MONITOR feature for armonitor and also updates the com.bmc.arsys.armonitor.filewatchenabled property in the ARMonitor.properties file to True.

For example:

Command:

ARMonitor_Admin.bat enablefilemonitor

Output:

Sending Enable File Monitor Signal...
File Monitor Enabled Succesfully !!


disablefilemonitor

Disables the FILE_MONITOR feature for armonitor and also updates the com.bmc.arsys.armonitor.filewatchenabled property in the ARMonitor.properties file to False.

For example:

Command:

ARMonitor_Admin.bat disablefilemonitor

Output:

Sending Disable File Monitor Signal...
File Monitor Disabled Successfully !!


Important

If you add a new parameter to an already running process, the armonitor considers this as a new process and starts the process again. This creates two instances of the same process running in armonitor which results in to an error. Ensure that you stop the running process by using stopprocess argument before editing the process.

File Monitor

Starting from BMC Remedy AR System 9.1 a new FILE_MONITOR feature is added to armonitor to monitor the armonitor.conf (armonitor.cfg) file for changes. The enablefilemonitor and disablefilemonitor arguments are used to enable or disable the FILE_MONITOR feature.

The FILE_MONITOR provides following features when you modify the armonitor.conf (armonitor.cfg) file:

  • If a new process is modified, the process is started automatically without affecting other processes running in the armonitor.conf (armonitor.cfg) file.
  • If any numeric parameters of a process are modified, the same process is restarted by the armonitor with the new parameter values.

Note

The armonitor.cgf file has the following new entries:

  • External-Windows-Service: process-type = BMC:EmailEngine, service-name="BMC Remedy Email Engine - 1"
  • External-Windows-Service: process-type = BMC:FlashBoardServer, service-name="BMC Remedy Flashboards Server -

These entries are used to start and stop the Flashboard and Email engine services when you apply a patch that is provided as a binary payload.

Related topic

armonitor.conf or armonitor.cfg

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. John Adams

    You say "If a process terminates, armonitor restarts the server. If the server terminates for more than four times in 30 seconds, armonitor does not restart that process."

     

    Is this true - do you mean "If a process terminates, armonitor restarts the process. If the process terminates  more than four times in 30 seconds, armonitor does not restart that process." ?

    Mar 02, 2016 09:53
    1. Prachi Kalyani

      Thank you, John.

      I have corrected the topic.

      Regards,

      Prachi

      Mar 03, 2016 05:11
  2. Mark Walters

    Good spot John - it should say  "If a process terminates, armonitor restarts the process." and not "If a process terminates, armonitor restarts the server." Only the failed process is restarted - the current text suggests the AR server will be restarted and this is not the case unless of course it was the failed process!



    Mar 03, 2016 05:02
    1. Prachi Kalyani

      Hello Mark,

      I have updated the topic.

      Thanks,

      Prachi

      Mar 03, 2016 05:12
  3. Martin Vollset

    How do you name the processes in the armonitor.cfg. It would be nice to show something more specific than Process_N?

    Oct 14, 2016 06:05
    1. Prachi Kalyani

      Hello Martin,

      The processes are named sequentially according to the order they appear in armonitor.conf (armonitor.cfg) file. 

      Thanks,

      Prachi

      Oct 18, 2016 06:42
  4. Colin Rolls

    when I try running ARMonitor_Admin on windows I get the following message "JAVA_HOME env variable is not defined. GOTO END"  , so it appears JAVA_HOME needs setting for this to run, no mention of this anywhere in the documentation so I suggest it is added.

    Nov 16, 2016 04:50
    1. Prachi Kalyani

      Hello Colin,

      Thank you for your inputs. I will work on getting this topic updated.

      Thanks,

      Prachi

      Nov 16, 2016 05:02
    1. Prachi Kalyani

      Hello Colin,

      I have updated the topic.

      Thanks,

      Prachi

      Nov 23, 2016 05:26
  5. Colin Rolls

    some examples would be good, eg: run ARMonitor_Admin getstartedprocesses , returned results ARSERVER, Process_1, Process_2, Process_3, Process_4 , then run ARMonitor_Admin getprocesscommand Process_1 will show the execution command for that process.

    Nov 16, 2016 05:13
    1. Prachi Kalyani

      Hello Colin,

      I have updated the topic with examples for ARMonitor_Admin.bat commands.

      Thanks,

      Prachi

      Dec 08, 2016 05:27
  6. Davinder Singh

    the location of new armonitor files is NOT mentioned in the documentation:

     

    Mar 24, 2017 01:42
    1. Anagha Deshpande

      Hello Davinder,

      I will confirm the file locations with the SME and will update the topic.

      Regards,

      Anagha 

      Mar 26, 2017 09:37
      1. Anagha Deshpande

        Hello Davinder,

        The ARMonitor.properties file and the ARMonitor_Admin.sh or ARMonitor_Admin.bat are located in the AR Server Install directory.

        File monitor is a process. It starts the AR System server and other processes like plugin server, dispatcher process, that are listed in the armonitor.cfg file.

        Regards,

        Anagha

         

        Mar 27, 2017 03:55
        1. Davinder Singh

          Thanks for the update. I understand that these components are in the AR Server Install directory like all the other components.

          However it will be helpful for the people who are the new to this version, if we update the documentation with the exact location under the AR Server Install directory of these components.

          Mar 27, 2017 06:55
          1. Anagha Deshpande

            Hello Davinder,

            Thanks for your inputs. I will check with the development team and will update the documents.

            Regards,

            Anagha 

            Mar 27, 2017 11:14
  7. Thad Esser

    I just upgrade to 9.1.04 from 8.1 and was looking at the new armonitor.cfg file. There are two new lines that I was hoping to find documentation about: External-Windows-Service: process-type = BMC:EmailEngine, service-name="BMC Remedy Email Engine - 1" External-Windows-Service: process-type = BMC:FlashBoardServer, service-name="BMC Remedy Flashboards Server - " On my system, they aren't doing what I first suspected they would (i.e. start those windows services) and wanted to check the documentation before submitting a ticket.

    Thanks

    Feb 23, 2018 08:04
  8. Thad Esser

    I just upgraded to 9.1.04 from 8.1 and was looking at the new armonitor.cfg file. There are two new lines that I was hoping to find documentation about:

    External-Windows-Service: process-type = BMC:EmailEngine, service-name="BMC Remedy Email Engine - servername 1" External-Windows-Service: process-type = BMC:FlashBoardServer, service-name="BMC Remedy Flashboards Server - servername"

    On my system, they aren't doing what I first suspected they would (i.e. start those windows services) and wanted to check the documentation before submitting a ticket.

    Thanks

    Feb 23, 2018 10:13
    1. Anagha Deshpande

      Hello Thad,

      I will check your query with the SME and will write back to you.

      Regards,

      Anagha

      Feb 25, 2018 09:29
      1. Anagha Deshpande

        Hello Thad,

        Please refer this documentation here.

        Hope this helps.

        Regards,

        Anagha

        Feb 26, 2018 01:03
        1. Thad Esser

          Hi. That link takes me to a page about the File Deployer configuration parameters and I don't see any reference to an "External-Windows-Service:" option there?

          Feb 26, 2018 10:43
          1. Anagha Deshpande

            Hello Thad,

            I will check and will respond back.

            Regards,

            Anagha

            Feb 26, 2018 09:58
            1. Thad Esser

              Do you have an update on this issue?

              Apr 19, 2018 07:51
            1. Thad Esser

              From a BMC support case I had opened: " I validated the details with my SME & also validated the same OOB. Below are my findings:

              • From 9.1.04 onwards armonitor.cfg will have External-Windows-Service parameters details as these processes will be used by ONLY AR Deployer (arpayloadfiledeployer which is part of Deployment Management)

              • These processes will not start or stop with main AR Server Services & these processes are not part of armonitor.exe, but when you use AR File Deployer, it will control the start\stop of the services. Another example is Midtier File Deployer will control start\stop of Tomcat.

              • In armonitor.log only shows what all External process name are defined.

              • We have submitted request to get documentation updated with more details information. "

              Apr 20, 2018 01:29
              1. Anagha Deshpande

                Hello Thad,

                Apologies for the inconvenience.

                I have updated the topic.

                Regards,

                Anagha

                Apr 22, 2018 10:44
  9. Kelly Logan

    "On UNIX, the arsystem script usually controls armonitor. For more information, see arsystem." And what about when it doesn't? On my stand-alone Mid-Tier install, there is no arsystem script at all. The installer seems to have started the armonitorJ process referred to, but if you use ARMonitor_Admin.sh armonitorstop to stop it, how is it restarted? It would be nice to know how to manually restart the armonitor process.

    Jul 23, 2019 09:34
    1. Anagha Deshpande

      Hello Kelly,

      We are working on your query. We will respond soon.

      Regards,

      Anagha

      Jul 23, 2019 11:44
    1. Michael Fahrenbruch

      Hi Kelly, on a MT only install, where there is no AR System Server, the armonitor.conf is for the file deployer. Since AR System Server is not installed on a MT only system, there would be no arsystem script. Also, just as you can use armonitor_admin.sh to stop a process, you can also use it to start a process, see "startprocess" on this same doc page. In Unix, you may need to execute the /midtier/filedeployer/filedeployer.sh script. Make sure this is executed by an ID that can stop/start your webserver. If you have further questions or need assistance on this, I would suggest opening a Support Case.

      Jul 23, 2019 12:51