Metric Plugins
Overview
Metric plugins in Motadata AIOps empower users to define custom metrics according to their specific requirements. These plugins allow users to define metrics within Motadata AIOps for monitoring purpose. For instance, users can create a new metric plugin to monitor the temperature of a motherboard or any other custom parameter relevant to their environment.
Creating a new metric plugin includes writing a script using various protocols such as HTTP/HTTPS, SSH, PowerShell, database queries, or custom protocols. This script retrieves the desired data from the monitored devices and presents it as a metric in Motadata.
Motadata also provides multiple in-built metric plugins covering common metrics and parameters. These pre-configured templates can be readily utilized without the need for custom scripting, offering users a convenient solution for standard monitoring needs.
Users can manage both in-built and custom metric plugins through the Metric Plugin screen. Here, users can view, create, edit, and assign plugins to monitors. Users can also clone an inbuilt plugin and further customise it as per their requirement.
Motadata AIOps also allows cross device plugin creation which helps users to add metrics with a different protocol than the one used to discover a device. For instance, a device is discovered using SNMP communication protocol but the VLAN details are not exposed through the same protocol. Thus, users can create a Metric Plugin with the SSH protocol with a custom script to fetch the VLAN details and attach it to the monitor.
Additionally, users will be able to test monitors individually or in bulk after assingning the Metric Plugin. Users will be to view the test results for the same for each monitor and can also view the the execution output individually.
Navigation
Select Settings . After that, Go to Plugin Library
. Select Metric Plugin. The Metric Plugin screen is displayed.
The Metric Plugin Management screen displays the following details for each plugin:
| Field | Description |
|---|---|
| Metric Name | Unique identifier for the metric plugin. |
| Protocol | Communication protocol used by the plugin — for example, HTTP/HTTPS, SSH, or PowerShell. |
| Type | Device type the plugin applies to — for example, Switch or Router. Populated automatically for plugins derived from SNMP Device Catalog discovery. |
| Vendor | Vendor name associated with the plugin. Populated automatically for plugins derived from SNMP Device Catalog discovery. |
| Model | Device model associated with the plugin. Populated automatically for plugins derived from SNMP Device Catalog discovery. |
| Used Count | Number of monitors currently using the plugin. |
| Actions | Available actions: clone, assign to monitors, edit (for SNMP-derived plugins). See the sections below for details. |
Actions Available For Metric Plugins
Assign Metric Plugins To Monitor
In order to retrieve metrics from a monitor using a specific metric plugin, generally in the case of custom created plugin, the plugin should be assigned to the Monitor. Once assigned, the plugin will retrieve the metrics as per the configuration in the plugin. The metrics will be polled for the monitor according to the assigned plugin on the next poll.
Under the Actions Tab, Select Assign Monitor to display the list of monitors to which the metric plugin can be assigned. The monitors using the same protocol as the plugin are displayed for assignment.
Select the monitors to which you need to assign the metric plugin using the check-box against it. You can select multiple monitors in case you need to assign the plugin to more than one monitor at once.
Select Assign Monitor to assign the plugin to the selected monitor(s).
Select Cancel if you do not wish to assign the plugin to the monitor(s).
Clone Metric Plugins
Suppose you want to create a new Metric Plugin similar to an existing one but with minor changes, you can use the Clone option. This will help create a new plugin with similar parameters. You can then change the parameters as per your requirement and create a new Plugin.
Under the Actions Tab, Select Clone to start creating a duplicate of the metric plugin. The screen to create a metric plugin appears with the same script and parameters as the plugin you selected to clone.
Enter all the details as per your requirement. Refer How to Create a Metric plugin to find more details about the fields present on the screen.
Edit SNMP Metric Plugins
Metric Plugins derived from SNMP Device Catalog discovery are editable. If an OID mapping is incorrect, you can fix it directly on the plugin without recreating it.
Under the Actions tab, select Edit to open the plugin configuration. You can update OID mappings, replace incorrectly mapped OIDs, add or remove Metric Groups, and configure Scalar or Tabular OIDs. Select Save to apply the changes. The updated mappings take effect on the next poll.
Remove an OOTB Metric Plugin from a Specific Device
Out-of-the-box (OOTB) Metric Plugins assigned through SNMP Device Catalog discovery can be removed at the individual device level without affecting the global catalog configuration.
Navigate to the device in Device Monitor Settings and locate the assigned Metric Plugin. Select Remove to detach the plugin from that device only. All other devices that inherit the same SysOID mapping remain unaffected.