Java plugin installation example

This is an example installation using the New Relic Wikipedia plugin, which was built with the Java SDK for New Relic Plugins. The Wikipedia example plugin contains a zip file containing:

  • A configuration folder with a properties file (for your New Relic license key) and a config file
  • A jar file with JSON components for the metrics that appear on the plugin's dashboard

Plugins is not supported with accounts that host data in the EU region data center.

Typical Java plugin requirements

Requirements for the Wikipedia plugin are:

  • New Relic account
  • Java Runtime Environment (JRE) 1.6 or higher
  • Git >= 1.8

Wikipedia plugin installation

This example refers to installing a Wikipedia example plugin.

Note: The Wikipedia example plugin may not visible in Plugin Central, as it is a "hidden" plugin that installs when you run the agent. You can also use any other plugin built with the Java SDK.

  1. Download the Wikipedia plugin from Github.
  2. Once downloaded, extract the archive file into the location where you want to run the agent.
  3. From the config directory, copy the template_newrelic.properties file to newrelic.properties.
  4. Edit this file and replace the string YOUR_LICENSE_KEY_HERE with the license key from your New Relic account.
  5. From your shell, run the following command to start the agent:
    java -jar newrelic_wikipedia_plugin*.jar

Wikipedia plugin dashboard

To view plugin data, go to your New Relic Plugins menu bar, where you can select the plugin and view it directly.

  1. Sign in to New Relic.
  2. From the New Relic Plugins menu bar, select the Wikipedia plugin's menu name or icon.
  3. To view the plugin's default dashboard: From the plugin's summary page, select any component (instance).

You may need to wait a few minutes for data to appear.

For more help

Additional documentation resources include:

Recommendations for learning more: