This cookbook provides an easy way to install various New Relic agents and the New Relic server monitor.
The agent installs are being converted into libraries, currently the following agents are now resources:
- server_monitor
- php_agent
- java_agent
- ruby_agent
- python_agent
- nodejs_agent
- dotnet_agent
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
Make sure you run Chef >= 0.10.0.
- python
- curl
- apt
- yum
- Debian
- Ubuntu
- RHEL
- CentOS
- Fedora
- Scientific
- Amazon
- Windows
- SmartOS
- Oracle
node['newrelic']['license']
- Your New Relic license key. Default isnil
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']['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']['labels']
-
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']['app_name']
-
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']['ignore_errors']
-
node['newrelic']['application_monitoring']['error_collector']['ignore_status_codes']
-
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 -
node['newrelic']['application_monitoring']['thread_profiler']['enable']
- Implemented for Java, Python and Ruby
node['newrelic']['repository']['key']
- URL to the New Relic repository key, defaults to "http://download.newrelic.com/548C16BF.gpg"
node['newrelic']['python_agent']['agent_action']
- Agent action, defaults to :installnode['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_venv']
- Virtual environment, default to nilnode['newrelic']['python_agent']['config_file']
- The New Relic python agent config file, defaults to "/etc/newrelic/newrelic.ini"node['newrelic']['python_agent']['template']['cookbook']
- Sets cookbook for template, defaults to 'newrelic'node['newrelic']['python_agent']['template']['source']
- Sets source for template, defaults to 'agent/python/newrelic.ini.erb'node['newrelic']['python_agent']['feature_flag']
- Sets feature_flag, defaults to nil
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 installationnode['newrelic']['dotnet_agent']['agent_action']
- Agent action, defaults to :install
node['newrelic']['java_agent']['version']
- New Relic Java Agent version to use. To find the current version, check New Relic reponode['newrelic']['java_agent']['install_dir']
- The directory to install the newrelic jar and config filenode['newrelic']['java_agent']['app_user']
- The user that runs the Java application that will use the New Relic Java agentnode['newrelic']['java_agent']['app_group']
- The group for the app_usernode['newrelic']['java_agent']['audit_mode']
- Boolean, log all data to and from New Relic in plain textnode['newrelic']['java_agent']['log_file_count']
- The number of log files to usenode['newrelic']['java_agent']['log_limit_in_kbytes']
- The maximum number of bytes to write to any one log filenode['newrelic']['java_agent']['log_daily']
- Override other log rolling configuration and roll the logs dailynode['newrelic']['java_agent']['agent_action']
- Agent action, defaults to :installnode['newrelic']['java_agent']['execute_agent_action']
- Execute the agent action or not, defaults to truenode['newrelic']['java_agent']['enable_custom_tracing']
- Configure New Relic to detect custom tracesnode['newrelic']['java_agent']['app_location']
- Application server's location, defaults to nilnode['newrelic']['java_agent']['template']['cookbook']
- Sets cookbook for template, defaults to 'newrelic'node['newrelic']['java_agent']['template']['source']
- Sets source for template, defaults to 'agent/newrelic.yml.erb'
node['newrelic']['nodejs_agent']['agent_action']
- Agent action, defaults to :installnode['newrelic']['nodejs_agent']['apps']
- Array of Hash describing the apps to monitor
e.g.
[
{ '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']['template']['cookbook']
- Sets cookbook for template, defaults to 'newrelic'node['newrelic']['nodejs_agent']['template']['source']
- Sets source for template, defaults to 'agent/nodejs/newrelic.js.erb'
node['newrelic']['ruby_agent']['agent_action']
- Agent action, defaults to :installnode['newrelic']['ruby_agent']['install_dir']
- The directory to for the config filenode['newrelic']['ruby_agent']['app_user']
- The user that runs the Ruby application that will use the New Relic Ruby agentnode['newrelic']['ruby_agent']['app_group']
- The group for the app_usernode['newrelic']['ruby_agent']['audit_mode']
- Boolean, log all data to and from New Relic in plain textnode['newrelic']['ruby_agent']['log_file_count']
- The number of log files to usenode['newrelic']['ruby_agent']['log_limit_in_kbytes']
- The maximum number of bytes to write to any one log filenode['newrelic']['ruby_agent']['log_daily']
- Override other log rolling configuration and roll the logs dailynode['newrelic']['ruby_agent']['template']['cookbook']
- Sets cookbook for template, defaults to 'newrelic'node['newrelic']['ruby_agent']['template']['source']
- Sets source for template, defaults to 'agent/newrelic.yml.erb'
To make sure the cookbook is focussed on getting New Relic server and application monitoring, no plugin logic is provided here. The New Relic MeetMe plugin-logic is still available, in a separate cookbook: newrelic_meetme_plugin.
This cookbook includes an LWRP for installing the server monitor agent
The newrelic_server_monitor
resource will handle the requirements to configure server monitoring.
- :install - will setup the New Relic repository, install and install package.
- :remove - Uninstall the New Relic package
'service_name'
- The New Relic server monitoring service name, defaults to "newrelic-sysmond"'service_notify_action'
- The New Relic server monitoring notify action, defaults to ":restart"'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)'config_path'
- The New Relic server monitoring config path, defaults to "/etc/newrelic"'config_file_group'
- The New Relic server monitoring config file group, defaults to "newrelic"'windows_version'
- the Windows version to install, defaults to "2.0.0.198"'windows64_checksum'
- checksum of the 64-bit Windows version, defaults to "5a8f3f5e8f15997463430401756d377c321c8899c2790ca85e5587a5b643651e"'windows32_checksum'
- checksum of the 32-bit Windows version, defaults to "ac2b65eecaad461fdd2e4386e3e4c9f96ea940b35bdf7a8c532c21dbd1c99ff0"'cookbook'
- Sets cookbook for template, defaults to 'newrelic''source'
- Sets source for template, defaults to 'agent/server_monitor/nrsysmond.cfg.erb'
'logfile'
defaults to nil'loglevel'
defaults to nil'proxy'
defaults to nil'ssl'
defaults to nil'ssl_ca_bundle'
defaults to nil'ssl_ca_path'
defaults to nil'hostname'
defaults to nil'labels'
defaults to nil'pidfile'
defaults to nil'collector_host'
defaults to nil'timeout'
defaults to nil'alert_policy_id'
default to nil
newrelic_server_monitor 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
end
This cookbook includes an LWRP for installing the php agent
The newrelic_agent_php
resource will handle the requirements to install php application monitoring.
- :install - will setup the New Relic repository, install package and update php config with license key.
- :remove - Uninstall the New Relic package
'license'
New Relic license key'api_key'
New Relic API key'install_silently'
- Determine whether to run the install in silent mode, defaults to false'app_name'
if missing it will default toPHP Application
.'startup_mode'
- The newrelic-daemon startup mode ("agent"/"external"), defaults to "agent"'service_name'
- The web server service name'service_action'
- The web server service action, defaults to "restart"'config_file'
- The New Relic php agent config file, depends on your php external configuration directory; e.g. /etc/php5/conf.d/newrelic.ini, /etc/php5/mods-available/newrelic.ini, ... Defaults to nil'config_file_to_be_deleted'
- The New Relic php agent-generated config file, e.g. /etc/php5/cli/conf.d/newrelic.ini. If set, the file will get deleted during the Chef run as we want the Chef-generated config file to be used instead ('config_file'
), defaults to nil'execute_php5enmod'
- Executes "php5enmod newrelic" if true. Needed if you use the mods-available directory, defaults to false'cookbook_ini'
- Sets cookbook for .ini template, defaults to 'newrelic''source_ini'
- Sets source for .ini template, defaults to 'agent/php/newrelic.ini.erb''cookbook'
- Sets cookbook for template, defaults to 'newrelic''source'
- Sets source for template, defaults to 'agent/php/newrelic.cfg.erb'
'enabled'
default => true'logfile'
default to nil'loglevel'
default to nil'daemon_logfile'
default to '/var/log/newrelic/newrelic-daemon.log''daemon_loglevel'
default to nil'daemon_port'
default to nil'daemon_max_threads'
default to nil'daemon_ssl'
default to true'daemon_ssl_ca_path'
default to nil'daemon_ssl_ca_bundle'
default to nil'daemon_proxy'
default to nil'daemon_pidfile'
default to nil'daemon_location'
default to nil'daemon_collector_host'
default to nil'daemon_dont_launch'
default to nil'capture_params'
default to false'ignored_params'
default to nil'error_collector_enable'
default to true'error_collector_record_database_errors'
default to true'error_collector_prioritize_api_errors'
default to false'browser_monitoring_auto_instrument'
default to true'transaction_tracer_enable'
default to true'transaction_tracer_threshold'
default to nil'transaction_tracer_detail'
default to nil'transaction_tracer_slow_sql'
default to true'transaction_tracer_stack_trace_threshold'
default to nil'transaction_tracer_explain_threshold'
default to nil'transaction_tracer_record_sql'
default to nil'transaction_tracer_custom'
default to nil'framework'
default to nil'webtransaction_name_remove_trailing_path'
default to false'webtransaction_name_functions'
default to nil'webtransaction_name_files'
default to nil'cross_application_tracer_enable'
default to true
newrelic_agent_php 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
app_name 'php_test_app'
service_name 'httpd'
config_file '/etc/php.d/newrelic.ini'
end
This cookbook includes an LWRP for installing the ruby agent
The newrelic_agent_ruby
resource will handle the requirements to install ruby application monitoring.
- :install - will setup the New Relic repository, install package and update ruby config with license key.
- :remove - Uninstall the New Relic package
'install_dir'
The directory to for the config file'app_user'
The user that runs the Ruby application that will use the New Relic Ruby agent'app_group'
The group for the app_user'audit_mode'
Boolean, log all data to and from New Relic in plain text'log_file_count'
The number of log files to use'log_limit_in_kbytes'
The maximum number of bytes to write to any one log file'log_daily'
Override other log rolling configuration and roll the logs daily'template']['cookbook'
Sets cookbook for template, defaults to 'newrelic''template']['source'
Sets source for template, defaults to 'agent/newrelic.yml.erb
'enabled'
default => true'app_name'
default => nil'high_security'
default => false'owner'
default => 'newrelic''group'
default => 'newrelic''logfile'
default => 'newrelic-daemon.log''logfile_path'
default => '/var/log/newrelic/''loglevel'
default => nil'audit_mode'
default => false- `'log_file_count, :kind_of => Fixnum, :default => 1
- `'log_limit_in_kbytes, :kind_of => Fixnum, :default => 0
'log_daily'
default => true'daemon_ssl'
default => true'daemon_proxy'
default => nil'daemon_proxy_host'
default => nil'daemon_proxy_port'
default => nil'daemon_proxy_user'
default => nil'daemon_proxy_password'
default => nil'capture_params'
default => nil'ignored_params'
default => nil'transaction_tracer_enable'
default => true'transaction_tracer_threshold'
default => nil'transaction_tracer_record_sql'
default => nil'transaction_tracer_stack_trace_threshold'
default => nil'transaction_tracer_slow_sql'
default => nil'transaction_tracer_explain_threshold'
default => nil'error_collector_enable'
default => true'error_collector_ignore_errors'
default => nil'error_collector_ignore_status_codes'
default => nil'browser_monitoring_auto_instrument'
default => nil'cross_application_tracer_enable'
default => true'thread_profiler_enable'
default => true
newrelic_agent_ruby 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
app_name 'ruby_test_app'
end
This cookbook includes an LWRP for installing the java agent
The newrelic_agent_java
resource will handle the requirements to install java application monitoring.
- :install - will retrieve Java agent, install and update config with license key.
- :remove - Uninstall the New Relic agent.
'license'
New Relic license key'version'
New Relic Java Agent version to use. To find the current version, check New Relic repo'https_download'
The url to download the jar for the New Relic Java agent. If you override version parameter, you must also update this.'jar_file'
The name of the newrelic jar file that will be used locally, defaults tonewrelic-agent-version.jar
'install_dir'
The directory to install the newrelic jar and config file'app_user'
The user that runs the Java application that will use the New Relic Java agent'app_group'
The group for the app_user'audit_mode'
Boolean, log all data to and from New Relic in plain text'log_file_count'
The number of log files to use'log_limit_in_kbytes'
The maximum number of bytes to write to any one log file'log_daily'
Override other log rolling configuration and roll the logs daily'agent_action'
Agent action, defaults to:install
'execute_agent_action'
Execute the agent action or not, defaults to true'app_location'
Application's location, defaults toinstall_dir
'template_cookbook'
Sets cookbook for template, defaults to 'newrelic''template_source'
Sets source for template, defaults toagent/newrelic.yml.erb
'enabled'
default => true'high_security'
default => false'owner'
default => 'newrelic''group'
default => 'newrelic''logfile'
default => nil'logfile_path'
default => nil'loglevel'
default => nil'audit_mode'
default => false'log_file_count'
default => nil'log_limit_in_kbytes'
default => nil'log_daily'
default => false'daemon_ssl'
default => true'daemon_proxy'
default => nil'daemon_proxy_host'
default => nil'daemon_proxy_port'
default => nil'daemon_proxy_user'
default => nil'daemon_proxy_password'
default => nil'capture_params'
default => nil'ignored_params'
default => nil'transaction_tracer_enable'
default => true'transaction_tracer_threshold'
default => nil'transaction_tracer_record_sql'
default => nil'transaction_tracer_stack_trace_threshold'
default => nil'transaction_tracer_slow_sql'
default => nil'transaction_tracer_explain_threshold'
default => nil'error_collector_enable'
default => true'error_collector_ignore_errors'
default => nil'error_collector_ignore_status_codes'
default => nil'browser_monitoring_auto_instrument'
default => nil'cross_application_tracer_enable'
default => true'thread_profiler_enable'
default => true
newrelic_agent_java 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
install_dir '/opt/newrelic/java'
app_name 'java_test_app'
This cookbook includes an LWRP for installing the newrelic python agent
The newrelic_agent_python
resource will handle the requirements to install python application monitoring.
- :install - will setup the New Relic repository, install package and update newrelic python config with license key.
- :remove - Uninstall the New Relic package
See https://docs.newrelic.com/docs/agents/python-agent/installation-configuration/python-agent-configuration#general-settings for an explanation on each attribute.
'license'
NewRelic license key'version'
Python agent version. Will default to latest if nil.'virtualenv'
VirtualEnv to install puthon agent into. Default nil.'config_file'
Path to config file. Default '/etc/newrelic/newrelic.ini''cookbook'
Cookbook holding config template. Default this cookbook.'source'
Config template source. Default 'agent/python/newrelic.ini.erb''app_name'
Your newrelic python app name as it will show in the UI. Default => 'Python Application'
'enabled'
Default true'logfile'
Default '/tmp/newrelic-python-agent.log''loglevel'
Default 'info''daemon_ssl'
Default true'high_security'
Dfault false'capture_params'
Default false'ignored_params'
Default ' ''transaction_tracer_enable'
Default true'transaction_tracer_threshold'
Default 'apdex_f''transaction_tracer_record_sql'
Default 'obfuscated''transaction_tracer_stack_trace_threshold'
Default '0.5''transaction_tracer_slow_sql'
Default true'transaction_tracer_explain_threshold'
Default '0.5''thread_profiler_enable'
Default true'error_collector_enable'
Default true'error_collector_ignore_errors'
Default ' ''browser_monitoring_auto_instrument'
Default true'cross_application_tracer_enable'
Default true'feature_flag'
Default nil
include_recipe 'python'
newrelic_agent_python 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
app_name 'my_python_app'
end
This cookbook includes an LWRP for installing the newrelic nodejs agent
The newrelic_agent_nodejs
resource will handle the requirements to install nodejs application monitoring.
- :install - will setup the New Relic repository, install npm package and update newrelic nodejs config with license key.
- :remove - Uninstall the New Relic package
https://docs.newrelic.com/docs/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration for an explanation on each attribute.
'license'
NewRelic license key'version'
NewRelic npm package version. Will default to latest if nil.'app_name'
Your newrelic nodejs app name as it will show in the UI. Default => 'My Node App''app_path'
Required true. Default nil. You must provide a valid path to your nodejs app root dir.'cookbook'
Cookbook holding config template. Default this cookbook.'source'
Config template source. Default 'agent/python/newrelic.ini.erb'
attribute :license, :kind_of => String, :required => true, :default => nil attribute :version, :kind_of => String, :default => nil attribute :app_name, :kind_of => String, :default => 'My Node App'
'enabled'
Default true'logfile'
Default '/tmp/newrelic-python-agent.log''loglevel'
Default 'info'
newrelic_agent_nodejs '/var/my_node_approot' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
app_name 'my_nodejs_app'
end
This cookbook includes an LWRP for installing the dotnet agent
The newrelic_agent_dotnet
resource will handle the requirements to install .Net application monitoring.
- :install - will retrieve .Net agent and install.
- :remove - Uninstall the New Relic agent.
'https_download'
The URL to download the MSI installer from New Relic. Default is to pull "latest"'dotnet_agent'
The install version of the .NET Agent. Default is '1' but can use '50' for a complete installation
newrelic_agent_dotnet 'Install' do
license '0000ffff0000ffff0000ffff0000ffff0000ffff'
end
This cookbook includes an LWRP for notifying New Relic of a deployment
- :notify: Notify New Relic of a deployment
'key_type'
Your New Relic API key type (api_key or license_key, defaults to api_key currently for backwards compatibility)'key'
Your New Relic key (see key_type for more information on what value to provide here exactly)'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
newrelic_deployment "my-application" do
key_type "license_key"
key "yourlicensekey"
app_id 1234567
description "some description"
revision "some revision"
changelog "some changelog"
user "chef-client"
action :notify
end
This cookbook includes an LWRP for generating the newrelic.yml configuration file in a specific path, which can be used to generate multiple configurations when deploying multiple different applications
- :generate - Generate the newrelic.yml config file (unique and default action)
- Install the Java Agent: add the newrelic::java_agent recipe to your run list. A newrelic.yml will be generated but not linked to anything.
- In your application cookbook, generate the newrelic.yml for this application:
newrelicyml="#{my_app_path}/newrelic.yml"
newrelic_yml newrelicyml do
app_name 'my-super-duper-application'
end
- Configure your app for newrelic using your config file and newrelic.jar:
java -Dnewrelic.config.file=#{newrelicyml} -javaagent:#{node['newrelic']['install_dir']}/newrelic.jar [rest of your args]
- include
recipe[newrelic]
in a run list to implicly runrecipe[newrelic::server_monitor_agent]
--- OR ---
include the bits and pieces explicitly in a run list:
`recipe[newrelic::repository]`
`recipe[newrelic::server_monitor_agent]`
`recipe[newrelic::dotnet_agent]`
`recipe[newrelic::java_agent]`
`recipe[newrelic::nodejs_agent]`
`recipe[newrelic::php_agent]`
`recipe[newrelic::python_agent]`
`recipe[newrelic::ruby_agent]`
- change the
node['newrelic']['license']
attribute to your New Relic license keys
--- OR ---
override the attributes on a higher level
- 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
Author: David Joos development@davidjoos.com Copyright: 2016, David Joos
Author: David Joos david.joos@escapestudios.com Author: Escape Studios Development dev@escapestudios.com Copyright: 2012-2015, 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.