Unix monitoring integration

The Unix monitoring integration allows for system-level monitoring of Unix-based servers, such as AIX, Linux, macOS, and Solaris/SunOS, and reports data to New Relic.

Install the integration

Follow the steps below to install the integration:

Integration configuration settings

The following sections explain all the configuration settings available:

Global settings

• OS (default: auto): Used to determine which commands to run and how to parse them. Leave set to auto to have the plugin figure that out (which normally works).
• account_id: New Relic account ID. The 6 or 7 digit number in the URL when you're logged into the account of your choosing.
• fedramp: A true or false string to indicate that the target is the New Relic Fedramp-authorized endpoint.
• insights_insert_key (under insights): You must create an Insights Insert key, as described here.
• insights_data_center (under insights, default: us): If using the NR EU data center for your account, please change this to eu or EU. Otherwise, you can leave this alone or omit this setting entirely.

Agent settings

These settings are found in the agents object of your config file.

• name: If set to auto, the plugin will use that server's hostname. Otherwise, sets the hostname and agentName to whatever is set here.
• static (optional): An object containing static attributes (as name-value pairs) you want to appear in every event from this plugin. For example:

"agents": [
    {
      "name": "auto",
      "static": {
        "data_center": "Antartica",
        "customer": "Penguins",
        "rank": 1
      }
    }
  ]

Proxy settings

If using a proxy, the optional proxy object should be added to the global object in plugin.json.

• The available attributes are: proxy_host, proxy_port, proxy_username and proxy_password.
• The only attribute that is required in the proxy object is proxy_host.

Credential obfuscation

For additional security, this integration supports obfuscated values for the attributes like insights_insert_key, proxy_username, proxy_password, and any other attributes under the parent attribute 'agents'. To do so, append _obfuscated to the attribute name and provide an obfuscated value that was produced by the New Relic CLI:

1. Install the New Relic CLI on any supported platform. It doesn't need to be installed on the same host as the Unix integration. It is only used to generate the obfuscated keys, this integration handles deobfuscation independently.

2. Generate your obfuscated credentials using the following CLI command:

   newrelic agent config obfuscate --key "OBSCURING_KEY" --value "CLEAR_TEXT_PROXY_PASSWORD"

   Copy

   In this command, OBSCURING_KEY can be any value you want. You can point it at an existing environment variable:

   newrelic agent config obfuscate --key "YOUR_RANDOM_KEY!" --value "YOUR_PROXY_PASSWORD!"
   newrelic agent config obfuscate --key ${NEW_RELIC_CONFIG_OBSCURING_KEY} --value ${OUR_PROXY_PASSWORD}

   Copy

3. In the proxy object in plugin.json, populate the proxy_username_obfuscated and proxy_password_obfuscated attributes with the values returned by the CLI.

4. In pluginctl.sh, uncomment the NEW_RELIC_CONFIG_OBSCURING_KEY variable, and set it to the same value or envrionment variable as you used in step 2 for OBSCURING_KEY.