Applications

From OpsWise Documentation Wiki

Contents 1 Overview 2 Creating a New Application Resource Record 3 Application Field Descriptions

Overview

The Application Resource record is the core component of the OpsWise Application Monitoring and Control function. These records define the name of the Application being monitored, the name and location of the machine where it is running, and the start, stop, and query commands needed to perform the monitoring and control functions.

Shown below is a sample Applications resource list, which displays all the Applications you have set up to be monitored. You must manually refresh this screen to fetch the latest status information.

You can also use Application resources and their associated Application Control tasks to start, stop, and query applications as part of your scheduling processes. You can execute Application Control tasks as you would execute any other task and include them in workflows where applicable. In addition, you can define Application Monitor triggers to automatically launch one or more tasks of any type, depending on the status of one or more Application resources. For example, you might set up an Application Monitor trigger that sends an email to Windows tech support personnel if any Windows application goes to Impaired or Inactive status.

In order for OpsWise to access the application, the application must be running on a machine where an OpsWise Windows, Linux/Unix, or z/OS agent is running.

If you set up OpsWise to monitor your applications, you should always start and stop the applications from within OpsWise. If you stop an application outside of OpsWise, you must also restart it from outside of OpsWise. If OpsWise detects a problem with an application (the application goes to Impaired status), you should troubleshoot the problem and restart the application outside of OpsWise. OpsWise will continue monitoring and when it detects that the application is back up, it will put the application back into Active status.

Creating a New Application Resource Record

1. From the Navigation Pane, select Automation Center Resources > Applications.
2. From the wizard, select New. OpsWise Automation Center displays the Application screen.
3. Using the field descriptions provided below as a guide, complete the fields as needed.
4. Click the Submit button to save the record and return to the menu, or, right-click on the title bar and select Save to save the record and remain on the current display. When you save the new Application Resource record, OpsWise also automatically creates three related tasks, one each for starting, stopping, and querying the application.
5. If appropriate, repeat these steps for any additional Applications you want to add.

Shown below is a sample Application screen.

Application Field Descriptions

Field Name	Description
Application Name	Required. Name used within OpsWise Automation Center to identify this resource. Up to 40 alphanumerics. It is the user’s responsibility to develop a workable naming scheme for resources.
Application Type	User-defined. The type of application. Options: Windows Service Linux/Unix Daemon z/OS Started Task
Credentials	Optional. The login credentials OpsWise Automation Center will use to access the remote machine. See Credentials.
Agent	Required. The name of the Windows, Linux/Unix, or z/OS agent resource that describes the machine where the application will run.
Run as sudo	Optional; Linux/Unix only. Run the command as Sudo (superuser do).
Member of Groups	User-defined. Allows you to select one or more Opswise groups that this task definition belongs to. Click on the lock icon to unlock the field and select groups.
Startup Query Maximum	Required; user-defined. The default is 1. Allows you to specify the maximum number of times the system should query for Active status during startup before it puts the application into Impaired status. For applications that take awhile to start, you should specify a higher number. When you issue a Start command, the system issues the Start, waits 30 seconds, then executes the Query command. It continues executing the Query command every 120 seconds thereafter (until you issue a Stop command). If the startup takes longer than the maximum queries specified, the application goes to Impaired status. However, the system continues to query. If the required exit codes are eventually returned, the application then goes to Active status.
Startup Query Attempts	System-supplied. The number of queries that were executed before the Application went into Active or Impaired status.
Query Exit Code	System-supplied. The most recent exit code returned by the application in response to a query.
Runtime Directory	Optional. The directory where the application executes. Variables supported.
Start Command	Required. The command used to start the application. This can be any process or command that starts the application. If you try to start an application monitor that is already started, you will see the message: Application already monitored with <status> status.
Stop Command	Required. The command used to stop the application. This can be any process or command that stops the application.
Query Command	Required. The command used to query the application. This can be any process or command that queries the application. You must first start the application monitor from OpsWise before you can query the application.
Exit Code Processing	Specifies how OpsWise Automation Center should determine whether the application is running or not. Options: Success Exitcode Range - The application goes to or remains in Active status if its exitcode falls within the range specified in the Query Exit Codes field (see below). Otherwise it has Impaired status. Failure Exitcode Range - The application goes to or remains in Impaired status if its exitcode falls within the range specified in the Exit Codes field (see below). Otherwise it has Active status. Success Output Contains - The application goes to or remains in Active status if its output contains the text specified in the Scan Output For field (see below). Otherwise it has Impaired status. Failure Output Contains - The application goes to or remains in Impaired status if its output contains the text specified in the Scan Output For field (see below). Otherwise it has Active status.
Query Exit Codes	If Exit Code Processing = Success Exitcode Range or Failure Exit Code Range, this field specifies the range. Format: Numeric. Use commas to list a series of exitcodes; use hyphens to specify a range. Example: 1,5, 22-30.
Output Type	If Exit Code Processing = Success Output Contains or Failure Output Contains, this field specifies the type of output. Options: Standard Output (STDOUT) Standard Error (STDERR) File
Scan Output For	Required if output is being scanned. Specifies the string that the system should scan for in the output.
Output File	Required if Output type=File. The path and name of the file.
Status	System-supplied. Indicates the current status of the application. One of the following: Inactive - The application is not being monitored by OpsWise. Start Failure - The application failed to start. This may occur, for example, if you have problems with credentials or the start command itself is incorrect. When this occurs, OpsWise is not monitoring the application. You should troubleshoot the problem and restart the application from OpsWise. Starting - The Start command has been executed. Active - The application has successfully started and is running, based on the parameters specified in the Exit Code processing fields. Impaired - An application that is being monitored returned a response that, based on the specified exit code parameters, indicates that it is not running. If this occurs, you should troubleshoot the problem and restart the application from outside OpsWise. Unless you issue a stop command, OpsWise continues monitoring during this process. When the application comes back up, the query process will recognize this and return the application to Active status.
Status Description	System-supplied. A more detailed status message describing why a status change occurred, in the format: "Query exit code [ ] [in/not in] [success/failure] exit code range. Query [success/failure] output not found."
Start Time	System-supplied. The date and time that the application was last started by Opswise.
Last Query	System-supplied. The date and time of the last query response received from the application.
Application Control tasks tab	Lists all Application Control tasks associated with this Application resource.
Application Control Task instances tab	Lists all Application Control task instances associated with this Application resource.
Update button	Updates this record with any changes.
Start button	Executes the Start command associated with this Application resource and begins querying.
Query button	Executes the Query command associated with this Application resource. This allows you to get immediate status of the application instead of waiting for the next automated query.
Stop button	Executes the Stop command associated with this Application resource. OpsWise stops the application and stops querying (monitoring).
Delete button	Deletes this Application Resource record.