Description

This cookbook provides an easy way to install various New Relic agents and the New Relic server monitor.

More information?
* https://docs.newrelic.com/docs/server/new-relic-for-server-monitoring
* https://docs.newrelic.com/docs/php/new-relic-for-php
* https://docs.newrelic.com/docs/python/new-relic-for-python
* https://docs.newrelic.com/docs/dotnet/new-relic-for-net
* https://docs.newrelic.com/docs/java/new-relic-for-java
* https://docs.newrelic.com/docs/nodejs/installing-and-maintaining-nodejs
* https://docs.newrelic.com/docs/ruby/new-relic-for-ruby

• https://pypi.python.org/pypi/newrelic-plugin-agent
• https://github.com/MeetMe/newrelic-plugin-agent#installation-instructions

Requirements

Chef version:

Make sure you run Chef >= 0.10.0.

Cookbooks:

• python

This cookbook recommends on the following cookbooks:

• php
• ms_dotnet4
• nodejs
• curl

Depending on your environment, these recommended cookbooks are actual dependencies (depends):

• Installing the PHP agent? You'll need the php cookbook to be available.
• Installing the DotNet agent? You'll need the ms_dotnet4 cookbook to be available.
• Installing the Nodejs agent? You'll need the nodejs cookbook to be available.

• Installing the MeetMe plugin? You'll need the python cookbook to be available.

• Making use of the deployment LWRP? You'll need the curl cookbook to be available.

Platforms:

• Debian
• Ubuntu
• RHEL
• CentOS
• Fedora
• Scientific
• Amazon
• Windows
• SmartOS

Attributes

default.rb:

BASIC

• node['newrelic']['license'] - Your New Relic license key. Default is nil
• node['newrelic']['server_monitoring']['license'] - Your New Relic license key for server monitoring purposes (defaults to value of node['newrelic']['license'])
• node['newrelic']['application_monitoring']['license'] - Your New Relic license key for application monitoring purposes (defaults to value of node['newrelic']['license'])
• node['newrelic']['plugin_monitoring']['license'] - Your New Relic license key for plugin purposes (defaults to value of node['newrelic']['license'])

ADVANCED

• node['newrelic']['server_monitoring']['logfile']
• node['newrelic']['server_monitoring']['loglevel']
• node['newrelic']['server_monitoring']['proxy']
• node['newrelic']['server_monitoring']['ssl']
• node['newrelic']['server_monitoring']['ssl_ca_bundle']
• node['newrelic']['server_monitoring']['ssl_ca_path']
• node['newrelic']['server_monitoring']['hostname']
• node['newrelic']['server_monitoring']['pidfile']
• node['newrelic']['server_monitoring']['collector_host']

• node['newrelic']['server_monitoring']['timeout']

• node['newrelic']['application_monitoring']['enabled']

• node['newrelic']['application_monitoring']['logfile']

• node['newrelic']['application_monitoring']['logfile_path']

• node['newrelic']['application_monitoring']['loglevel']

• node['newrelic']['application_monitoring']['appname']

• node['newrelic']['application_monitoring']['daemon']['logfile']

• node['newrelic']['application_monitoring']['daemon']['loglevel']

• node['newrelic']['application_monitoring']['daemon']['port']

• node['newrelic']['application_monitoring']['daemon']['max_threads']

• node['newrelic']['application_monitoring']['daemon']['ssl']

• node['newrelic']['application_monitoring']['daemon']['ssl_ca_path']

• node['newrelic']['application_monitoring']['daemon']['ssl_ca_bundle']

• node['newrelic']['application_monitoring']['daemon']['proxy']

• node['newrelic']['application_monitoring']['daemon']['pidfile']

• node['newrelic']['application_monitoring']['daemon']['location']

• node['newrelic']['application_monitoring']['daemon']['collector_host']

• node['newrelic']['application_monitoring']['daemon']['dont_launch']

• node['newrelic']['application_monitoring']['capture_params']

• node['newrelic']['application_monitoring']['ignored_params']

• node['newrelic']['application_monitoring']['error_collector']['enable']

• node['newrelic']['application_monitoring']['error_collector']['record_database_errors']

• node['newrelic']['application_monitoring']['error_collector']['prioritize_api_errors']

• node['newrelic']['application_monitoring']['browser_monitoring']['auto_instrument']

• node['newrelic']['application_monitoring']['transaction_tracer']['enable']

• node['newrelic']['application_monitoring']['transaction_tracer']['threshold']

• node['newrelic']['application_monitoring']['transaction_tracer']['detail']

• node['newrelic']['application_monitoring']['transaction_tracer']['slow_sql']

• node['newrelic']['application_monitoring']['transaction_tracer']['stack_trace_threshold']

• node['newrelic']['application_monitoring']['transaction_tracer']['explain_threshold']

• node['newrelic']['application_monitoring']['transaction_tracer']['record_sql']

• node['newrelic']['application_monitoring']['transaction_tracer']['custom']

• node['newrelic']['application_monitoring']['framework']

• node['newrelic']['application_monitoring']['webtransaction']['name']['remove_trailing_path']

• node['newrelic']['application_monitoring']['webtransaction']['name']['functions']

• node['newrelic']['application_monitoring']['webtransaction']['name']['files']

• node['newrelic']['application_monitoring']['cross_application_tracer']['enable'] - Implemented for Java, PHP, Python and Ruby

repository.rb:

• node['newrelic']['repository']['repository_key'] - The New Relic repository key, defaults to "548C16BF"

php-agent.rb:

• node['newrelic']['php-agent']['install_silently'] - Determine whether to run the install in silent mode, defaults to false
• node['newrelic']['php-agent']['startup_mode'] - The newrelic-daemon startup mode ("agent"/"external"), defaults to "agent"
• node['newrelic']['php-agent']['web_server']['service_name'] - The web server service name, defaults to "apache2"
• node['newrelic']['php-agent']['php_recipe'] - The php recipe to include for the php agent, defaults to "php::default"
• node['newrelic']['php-agent']['config_file'] - The New Relic php agent config file, defaults to "#{node['php']['ext_conf_dir']}/newrelic.ini" (FYI: Opscode PHP cookbook's ext_conf_dir)

python-agent.rb:

• node['newrelic']['python-agent']['python_version'] - Defaults to "latest". Version numbers can be found at http://download.newrelic.com/python_agent/release/
• node['newrelic']['python-agent']['python_recipe'] - The python recipe to include for the python agent, defaults to "python::pip"
• node['newrelic']['python-agent']['config_file'] - The New Relic python agent config file, defaults to "/etc/newrelic/newrelic.ini"

dotnet-agent.rb:

• node['newrelic']['dotnet-agent']['https_download'] - The URL to download the MSI installer from New Relic. Default is to pull "latest"
• node['newrelic']['dotnet-agent']['install_level'] - The install version of the .NET Agent. Default is '1' but can use '50' for a complete installation
• node['newrelic']['dotnet-agent']['dotnet_recipe'] - The dotnet recipe to include for the php agent, defaults to "ms_dotnet4"

server-monitor-agent.rb:

• node['newrelic']['server-monitor-agent']['service_name'] - The New Relic server monitoring service name, defaults to "newrelic-sysmond"
• node['newrelic']['server-monitor-agent']['service_notify_action'] - The New Relic server monitoring notify action, defaults to ":restart"
• node['newrelic']['server-monitor-agent']['service_actions'] - The New Relic server monitoring service actions, defaults to "[:enable, :start]" (#starts the service if it's not running and enables it to start at system boot time)
• node['newrelic']['server-monitor-agent']['config_path'] - The New Relic server monitoring config path, defaults to "/etc/newrelic"
• node['newrelic']['server-monitor-agent']['config_file_group'] - The New Relic server monitoring config file group, defaults to "newrelic"
• node['newrelic']['server-monitor-agent']['windows_version'] - the Windows version to install, defaults to "2.0.0.198"
• node['newrelic']['server-monitor-agent']['windows64_checksum'] - checksum of the 64-bit Windows version, defaults to "5a8f3f5e8f15997463430401756d377c321c8899c2790ca85e5587a5b643651e"
• node['newrelic']['server-monitor-agent']['windows32_checksum'] - checksum of the 32-bit Windows version, defaults to "ac2b65eecaad461fdd2e4386e3e4c9f96ea940b35bdf7a8c532c21dbd1c99ff0"

java-agent.rb:

• node['newrelic']['java-agent']['https_download'] - The url to download the jar vor the New Relic Java agent
• node['newrelic']['java-agent']['jar_file'] - The name of the newrelic jar file
• node['newrelic']['java-agent']['install_dir'] - The directory to install the newrelic jar and config file
• node['newrelic']['java-agent']['app_user'] - The user that runs the Java application that will use the New Relic Java agent
• node['newrelic']['java-agent']['app_group'] - The group for the app_user
• node['newrelic']['java-agent']['audit_mode'] - Boolean, log all data to and from New Relic in plain text
• node['newrelic']['java-agent']['log_file_count'] - The number of log files to use
• node['newrelic']['java-agent']['log_limit_in_kbytes'] - The maximum number of bytes to write to any one log file
• node['newrelic']['java-agent']['log_daily'] - Override other log rolling configuration and roll the logs daily
• node['newrelic']['java-agent']['execute_install'] - Execute install or not, defaults to true

nodejs-agent.rb

• node['newrelic']['nodejs-agent']['apps'] - Array of Hash describing the apps to monitor

eg.

[
{ 'app_name' => 'My Application', 'app_path' => "/path/to/app/root" }
]


You then need to modify your application "main" file to add the following on the first line:

javascript
require('newrelic');

• node['newrelic']['nodejs-agent']['nodejs_recipe'] - The nodejs recipe to include for the nodejs agent, defaults to "nodejs::npm"

ruby-agent.rb:

• node['newrelic']['ruby-agent']['install_dir'] - The directory to for the config file
• node['newrelic']['ruby-agent']['app_user'] - The user that runs the Ruby application that will use the New Relic Ruby agent
• node['newrelic']['ruby-agent']['app_group'] - The group for the app_user
• node['newrelic']['ruby-agent']['audit_mode'] - Boolean, log all data to and from New Relic in plain text
• node['newrelic']['ruby-agent']['log_file_count'] - The number of log files to use
• node['newrelic']['ruby-agent']['log_limit_in_kbytes'] - The maximum number of bytes to write to any one log file
• node['newrelic']['ruby-agent']['log_daily'] - Override other log rolling configuration and roll the logs daily

meetme-plugin.rb:

• node['newrelic']['meetme-plugin']['service_name'] - The New Relic MeetMe plugin service name, defaults to "newrelic-plugin-agent"
• node['newrelic']['meetme-plugin']['services'] - A hash of New Relic MeetMe plugin services, defaults to nil

eg.

{
"memcached" => {
"name" => "localhost",
"host" => "host",
"port" => 11211
},
"redis" => [
{
"name" => "localhost",
"host" => "localhost",
"port" => 6379,
"db_count" => 16,
"password" => "foobar"
},
{
"name" => "localhost",
"host" => "localhost",
"port" => 6380,
"db_count" => 16,
"password" => "foobar"
}
]
}


• node['newrelic']['meetme-plugin']['wake_interval'] - The New Relic plugin agent wake interval, defaults to 60
• node['newrelic']['meetme-plugin']['config_file'] - The New Relic plugin agent config file, defaults to "/etc/newrelic/newrelic-plugin-agent.cfg"
• node['newrelic']['meetme-plugin']['pid_file'] - The New Relic plugin agent PID file name, defaults to "/var/run/newrelic/newrelic-plugin-agent.pid"
• node['newrelic']['meetme-plugin']['log_file'] - The New Relic plugin agent log file name, defaults to "/var/log/newrelic/newrelic-plugin-agent.log"
• node['newrelic']['meetme-plugin']['user'] - The New Relic plugin agent user, defaults to "newrelic"
• node['newrelic']['meetme-plugin']['additional_requirements'] - The New Relic plugin agent's additional requirements, eg. {"mongodb", "pgbouncer", "postgresql"} - defaults to {}

Resources / Providers

This cookbook includes an LWRP for notifying New Relic of a deployment

newrelic_deployment

Actions

• :notify: Notify New Relic of a deployment

Attribute parameters

• api_key: Your New Relic API key
• app_name: The name of the application, found in the newrelic.yml file
• app_id: The ID # of the application
• description: Text annotation for the deployment (notes for you)
• revision: The revision number from your source control system (SVN, git, etc.)
• changelog: A list of changes for this deployment
• user: The name of the user/process that triggered this deployment

Examples

newrelic_deployment "my-application" do
    api_key "abcdef"
    #app_name "my-application"
    app_id 1234567
    description "some description"
    revision "some revision"
    changelog "some changelog"
    user "chef-client"
    action :notify
end

Usage

1)
include recipe[newrelic] in a run list to implicly run recipe[newrelic:repository] and recipe[newrelic::server-monitor-agent]
--- OR ---
include the bits and pieces explicitly in a run list:
ruby
`recipe[newrelic::repository]`
`recipe[newrelic::server-monitor-agent]`
`recipe[newrelic::dotnet-agent]`
`recipe[newrelic::java-agent]`
`recipe[newrelic::meetme-plugin]`
`recipe[newrelic::nodejs-agent]`
`recipe[newrelic::php-agent]`
`recipe[newrelic::python-agent]`
`recipe[newrelic::ruby-agent]`


2)
change the node['newrelic']['license'] attribute to your New Relic license keys
--- OR ---
override the attributes on a higher level (http://wiki.opscode.com/display/chef/Attributes#Attributes-AttributesPrecedence)

References

• New Relic home page
• New Relic for Server Monitoring
• New Relic for PHP
• newrelic-daemon startup modes
• New Relic for Python
• New Relic for .NET
• New Relic for Java
• "newrelic" cookbook by heavywater on github
• "newrelic_monitoring" cookbook on community.opscode.com
• "newrelic_monitoring" cookbook on github
• a very big thanks to heavywater darrin@heavywater.ca for the original version of this cookbook

License and Authors

Author: David Joos david.joos@escapestudios.com
Author: Escape Studios Development dev@escapestudios.com
Copyright: 2012-2014, Escape Studios

Unless otherwise noted, all files are released under the MIT license,
possible exceptions will contain licensing information in them.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.