Following 32ac4ff55f2e174718fad97fcbd57b50a3daef7b, add some brief documentation about newrelic.yml-example, and switch off all monitoring by default. I don't think we want to get into the situation where a new install has monitoring running but doesn't know.

3 files changed, 34 insertions, 27 deletions

diff --git a/config/.gitignore b/config/.gitignore
index 78d586ea8..5ad2de008 100644
--- a/config/.gitignore
+++ b/config/.gitignore
@@ -7,3 +7,4 @@ logrotate
 memcached.yml
 *.deployed
 deploy.yml
+newrelic.yml
diff --git a/config/newrelic.yml-example b/config/newrelic.yml-example
index 8da7e26bd..ce19cca54 100644
--- a/config/newrelic.yml-example
+++ b/config/newrelic.yml-example
@@ -15,7 +15,7 @@ common: &default_settings
   # account.  This key binds your Agent's data to your account in the
   # New Relic service.
   #license_key: ''
-  
+
   # Agent Enabled (Ruby/Rails Only)
   # Use this setting to force the agent to run or not run.
   # Default is 'auto' which means the agent will install and run only
@@ -23,21 +23,21 @@ common: &default_settings
   # it from running with Rake or the console.  Set to false to
   # completely turn the agent off regardless of the other settings.
   # Valid values are true, false and auto.
-  # agent_enabled: auto
-  
+  agent_enabled: false
+
   # Application Name
   # Set this to be the name of your application as you'd like it show
   # up in New Relic.  New Relic will then auto-map instances of your application
   # into a New Relic "application" on your home dashboard page. If you want
   # to map this instance into multiple apps, like "AJAX Requests" and
   # "All UI" then specify a semicolon-separated list of up to three
-  # distinct names.  If you comment this out, it defaults to the 
+  # distinct names.  If you comment this out, it defaults to the
   # capitalized RAILS_ENV (i.e., Production, Staging, etc)
   app_name: My Application
 
-  # When "true", the agent collects performance data about your 
+  # When "true", the agent collects performance data about your
   # application and reports this data to the New Relic service at
-  # newrelic.com. This global switch is normally overridden for each 
+  # newrelic.com. This global switch is normally overridden for each
   # environment below. (formerly called 'enabled')
   monitor_mode: true
 
@@ -49,7 +49,7 @@ common: &default_settings
   # information separate from that of your application.  Specify its
   # log level here.
   log_level: info
-  
+
   # The newrelic agent communicates with the New Relic service via http by
   # default.  If you want to communicate via https to increase
   # security, then turn on SSL by setting this value to true.  Note,
@@ -86,7 +86,7 @@ common: &default_settings
   # Rails: the RoR filter_parameter_logging excludes parameters
   # Java: create a config setting called "ignored_params" and set it to
   #     a comma separated list of HTTP parameter names.
-  #     ex: ignored_params: credit_card, ssn, password 
+  #     ex: ignored_params: credit_card, ssn, password
   capture_params: false
 
   # Transaction tracer captures deep information about slow
@@ -94,12 +94,12 @@ common: &default_settings
   # minute. Included in the transaction is the exact call sequence of
   # the transactions including any SQL statements issued.
   transaction_tracer:
-  
+
     # Transaction tracer is enabled by default. Set this to false to
     # turn it off. This feature is only available at the Professional
     # product level.
     enabled: true
-    
+
     # Threshold in seconds for when to collect a transaction
     # trace. When the response time of a controller action exceeds
     # this threshold, a transaction trace will be recorded and sent to
@@ -107,13 +107,13 @@ common: &default_settings
     # which will use the threshold for an dissatisfying Apdex
     # controller action - four times the Apdex T value.
     transaction_threshold: apdex_f
- 
+
     # When transaction tracer is on, SQL statements can optionally be
     # recorded. The recorder has three modes, "off" which sends no
     # SQL, "raw" which sends the SQL statement in its original form,
     # and "obfuscated", which strips out numeric and string literals.
     record_sql: obfuscated
-    
+
     # Threshold in seconds for when to collect stack trace for a SQL
     # call. In other words, when SQL statements exceed this threshold,
     # then capture and send to New Relic the current stack trace. This is
@@ -125,24 +125,24 @@ common: &default_settings
     # set to false when using other adapters.
     # explain_enabled: true
 
-    # Threshold for query execution time below which query plans will not 
+    # Threshold for query execution time below which query plans will not
     # not be captured.  Relevant only when `explain_enabled` is true.
     # explain_threshold: 0.5
-  
+
   # Error collector captures information about uncaught exceptions and
   # sends them to New Relic for viewing
   error_collector:
-    
+
     # Error collector is enabled by default. Set this to false to turn
     # it off. This feature is only available at the Professional
     # product level.
     enabled: true
-    
-    # Rails Only - tells error collector whether or not to capture a 
-    # source snippet around the place of the error when errors are View 
+
+    # Rails Only - tells error collector whether or not to capture a
+    # source snippet around the place of the error when errors are View
     # related.
-    capture_source: true    
-    
+    capture_source: true
+
     # To stop specific errors from reporting to New Relic, set this property
     # to comma-separated values.  Default is to ignore routing errors,
     # which are how 404's get triggered.
@@ -152,7 +152,7 @@ common: &default_settings
   # won't run.  Useful when you are using the agent to monitor an
   # external resource
   # disable_samplers: true
-  
+
   # If you aren't interested in visibility in these areas, you can
   # disable the instrumentation to reduce overhead.
   #
@@ -160,8 +160,8 @@ common: &default_settings
   # disable_activerecord_instrumentation: true
   # disable_memcache_instrumentation: true
   # disable_dj: true
-  
-  # Certain types of instrumentation such as GC stats will not work if 
+
+  # Certain types of instrumentation such as GC stats will not work if
   # you are running multi-threaded.  Please let us know.
   # multi_threaded = false
 
@@ -179,17 +179,17 @@ development:
   <<: *default_settings
   # Turn off communication to New Relic service in development mode (also
   # 'enabled').
-  # NOTE: for initial evaluation purposes, you may want to temporarily 
+  # NOTE: for initial evaluation purposes, you may want to temporarily
   # turn agent communication on in development mode.
   monitor_mode: false
 
-  # Rails Only - when running in Developer Mode, the New Relic Agent will 
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
   # present performance information on the last 100 transactions you have
   # executed since starting the app server.
   # NOTE: There is substantial overhead when running in developer mode.
-  # Do not use for production or load testing.  
+  # Do not use for production or load testing.
   developer_mode: true
-  
+
   # Enable textmate links
   # textmate: true
 
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index b805ee0c5..e36d10e2b 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -222,6 +222,12 @@ Interlock Rails plugin, to cache content using memcached.  You
 probably don't want this in your development profile; the example
 `memcached.yml` file disables this behaviour.
 
+Finally, copy `config/newrelic.yml-example` to `config/newrelic.yml`.
+This file contains configuration information for the New Relic
+performance management system. By default, monitoring is switched off
+by the `agent_enabled: false` setting. See https://github.com/newrelic/rpm
+for instructions on switching on local and remote performance analysis.
+
 # Deployment
 
 In the 'alaveteli' directory, run: