From ea16b4506c00f0446d51f2c7b508f4f5617649ab Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 20 Dec 2023 15:26:23 -0800 Subject: [PATCH] Update config doc opening This updates outdated content in the ERB template that generates the config documentation. --- lib/tasks/helpers/config.html.erb | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/tasks/helpers/config.html.erb b/lib/tasks/helpers/config.html.erb index 891486c403..a4d59c4af5 100644 --- a/lib/tasks/helpers/config.html.erb +++ b/lib/tasks/helpers/config.html.erb @@ -14,7 +14,7 @@ redirects: This file is automatically generated from values defined in `lib/new_relic/agent/configuration/default_source.rb`. - All changes should be made directly to `default_source.rb.` + Make all changes directly to `default_source.rb.` Submit PRs or raise issues at: https://github.com/newrelic/newrelic-ruby-agent @@ -42,9 +42,9 @@ In other words, environment variables override all other configuration settings ## View and edit config file options [#Edit] -The Ruby agent's `newrelic.yml` is a standard YAML configuration file. It typically includes a `Defaults` section at the top, plus sections below for each application environment; for example, `Development`, `Testing`, and `Production`. +The Ruby agent's `newrelic.yml` is a standard YAML configuration file. It typically includes a `Defaults` section at the top, plus sections below for each application environment (for example, `Development`, `Staging`, and `Production`). -The Ruby agent determines which section of the `newrelic.yml` config file to read from by looking at certain environment variables to derive the application's environment. This can be useful, for example, when you want to use `info` for the `log_level` config setting in your production environment, and you want more verbose `log_level` config settings (such as `debug` in your development environment. +The Ruby agent determines which section of the `newrelic.yml` config file to read from by looking at certain environment variables to derive the application's environment. This can be useful when you want to use `info` for the `log_level` config setting in your production environment, and you want more verbose `log_level` config settings (such as `debug`) in your development environment. Here is an example `newrelic.yml` config file: @@ -60,7 +60,7 @@ development: log_level: debug ``` -For non-Rails apps, the Ruby agent looks for the following environment variables, in this order, to determine the application environment: +The Ruby agent looks for the following environment variables, in this order, to find the application environment: 1. `NEW_RELIC_ENV` 2. `RUBY_ENV` @@ -68,9 +68,9 @@ For non-Rails apps, the Ruby agent looks for the following environment variables 4. `APP_ENV` 5. `RACK_ENV` -If the Ruby agent does not detect values for any of those environment variables, it will default the application environment to `development` and read from the `development` section of the `newrelic.yml` config file. +If the Ruby agent doesn't detect values for any of those environment variables, it will default the application environment to `development` and read from the `development` section of the `newrelic.yml` config file. -When running the Ruby agent in a Rails app, the agent first looks for the `NEW_RELIC_ENV` environment variable to determine the application environment and which section of the `newrelic.yml` to use. If `NEW_RELIC_ENV` is not present, the agent uses the Rails environment (`RAILS_ENV` or `RAILS.env`, depending on the version of Rails) . +When running the Ruby agent in a Rails app, the agent first looks for the `NEW_RELIC_ENV` environment variable to determine the application environment and which section of the `newrelic.yml` to use. If `NEW_RELIC_ENV` is not present, the agent uses the Rails environment (`RAILS_ENV`). When you edit the config file, be sure to: