newrelic-infra Cookbook

This cookbook installs and configures the New Relic Infrastructure agent as well as new Relic provided and custom on-host integrations for the Infrastructure agent can be installed.
See the [CHANGELOG][11] for information on the latest changes.

Requirements

Platforms

• Amazon Linux all versions
• CentOS version 6 or higher
• Debian version 7 ("Wheezy") or higher
• Red Hat Enterprise Linux (RHEL) version 6 or higher
• Ubuntu versions 12.04., 14.04., and 16.04.* (LTS versions)
• Windows Server 2008, 2012, and 2016 and their service packs.

Chef

• Chef 12.15+

Cookbooks

• poise-service
• poise-archive

Recipes

newrelic-infra::default

Determines the platform and includes the appropriate platform specific recipe.
This is the only recipe that should be included in a node's run list.

newrelic-infra::agent_linux

Installs and configures the Infrastructure agent on a Linux host.
This recipe should NOT be directly included in a node's run list.
The default recipe will automatically determine which platform specific recipe to apply.

1. Adds the newrelic-infra package repository source
2. Can install, upgrade, or remove the newrelic-infra package. By default, the package is only installed.
3. Enables and starts the newrelic_infra agent service
4. Generates the agent configuration file
5. Includes the newrelic-infra::host_integrations recipe to install and configure any on-host integrations

newrelic-infra::agent_windows

Installs and configures the Infrastructure agent on a Windows host.
This recipe should NOT be directly included in a node's run list.
The default recipe will automatically determine which platform specific recipe to apply.

newrelic-infra::host_integrations

Installs New Relic provided and custom on-host integrations if the associated feature flag is enabled (i.e., default['newrelic_infra']['features]['host_integrations']).
Generates configuration for any of the available on-host integrations from New Relic.
Installs any custom integrations defined with attributes.
For more infromation on the available custom resource for installing and configuring custom on-host integrations see the Custom resources documentation.

Example configuration for a custom on-host integration installed and configured via attributes:

default['newrelic_infra']['custom_integrations']['test_integration'] = {
  integration_name: 'com.test.integration',
  remote_url: 'https://url-to-a-tarball-for-install.com/test.tar.gz',
  instances: [
    {
      name: 'test_integration_metrics',
      command: 'metrics',
      arguments: {
        test: true
      },
      labels: {
        environment: 'test'
      }
    }
  ],
  commands: {
    metrics: %w[--metrics]
  }
}

For more information on the available New Relic on-host integrations and configuration see:

1. Cassandra
2. MySQL
3. Nginx

Attributes

See [attributes/defaults.rb][3] for more details and default values.

APT repository attributes

The apt_repository Chef resource is built using metaprogramming, so that the configuration can be extended via attributes.
Any property available to the resource can be passed in via attributes.
Attributes that cannot be passed to the resource are logged out as warnings in order to prevent potential failes from typos, older Chef versions, etc.
For more information, refer to the Chef documentation on the apt_repository resource.

Windows attributes

When using Windows, you can set a source URL and checksum for the agent download.

Yum repository attributes

The yum_repository Chef resource is built using metaprogramming, so that the configuration can be extended via attributes.
Any property available to the resource can be passed in via attributes.
Attributes that cannot be passed to the resource are logged out as warnings in order to prevent potential failes from typos, older Chef versions, etc.
For more information, refer to the Chef documentation on the yum_repository resource.

Custom Resources

newrelic_infra_integration

Installs and configures a custom New Relic Infrastructure on-host integration.

Example:

newrelic_infra_integration 'test' do
  integration_name 'test_integration'
  remote_url 'https://url-to-a-tarball-for-install.com/test.tar.gz'
  commands { metrics: %w[--metrics] }
  instances(
    [
      {
        name: 'test_integration_metrics',
        command: 'metrics',
        arguments: {
          test: true
        },
        labels: {
          environment: 'test'
        }
      }
    ]
  )
end

Supported properties:

Usage

Cookbook usage

• Set any attributes necessary for your desired configuration
• Add the newrelic-infra::default recipe your run list
• For wrapper cookbooks, add the newrelic-infra cookbook as a dependency to your metadata.rb or Berksfile, then include newrelic-infra::default recipe.

Custom resource usage

• Add the newrelic-infra cookbook as a dependency to your metadata.rb or Berksfile
• Configure the custom resource(s) using the supported properties

Testing

See [CONTRIBUTING.md][10] for details on how to test and contribute to this cookbook.

Copyright (c) 2016-2017 New Relic, Inc. All rights reserved.