Written By
Siddharth Sonaria
Siddharth Sonaria

HTTP/HTTPS Metric Plugin

Overview

*****************************

After selecting , a screen appears to create a metric plugin.

HTTP/HTTPS is selected by default.

Parameters for the HTTP/HTTPS Metric Plugin Creation

The following parameters appear on the Create Metric screen for HTTP/HTTPS.

Metric Name Enter a unique name of the metric you wish to create. The name should be given logically based on how the metric is defined.
Type Select Type of the monitor from the dropdown.
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the plugin you create to an individual monitor. Select the monitor to which you wish to assign the plugin from the dropdown titled Monitors.
  • Select Group if you wish to assign the plugin to a group of monitors. Select the group to which you wish to assign the plugin from the dropdown titled Groups.
Credential Profile Select the credential profile so that your plugin is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
URL Endpoint Enter the URL Endpoint.
URL Type Select the type of connection(HTTP/HTTPS) for which you want to create the plugin.
URL Method Select the method(GET/POST) using which you want to create this plugin.
JSON URL
URL Content Enter a keyword to search within the page mapped to the URL.
Add Parameter
Add Header
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SSH script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Metric button to create the metric based on the parameters entered.

Select the Test button to validate the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Metric option is enabled only after the Test is successfully completed.

Written By
Siddharth Sonaria
Siddharth Sonaria

How to Create a Metric Plugin?

Overview

There might be certain situations where you need to define metrics in Motadata that cannot be defined by the standard in-built plugins available in the system. This would include devices such as UPS, Printer, NAS and their metrics like power consumption, Fan RPM, Temprature etc.

Suppose you have a homegrown application running on a monitor and you need to retrieve a custom metric that not be available in AIOps by default. You can create a metric plugin and write a script using the appropriate protocol to establish connection to the monitor and retrieve the metrics as per your requirement and start monitoring them.

Go to Menu, Select Settings . After that, Go to Plugin Library . Select Metric. The Metric Plugin screen is displayed.

Select to create a metric plugin.

Types of Metric Plugin

Motadata AIOps facilitates creating different types of metric plugins based on communication protocol. They can be categorized as follows:

  1. HTTP/HTTPS
  2. SSH
  3. PowerShell
  4. Database
  5. Custom
Written By
Siddharth Sonaria
Siddharth Sonaria

Metric Plugins

Overview

Motadata provides a set of in-built metric plugins to read certain parameters from monitors and define them as metrics in Motadata. These plugins facilitate Motadata to understand how certain metrics are defined. This mapping of metrics is achieved through these in-built metric plugins and then the values of these metrics are later on retrieved while polling data from monitors.

You can also create new metric plugins to define metrics in Motadata that are not defined by the standard in-built plugins. This would generally include devices like UPS, Printer, NAS and metrics like Power Consumption, Fan RPM, and Temperature.

You can create new plugins and manage the existing ones through a Metric plugin management screen. You can view and manage the plugins on this screen.

Go to Menu, Select Settings . After that, Go to Plugin Library . Select Metric. The Metric plugin screen is displayed.

The following fields are then displayed on the screen:

Metric Name The name given to identify a metric plugin.
Protocol Indicates the communication protocol the plugin is using.
Type Indicates the monitor type on which the metric plugin will run.
Used Count indicates the number of monitors using the plugin.
Actions Selecting the icon displays permissible actions for each Topology plugin. The following actions are available for each plugin:

  • Clone: This button is used to duplicate an existing metric plugin in the system.
  • Assign Monitors: This button is used to assign a metric plugin to a monitor.
  • Remove Runbook: This button is used to unassign a metric plugin from a monitor.
Written By
Siddharth Sonaria
Siddharth Sonaria

How to Clone a Runbook?

Overview

Suppose you want to create a Runbook similar to an existing one but with minor changes, you can use the Clone Runbook option.

This will help create a new Runbook with similar parameters. You can then change the parameters as per your requirement and create a new Runbook.

Go to Menu, Select Settings . After that, Go to Plugin Library . Select Runbook. The Runbook Screen is now displayed.

Now, Select under Actions on the Runbook you want to Clone. Select Clone Runbook

A new Runbook creation screen is now displayed with all the parameters.
You can now make changes to the parameters as per your requirement and create a new Runbook.

Written By
Siddharth Sonaria
Siddharth Sonaria

Custom Runbook

Overview

Custom Runbook can be used to perform certain actions on a monitor using custom settings.

After selecting the , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the Custom Runbook to start creating the Runbook.

Custom Runbook Screen

The following parameters appear on the Create Runbook screen for Database protocol.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the Runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
Port Kindly enter the port number of the database instance.
Timeout Enter the time (in Seconds) that AIOps will try to establish the connection before it times out. If the connection cannot be established due to unforeseen reasons, the Runbook execution will timeout in the time mentioned here instead of running indefinitely.
Script Kindly write the script for the operation you want your Runbook to perform.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SQL script..
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Written By
Siddharth Sonaria
Siddharth Sonaria

HTTP Runbook

Overview

HTTP Runbook can be used if you want to execute certain actions on a monitor while using HTTP protocol to access the monitor. This can be used for Ruckus devices, VMware etc.

After selecting , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the HTTP to start creating the Runbook.

HTTP Runbook Screen

The following parameters appear on the Create Runbook screen for HTTP.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
URL Endpoint Enter the URL Endpoint.
URL Type Select the type of connection(HTTP/HTTPS) for which you want to create the Runbook.
URL Method Select the method(GET/POST) for which you want to create this Runbook.
JSON URL
URL Content Enter a keyword to search within the page mapped to the URL.
Add Parameter
Add Header
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SSH script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Written By
Siddharth Sonaria
Siddharth Sonaria

Database Runbook

Overview

Database Runbook can be used if you want to execute certain actions on a database such as querying on a database, memory release, and many other actions. This Runbook established connection with the database using the JDBC protocol.

After selecting the , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the Database Runbook to start creating the Runbook.

Database Runbook Screen

The following parameters appear on the Create Runbook screen for Database protocol.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the Runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
Port Kindly enter the port number of the database instance.
Timeout Enter the time (in Seconds) that AIOps will try to establish the database connection before it times out. If the connection cannot be established due to unforeseen reasons, the Runbook execution will timeout in the time mentioned here instead of running indefinitely.
SQL Script Kindly write the SQL script for the operation you want your Runbook to perform.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SQL script..
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Written By
Siddharth Sonaria
Siddharth Sonaria

Trace Route Runbook

Overview

The Trace Route runbook is used to find a packet’s path as it travels from the Motadata AIOps server to the destination Monitor you select. This Runbook does not involve writing any script.

The Trace Route Runbook shows the result for the path traveled from our network to the monitor for which the Runbook is created.

The output of running a Trace Route includes the following parameters:

  • No. Of Hops: The number of Hops along the route from source to destination.
  • Round Trip Time (RTT): The time taken for your packet to reach its destination and return to your computer. This is listed in milliseconds.
  • Domain Name/IP Address: The Domain address or IP address of the destination.

After selecting , a screen appears to create a Runbook.

SSH runbook is selected by default. Select the Trace Route Runbook to start creating the Runbook.

SNMP Runbook Screen

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the Runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
Maximum Hops Enter the maximum number Of hops that are allowed before your Runbook times out. This is set as ‘15’ by default.
Probes Enter the maximum number. Of probes allowed for your Trace Route. This is set as ‘2’ by default
Timeout Enter the time (in Seconds) that Trace Route will run for before it times out. In case Trace Route is not able to reach its destination due to some unforeseen reasons, the Trace Route will timeout in the time mentioned here instead of running indefinitely.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to trace the route from source to destination.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Written By
Siddharth Sonaria
Siddharth Sonaria

SNMP Runbook

Overview

SNMP Runbook can be used if you want to execute certain actions on a monitor while using SNMP protocol to access the monitor.

After selecting the , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the SNMP Runbook to start creating the Runbook.

SNMP Runbook Screen

The following parameters appear on the Create Runbook screen for SNMP protocol.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the Runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
SNMP Group Type Select Scalar or Tabular based on the type of OID.
OID Name Provide a unique name to the OID which you need to include in the Runbook script. This name will be used in the script to refer to the OID instead of the 12-digit OID number.
OID Enter the OID which you need to include in the runbook script. The script will be used to perform tasks on this OID.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output OID(s).
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.
Written By
Siddharth Sonaria
Siddharth Sonaria

PowerShell Runbook

Overview

PowerShell Runbook can be used if you want to execute certain actions on a monitor while using PowerShell protocol to access the monitor. This can be used for Windows devices.

After selecting the , a screen appears to create a Runbook.

SSH Runbook is selected by default. Select the Powershell Runbook to start creating the Runbook.

PowerShell Runbook Screen

The following parameters appear on the Create Runbook screen for Powershell protocol.

Runbook Name Enter a unique name of the Runbook you wish to create. The name should be given logically based on the task performed by the Runbook
Monitor/Group

Select a Monitor or Group based on your requirement.

  • Select Monitor if you wish to assign the runbook you create to an individual monitor. Select the monitor to which you wish to assign the Runbook from the dropdown titled Monitors.
  • Select Group if you wish to assign the runbook to a group of monitors. Select the group to which you wish to assign the Runbook from the dropdown titled Groups.
Credential Profile Select the credential profile so that your runbook is able to access the monitor using the appropriate credentials and perform its task on the monitor.
Create Credential Profile Select this option if you wish to create a new credential profile.
SSH Script Write down the script of the task you want your runbook to perform in this space.
Script Language Select the language (GO or Python) in which you write your script.
Parsing Script Enter the script to parse the output received after executing the SSH script.
Add variable Add a variable, if needed to be used in the parsing script.

Select the Create Runbook Plugin button to create the Runbook based on the parameters entered.

Select the Test button to verify the correctness of the script and the validity of the credential profile.

Select the Reset button to erase all the current field values, if required.

Note: The Create Runbook Plugin option is enabled only after the Test is successfully completed.