The Blue Medora EMC VNX File Plugin for New Relic allows you to monitor your VNX File performance data from within the New Relic platform by pulling in metrics from the system and displaying them in a set of intuitive, graph-based monitoring dashboards.
This guide includes instructions for installing and configuring the Blue Medora EMC VNX File Plugin for New Relic.
You can find the New Relic EMC VNX File plugin in the following locations:
- New Relic Storefront Here
- Plugin Central
The VNX File plugin uses the SSH protocol to connect to the VNX File Control Station. Before installing and configuring the plugin, ensure your system meets the following requirements:
New Relic Requirements
- A New Relic account
EMC VNX File Plugin Requirements
- File Software Version: The plugin requires VNX File Software Version 8.1.3
- Permissions: The plugin requires permissions to run Control Station commands
- A Blue Medora License. A trial license will ship with the plugin. This license will remain effective for the duration of the Blue Medora beta trial period.
The New Relic EMC VNX File plugin can be installed one of the following ways:
- Using the New Relic Platform Installer
- Installing the Plugin Manually
The New Relic Platform Installer (NPI) is a command line tool that helps you easily download, configure and manage New Relic Platform Plugins. For more information, visit the Getting Started with the Platform Installer section of New Relic’s Community Forum.
NOTE: We recommend using the New Relic Platform Installer for installing and running your Blue Medora plugins for New Relic. Issues can arise by running a plugin directly in the foreground (e.g., when the machine reboots, the process will not be started again). The NPI automates much of these processes.
Once the NPI tool has been installed, run the following command:
./npi install com.bluemedora.emc.vnx.file
NOTE: This command will take care of the creation of newrelic.json and plugin.json files described in the Configuring the Plugin section.
The latest version of the plugin can be downloaded from the locations listed in the Obtaining the Plugin section. Once the plugin is on your box, extract it to your preferred directory location.
Refer to the Configuring the Plugin section, for details on setting up the plugin.
To run the plugin, navigate to the directory where the plugin was extracted, then execute the following command from your terminal or command line window:
java -jar plugin.jar
From the extracted plugin folder you receive when downloading your plugin, you will find the following files:
plugin.jar
eula.txt
oss_attribution.txt
[config folder]
newrelic.template.json
plugin.template.json
plugin_license.json
The two "template" .json files found in the config folder must be modified (i.e., customized) and renamed prior to setting up the plugin for monitoring.
The first file, newrelic.template.json, contains configurations used by all Platform plugins (e.g., license key, logging information, proxy settings) and can be shared across your plugins.
Make a copy of this template and rename it to newrelic.json. Listed below are the configurable fields within the newrelic.json file:
New Relic License Key - The only required field in the newrelic.json file is the License Key. This unique identifier informs New Relic about the specific account tied to the plugin. For more information on the License Key, refer to the New Relic License key documentation.
{
“license_key”: “YOUR_LICENSE_KEY_HERE”
}
Logging Configuration - By default Platform plugins will have their logging turned on; however, you can modify these settings with the following configurations:
log\_level - The log level. Valid values: [debug, info, warn, error, fatal]. Defaults to info.
log\_file\_name - The log file name. Defaults to newrelic_plugin.log.
log\_file\_path - The log file path. Defaults to logs.
log\_limit\_in\_kbytes - The log file limit in kilobytes. Defaults to 25600 (25 MB). If limit is set to 0, the log file size would not be limited.
{
"license_key": "YOUR_LICENSE_KEY_HERE",
"log_level": "debug",
"log_file_path": "log_file_path": “logs"
}
Proxy Configuration - If you are running your plugin from a machine that runs outbound traffic through a proxy, you can use the following optional configurations in your newrelic.json file:
proxy\_host - The proxy host (e.g. webcache.example.com)
proxy\_port - The proxy port (e.g. 8080). Defaults to 80 if a proxy_host is set
proxy\_username - The proxy username
proxy\_password - The proxy password
Example:
{
"license_key": "YOUR_LICENSE_KEY_HERE",
"proxy_host": "proxy.mycompany.com",
"proxy_port": 9000
}
The second file, plugin.template.json, contains data specific to each plugin (e.g., a list of hosts and port combinations for what you are monitoring). Templates for both of these files should be located in the ‘config’ directory in your extracted plugin folder.
Make a copy of this template and rename it to plugin.json. Shown below is an example of the plugin.json file’s contents.
NOTE: You can add multiple objects to the “agents” array to monitor multiple VNX File instances.
NOTE: Each object in the "agents" array should have a unique "instance_name".
Fields
| Field Name | Description |
|---|---|
| instance_name | The name of your New Relic VNX File instance that will appear in the User Interface |
| primary_control_station | The IP or domain name of the Primary Control Station for VNX File |
| secondary_control_station | The IP or domain name of the Secondary Control Station for VNX File |
| username | User name to log into the Control Stations |
| password | Password to log into the Control Stations |
| nas_path | Path to the NAS_DB configuration files location. Usually /nas. |
| sample_seconds | Query interval parameter. Must be an integer 1 or greater |
Example:
{
"agents": [
{
"instance_name": "Your VNX File Instance",
"primary_control_station": "your_value_here",
"secondary_control_station": "your_value_here",
"username": "your_value_here",
"password": "your_value_here",
"nas_path": "/nas",
"sample_seconds": 3
},
{
"instance_name": "Your VNX File Instance with only Primary Control Station",
"primary_control_station": "your_value_here",
"username": "your_value_here",
"password": "your_value_here",
"nas_path": "/nas",
"sample_seconds": 3
}
]
}
For more information about navigating New Relic’s user interface, refer to their Using a plugin documentation section.
For questions or issues regarding the Blue Medora EMC VNX File Plugin for New Relic, visit http://support.bluemedora.com.
System Overview
| Metric Name | Description |
|---|---|
| Latency (ms) | The latency of the system in milliseconds |
| Network Throughput (MBps) | The network throughput of the system in megabytes per second |
| Disk IOPS (ops/sec) | The disk IOPS of the system |
| Disk Throughput (MBps) | The disk throughput of the system in megabytes per second |
| CPU Utilization (%) | The CPU utilization percentage of the system |
| Memory Utilization (%) | The memory utilization percentage of the system |
| Highest Component Temperature (C) | The highest component temperature in celsius |
| Average Component Temperature (C) | The average component temperature in celsius |
Data Movers
| Metric Name | Description |
|---|---|
| CPU Utilization (%) | The CPU utilization percentage of a data mover |
| Memory Utilization (%) | The percentage of memory utilized by a data mover |
| Latency | The latency of a data mover |
| Total IOPS (ops/sec) | The total IOPS of a data mover |
| Network Throughput (Bps) | The network throughput of a data mover |
Network Interfaces
| Metric Name | Description |
|---|---|
| Inbound Network Throughput (Bps) | The inbound network throughput of the network interfaces |
| Outbound Network Throughput (Bps) | The outbound network throughput of the network interfaces |
| Inbound Network Errors (errors/sec) | The inbound network errors per second of the network interfaces |
| Outbound Network Errors (errors/sec) | The outbound network errors per second of the network interfaces |
File Systems
| Metric Name | Description |
|---|---|
| Utilization (%) | The utilization percentage of a file system |
| Used Capacity (GB) | The used capacity of a file system in gigabytes |
| Total Capacity (GB) | The total capacity of a file system in gigabytes |
| Read IOPS (ops/sec) | The read IOPS of a file system |
| Write IOPS (ops/sec) | The write IOPS of a file system |
| Read Throughput (Bps) | The read throughput of a file system |
| Write Throughput (Bps) | The write throughput of a file system |
Storage Pools
| Metric Name | Description |
|---|---|
| Utilization (%) | The utilization percentage of a storage pool |
| Used Capacity (GB) | The used capacity of a storage pool in gigabytes |
| Total Capacity (GB) | The total capacity of a storage pool in gigabytes |
Summary
| Metric Name | Description |
|---|---|
| CPU (%) | The average cpu utilization for Data Movers |
| Memory (%) | The average memory utilization for Data Movers |
| Latency (µs) | The average latency for Data Movers in micro seconds |
| High Temp (C) | The highest temperature detected in celsius |