OpsRamp Remote Shell provides the provision to write the custom scripts using Bash, Perl, and Python to help monitor remote devices.

Prerequisites

  • Remote System

    • Resource has SSH support.
    • Installation of one of the scripting languages, such as Bash, Python, and Perl.
    • All the libraries of the installed script are available in the remote system.
    • The custom script follows the predefined response format of OpsRamp.
  • OpsRamp

    • Gateway version 5.5.0.
    • Valid OpsRamp user credentials with permissions to create a metric, monitor, and template.
    • Access to the remote device requires a valid SSH credential.
    • Valid custom script execution path is provided in the monitors.

Limitations

  • Do not support command arguments in the scripts.
  • Cannot monitor gateway using Remote Shell.

Create metrics

You can create Custom Metrics using custom scripts.

  1. Select a client from the All Clients list.

  2. Go to Setup > Monitoring > Metrics.

  3. From the METRICS screen, click + Add and enter:

    • Collector Type: Select Application.

    • Application Type: Select Remote Shell.

    • Name: Enter a Name for the metric.

      • OpsRamp recommends <Prefix>.<Script Type>.<OS>.<Name> as naming convention for the metric.
        For example: rshell.bash.linux.disk_utilization, rshell.python.linux.cpu_utilization, and rshell.perl.linux.memory_utilization
    • Tag: User-defined tags for better filtering. For example, Application, Adapter, RemoteShell.

    • Display Name: Display Name provided for the metric.

    • Description: Reason for the metric.

    • Script: Enter the custom script in the Script text box. Refer to Bash script and JSON outputs example for single and multiple datapoints to view the example script.

    • Data Point type: Select the required data point.

    • Units: Select the required values for Units, Unit Multiplication Factor, and Datapoint value conversion lists.

    • Unit Multiplication Factor: Value chosen to multiply a value based on the chosen unit.

    • Data Point Conversion: One of the following options:

      • Value
      • Enumerated Map
    • Metric Processing: One of the following values for processing the Metric:

      • Notification

      • Graph

      • Graph and Notification. To configure values for Graph and Notification, enter the details for the following parameters:

        • Warning if value: Warning threshold value.
        • Critical if value: Critical threshold value.
        • Subject: Subject for the metric.
        • Description: Description for the metric.
          The values for Subject and Description are populated by default. OpsRamp recommends not to change the values as that can result in the failure of alert generation.
  4. Click Save.

Secure Shell Monitor Create Metric

Create monitors

The custom remote shell monitor is a collection of remote shell metrics. You can create a template using the remote shell monitor.

  • Monitor only one gateway using remote shell.
  • Monitor to have metrics of the same script type.
  • Select the custom parameter path depending on the script type.
  1. From All Clients, select a client.

  2. Go to Setup > Monitor Management > Monitors.

  3. From Monitors, click + Add.

  4. From Create a Monitor, enter the following parameters:

    • Monitor Scope: Scope for each monitor.

    • Adaptor Type: Select Application.

    • Application Type: Select Remote Shell.

    • Name: Unique monitor name.

    • Description: Details of the added monitors.

    • Metrics: A metric is a measurement for a specific characteristic of the performance of a device.
      To add metrics:

      1. From Metrics, click Add Metrics. A maximum of 20 metrics is recommended. Adding more number of metrics in a monitor can cause performance issues.
      2. Search the metric and click Add Metrics. The metrics section displays the selected metric.
    • Configuration Parameters: A configuration parameter is a user input to assist the metric collector. To add parameters:

      1. Enter Default Value for all the configuration parameters.

      2. Select the Configurable checkbox and click Add.

      3. Enter configuration parameters depending on your environment or devices. You can view the default value for the respective name selected. For example, the following shows the configuration parameters for a script type:

        • bash: rshell.bash.bin.path
        • python: rshell.python.bin.path
        • perl: rshell.perl.bin.path
        • custom executor: rshell.customexecutor.bin.path
  5. Click Save.

Secure Shell Create Monitor

Create templates

A template is an instance of a monitor and applied to devices.

  1. Select a client from the All Clients list.

  2. Go to Setup > Monitoring > Templates.

  3. From the TEMPLATES screen, click + Add.

  4. From MONITOR TEMPLATE, enter the following parameters:

    • Select Template Scope: Template type.

    • Collector Type: Select Gateway.

    • Monitor Type: Select Monitors for G2 Templates.

    • Applicable for: Select Device.

    • Template Name: Name of the template.

    • Description: Summary of the template.

    • Generation: Generation that the template belongs to.

    • Tags: User-defined tags for better filtering. For example, Application, Adapter.

    • Prerequisites: Essential things that you must consider while monitoring using the template. For example, check the SQL services while monitoring the SQL Parameters using the Windows templates.

    • Status: Active or End-of-life templates.

    • Notes: Information that you want to add to the template.

    • Template Family Name: Category that applies to the application. For example, Windows Server, Storage Server, and Network Server.

    • Deployment Type: One of the following methods to apply the template to the resources:

      • Custom
      • Optional
      • Standard
    • After providing the template details, MONITOR TEMPLATE displays the Monitors section. The user interface for the Monitors section varies with the option selected in the Collector Type.

    • Monitor: To add details in Monitors:

      1. From the Monitors section, click Add button.

      2. From the Monitor screen, enter the following parameters:

        • Frequency: Refer to the frequency to execute the template.
        • Monitor Definition: Monitor type.
        • When to Alert: Select Breach of a Threshold.
      3. Select the Availability and Alert checkbox to initiate monitoring.

  5. Click Save.

Secure Shell Monitor Template

Assign templates

Creating credentials for the template

  1. Select a client from the All Clients list.

  2. Go to Infrastructure > Resources.

  3. Select a resource, click Credentials, and +Add.

  4. From Create New Credentials, provide details for the following parameters and Save:

    • Name
    • Description
    • From the Type drop-down list, select SSH.
    • Authentication Type
    • Username
    • Password
    • Confirm Password
    • Port
    • Connection Time Out (ms)

Enter the details of the user having access to the remote device with SSH.

Assign the template to a resource

  1. Go to Infrastructure > Resources, select a resource, and click the resource name to view details.
  2. Go to Monitors > Templates and click +Assign Templates.
  3. From Apply Templates, select the templates. The selected Templates section displays the chosen templates.
  4. Click Assign. The template gets assigned to the selected device.

After assigning the template to a resource for monitoring, select Get Latest Metric Values to view the latest metric information.

View graphs

The gateway monitors the remote system using the assigned templates and displays the results in a graphical format.

  1. Go to Infrastructure > Resources, select a required resource from the list of resources. Alternatively, use the search option to locate the resource.
  2. Click the resource name to view details.
  3. From the left pane, click Metrics. The Metrics page displays graphs generated by all monitoring templates assigned to a device.
  4. Search with the template name to filter the graphs.
Monitor Template Graphs

Example: Bash scripts

In these examples:

  • Datapoints are used for plotting graphs.
  • Tokens are used for alert information.
system_load=`cat /proc/loadavg | awk '{print $2}'`
printf "{\n\"datapoints\":{\n\t\"System Load\" : %s\n},\n\"tokens\": {\n\t\"Current System Load\" : \"%s\"\n}\n}\n" "${system_load}" "${system_load}"

Bash single datapoint and token

This example is a JSON output for a single datapoint and token.

{
"datapoints":{
    "System Load" : 1.60
},
"tokens": {
    "Current System Load" : "1.60"
}
}

Bash multiple datapoints and tokens

This example is a JSON output for multiple datapoints and tokens.

{
   "datapoints":{
           "DiskC" : 50,
           "DiskD" : 81
   },
   "tokens": {
           "disk_utilization.total" : "DiskC : 40 GB, DiskD : 100 GB",
           "disk_utilization.used" : "DiskC : 20 GB, DiskD : 50 GB"
   }
}