puppet-newrelic

Table of Contents

1. Overview - What is the puppet-newrelic module?
2. Module Description - What does the module do?
3. Setup - The basics of getting started with puppet-newrelic
   • What puppet-newrelic affects
   • Beginning with puppet-newrelic
4. Usage - Configuration options and additional functionality
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Overview

This module manages and installs the New Relic Server Monitoring and PHP agents and is based on Felipe Salum's puppet-newrelic module.

Puppet 3 Support

On 31st December 2016, support for Puppet 3.x was withdrawn. As as a result, this module does not support Puppet 3.

Module Description

Setup

What puppet-newrelic affects

• Adds the upstream NewRelic Yum/Apt repositories
• Installs the NewRelic Server/Infrastructure agent and also the PHP or .NET agents

Beginning with puppet-newrelic

By default, the module installs and configures the NewRelic Infrastructure agent.

Usage

To install the (deprecated) NewRelic Server Monitoring agent instead of the default NewRelic Infrastructure agent:

class { '::newrelic':
  license_key   => 'your key here',
  enable_infra  => false,
  enable_server => true,
}

To enable the PHP agent with default configuration:

class { '::newrelic':
  license_key      => 'your key here',
  enable_php_agent => true,
}

Further PHP agent configuration in Hiera:

 newrelic::agent::php::ini_settings:
   appname: 'ACME PHP Application'
   daemon.loglevel: 'error'

Advanced Usage Examples

The below examples show how to integrate the NewRelic PHP agent with the most common web-servers, with automatic service restarts.

Apache and mod_php

Assumes usage of the Puppet Apache module.

class { '::apache': }
class { '::apache::mod::php': }

class { '::newrelic::agent::php':
  license_key  => 'your key',
  require      => Class['::apache::mod::php'],
  notify       => Service['httpd'],
}

PHP-FPM

Assumes usage of the Slashbunny PHP-FPM module.

class { '::phpfpm':
    poold_purge => true,
}

::phpfpm::pool { 'main': }

class { '::newrelic::agent::php':
  license_key  => '3522b44f4c3f89c8566d5781bac6e0bb7dedab7z',
  require      => Class['::phpfpm'],
  notify       => Class['::phpfpm::service'],
}

Limitations

• When moving from NewRelic Server to NewRelic Infrastructure - the module only installs the new client, and does not clean up the old one

Windows Support

Please note that Windows support is currently untested.

Supported Operating Systems

• Debian/Ubuntu
• CentOS/RHEL

Development

• Copyright (C) 2012 Felipe Salum fsalum@gmail.com
• Copyright (C) 2017 Claranet
• Distributed under the terms of the Apache License v2.0 - see LICENSE file for details.