Knowledge Base

Properly Setting the Exit Codes When Configuring the Command Line Monitor

Introduction

When configuring a Command Line Monitor in Monitoring Studio, you can indicate if the command is successful or failed when a specific exit code is found. Before configuring the Command Line Monitor, it is therefore important to:

1. Decide which command you would like to run
2. List the possible exit codes for this command
3. Select the exit codes that should be associated to a successful/failed command execution.

Example

In our example, we will run a curl command for which we know that these exit codes may occur:

• CURLE_OK (0)
• CURLE_UNSUPPORTED_PROTOCOL (1)
• CURLE_FAILED_INIT (2)
• CURLE_URL_MALFORMAT (3)
• CURLE_NOT_BUILT_IN (4)
• CURLE_COULDNT_RESOLVE_PROXY (5)
• CURLE_COULDNT_RESOLVE_HOST (6)
• CURLE_COULDNT_CONNECT (7)
• etc.

Imagine that we want to perform a health check of a specific URL and alert when it cannot be reached (the curl command then returns the exit code 7).

1. Before configuring the Command Line Monitor, we first:

   • Define the Host to be monitored
   • Create our Template

   • Apply our Template to our specific Host.

     For more information, refer to the Hosts and Templates documentation.

2. Then, we edit our Template to add a Command Line Monitor:

   

3. In the Command Line field, we enter the command to be run. In our example: curl http://myintranet:8200/v1/sys/health

   

4. We then indicate the credentials to be used to run the command and whether it will be run on the Monitored Host or on the Agent system. In our example, it is on the Monitored Host.

5. In the Execution Validation section, we indicate the conditions to validate the command. In our example, the Failed Exit Code is 7.

   

   If we would have wanted Content-Parsing Monitors (String Search, Numeric Value Extraction, Value Map, etc) to be processed when the exit code is 7, we should then have selected Successful Exit Codes: instead Failed Exit Codes:.

6. Finally, we click Create.

Related Topics

• Embedding a File in a Monitoring Studio X Template
• Getting Notified When a Parameter is no Longer in Alert
• Monitoring Disk Space on UNC Mounted Drives using Monitoring Studio
• Monitoring SharePoint 2016 and 2019 with Monitoring Studio X
• Monitoring Studio Denies Access to the Web Interface
• Monitoring Studio X Unexpectedly Hangs or Consumes High CPU When Running a JRE Higher Than 8
• Monitoring Studio X: HTTP Proxy Authentication Fails When Using Java 8 Update 111 or Later
• Monitoring Studio: Executing Commands in Windows PowerShell Using the Command-line Analysis Tool
• Monitoring a Non-Listed Database with Monitoring Studio X
• Text Processing with Monitoring Studio X
• Troubleshooting Issues with TrueSight Presentation 11.3.03 Upgrade