Setting up Agent-based Monitors

Describes how to create agent-based custom monitors.

Leave Feedback


Agent-based custom monitors are user-defined instrumentation for specialized workloads. OspRamp provides native monitors, however, you can also create custom monitor by writing your own scripts.

Using custom monitor, you can define remote metrics and metric conditions for a monitor and gather the performance insights using an agent that runs on Windows and Linux devices. OpsRamp generates an alert when the threshold surpasses the conditions defined in a metric.

Along with Agent-based monitoring, OpsRamp also provides support for Agentless Custom Monitors.

Creating agent-based custom monitors

The agent-based Custom monitor helps you to create your own script to create new monitors. To write a script, you must choose a scripting language supported by OpsRamp. For example, Python, Windows PowerShell, and SHELL.

To create agent-based custom monitors:

  1. Go to Setup > Monitoring > Agent Custom Monitors.

  2. From AGENT CUSTOM MONITORS, click + Add.
    CREATE MONITOR SCRIPT screen appears.

  3. From CREATE MONITOR SCRIPT, provide details for the following parameters, and Save:

    • Select Script Type: Refers to the scripts applicable for Partners and Clients. 
    • Script Name: Refers to the unique name provided for the script.
    • Description: Refers to the detailed description that explains the purpose of the script.
    • Execution Type: Refers to the type of execution. Select as desired. Depending on the selected type of execution, the screen displays additional fields. For example, if you select EXE as execution type, then the File field appears below. You can use the Choose File to upload the required .exe file. If you select any other execution type, you need to provide Command/File Name and the corresponding script extension.
    • Metrics: Refers to the Metrics required for the script. To add Metrics:
      1. From Metrics, click + Add Metric. Metric fields appear.
      2. Provide the metrics details.

    AGENT CUSTOM MONITORS screen displays the new monitor.

Agent-based Create Custom Monitor

Agent-based Create Custom Monitor

After creating the Agent Custom Monitors, you can add the custom monitor to a template and assign the template to a resource. For more information, view Create a Template and Assign a Template to a resource.

Agent-based custom monitor scripts

You can use the following custom monitor scripts for G2 Agents:

  • VBS Script
  • PERL Script
  • PHP Script
  • PYTHON Script
  • BASH Script

Setting up folders and users

You can create and execute custom monitors. By default, all the custom monitor scripts and log files are downloaded to a predefined location in your system. the system user (Windows) and root user (Linux) holds all required permissions (Read, Write and Execute) on the download folders.

The following table provides the details of the default folder location and user:

Default Folder Locations
Operating SystemDefault Folder LocationDefault User
  • 32 bit – %programfiles%\OpsRamp\Agent\utils
  • 64 bit – %programfiles(x86)%\OpsRamp\Agent\utils
System User
Linux/opt/opsramp/agent/lib/libexec/Root User
  • Default permission set for all executable files in this folder is 744.
  • Default permission set for other files in this folder is 644.

Managing agent custom monitors

You can manage the configured agent custom monitors using multiple methods.

You can use the search option to find a custom monitor by the script name. For searching with criteria, use the Advanced option.


To use the advanced search:

  1. Click Advanced. ADVANCED SEARCH window appears.
  2. From ADVANCED SEARCH window, provide details for the following parameters and click Search:
    • Scope
    • Script Name
    • File Name
    • Description

Viewing custom monitor script

You can view the configured agent custom monitors either in List view or Table. 

After creating an agent custom monitor script, you can view the details such as metrics and templates from the VIEW CUSTOM MONITOR SCRIPT screen.

Agent-based View Custom Monitor

Agent-based View Custom Monitor

What to do next