Trend and monitor Aerospike statistics using the New Relic Aerospike plugin. Plugin gathers metrics from your Aerospike and sends the metrics to the New Relic Platform. Collection and visualization of various metric from Aerospike includes :
- Overview
- Node Statistics
- Namespaces Statistics
- Latency
Note - There are many changes in stats naming for all Aerospike_Server > 3.9.0. Many stats have been moved from node level to namespace level. So there could be few graphs under above categories which may be empty. All graphs depending on older(Aerospike_Serever <3.9) Server would be deprecated in future.
- A New Relic account.
- Java Runtime (JRE) environment Version 1.6 or later
- Running Aerospike Server.
- Network access to New Relic.
User should install this plugin in one place and monitor the cluster. User doesn't need to install plugin in every node of cluster. User has to provide a seed_list of Hosts ["host:port", "host:port"....] in plugin.json file. This plugin can be installed one of the following ways:
The New Relic Platform Installer (NPI) is a simple, lightweight command line tool that helps you easily download, configure and manage New Relic Platform Plugins. To learn more simply go to new relic forum category and checkout the 'Getting Started' section.
Once you've installed the NPI tool, run the following command:
./npi install com.aerospike.newrelic.connector
This command will take care of the creation of newrelic.json and plugin.json configuration files. See the configuration information section for more information.
The latest version of the plugin can be downloaded here .Once the plugin is on your box, extract it to a location of your choosing.
Note - This plugin is distributed in tar.gz format and can be extracted with the following command on Unix-based systems (Windows users will need to download a third-party extraction tool or use the New Relic Platform Installer):
tar -xvzf newrelic-aerospike-plugin-X.Y.Z.tar.gz
Check out the configuration information section for details on configuring your plugin.
To run the plugin, execute the following command from a terminal or command window (assuming Java is installed and on your path):
java -Xmx128m -jar plugin.jar
Note: - Though it is not necessary, the '-Xmx128m' flag is highly recommended due to the fact that when running the plugin on a server class machine, the java command will start a JVM that may reserve up to one quarter (25%) of available memory, but the '-Xmx128m' flag will limit heap allocation to a more reasonable 128MBs.
For more information on JVM server class machines and the -Xmx JVM argument, see:
- http://docs.oracle.com/javase/6/docs/technotes/guides/vm/server-class.html
- http://docs.oracle.com/cd/E22289_01/html/821-1274/configuring-the-default-jvm-and-java-arguments.html
You will need to modify two configuration files in order to set this plugin up to run. The first (newrelic.json) contains configurations used by all Platform plugins (e.g. license key, logging information, proxy settings) and can be shared across your plugins. The second (plugin.json) contains data specific to each plugin such as a list of hosts and port combination for what you are monitoring. Templates for both of these files should be located in the 'config' directory in your extracted plugin folder.
The plugin.json file has a provided template in the config directory named plugin.template.json. If you are installing manually, make a copy of this template file and rename it to plugin.json (the New Relic Platform Installer will automatically handle creation of configuration files for you).
For monitoring multiple clusters just add more configuration objects in agents array.
Below is an example of the plugin.json file's contents :
{
"agents": [
{
"seed_list" : ["host:port","host:port","host:port"...],
"user" : "username",
"password" : "password",
"clusterName" : "cluster name"
}
]
}
Note
- If running community/non-secure Aerospike server then left user/password blank "" or remove those fields from plugin.json file.
The newrelic.json file also has a provided template in the config directory named newrelic.template.json. If you are installing manually, make a copy of this template file and rename it to newrelic.json (again, the New Relic Platform Installer will automatically handle this for you).
The newrelic.json is a standardized file containing configuration information that applies to any plugin (e.g. license key, logging, proxy settings), so going forward you will be able to copy a single newrelic.json file from one plugin to another. Below is a list of the configuration fields that can be managed through this file:
Your New Relic license key is the only required field in the newrelic.json file as it is used to determine what account you are reporting to. If you do not know what your license key is, you can learn about it here.
Example:
{
"license_key": "YOUR_LICENSE_KEY_HERE"
}
By default Platform plugins will have their logging turned on; however, you can manage 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.
Example:
{
"license_key": "YOUR_LICENSE_KEY_HERE"
"log_level": "info",
"log_file_path": "/var/logs/newrelic"
}
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
}
Plugin support and troubleshooting assistance can be obtained by visiting here