newrelic_rpm 9.2.2 → 9.5.0

data/lib/sequel/extensions/new_relic_instrumentation.rb

@@ -27,7 +27,7 @@ module Sequel
   # If you don't want your models or database connections to be instrumented,
   # you can disable them by setting `disable_database_instrumentation` in
   # your `newrelic.yml` to `true`. It will also honor the
-  # `disable_activerecord_instrumentation` setting.
+  # `disable_active_record_instrumentation` setting.
   #
   module NewRelicInstrumentation
     module Naming

data/lib/tasks/bump_version.rake

@@ -0,0 +1,21 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'helpers/version_bump'
+
+namespace :newrelic do
+  namespace :version do
+    desc 'Returns the current version'
+    task :current do
+      puts "#{NewRelic::VERSION::STRING}"
+    end
+
+    desc 'Update version file and changelog to next version'
+    task :bump, [:format] => [] do |t, args|
+      new_version = VersionBump.update_version
+      VersionBump.update_changelog(new_version)
+      puts "New version: #{new_version}"
+    end
+  end
+end

data/lib/tasks/config.rake

@@ -21,12 +21,13 @@ namespace :newrelic do
       'transaction_tracer' => 'The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces) feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
       'error_collector' => "The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.\n\nFor information on ignored and expected errors, [see this page on Error Analytics in APM](/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected/). To set expected errors via the `NewRelic::Agent.notice_error` Ruby method, [consult the Ruby Agent API](/docs/agents/ruby-agent/api-guides/sending-handled-errors-new-relic/).",
       'browser_monitoring' => "The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process) feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.",
+      'application_logging' => "The Ruby agent supports [APM logs in context](/docs/apm/new-relic-apm/getting-started/get-started-logs-context). For some tips on configuring logs for the Ruby agent, see [Configure Ruby logs in context](/docs/logs/logs-context/configure-logs-context-ruby).\n\nAvailable logging-related config options include:",
       'analytics_events' => '[New Relic dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-new-relic-one-dashboards) is a resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
     }
 
     NAME_OVERRIDES = {
-      'slow_sql' => 'Slow SQL',
-      'custom_insights_events' => 'Custom Events'
+      'slow_sql' => 'Slow SQL [#slow-sql]',
+      'custom_insights_events' => 'Custom Events [#custom-events]'
     }
 
     desc 'Describe available New Relic configuration settings'

data/lib/tasks/helpers/config.html.erb

@@ -1,3 +1,96 @@
+---
+title: Ruby agent configuration
+tags:
+  - Agents
+  - Ruby agent
+  - Configuration
+metaDescription: 'APM for Ruby: how to configure the Ruby agent, including editing the config file and setting environment variables.'
+redirects:
+  - /docs/agents/ruby-agent/configuration/ruby-agent-configuration
+  - /docs/ruby/ruby-agent-configuration
+  - /docs/agents/ruby-agent/installation-and-configuration/ruby-agent-configuration
+  - /docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+---
+
+<CONTRIBUTOR_NOTE>
+  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.`
+  Submit PRs or raise issues at: https://github.com/newrelic/newrelic-ruby-agent
+</CONTRIBUTOR_NOTE>
+
+You can configure the New Relic Ruby agent with settings in a configuration file, environment variables, or programmatically with server-side configuration. This document summarizes the configuration options available for the Ruby agent.
+
+If the default value for a configuration option is `(Dynamic)`, this means the Ruby agent calculates the default at runtime. The value for the config setting defaults to the value of another setting as appropriate.
+
+## Configuration methods and precedence [#Options]
+
+The primary (default) method to configure the Ruby agent is via the configuration file (`newrelic.yml`) in the `config` subdirectory. To set configuration values using environment variables:
+
+1. Add the prefix `NEW_RELIC_` to the setting's name.
+2. Replace any periods `.` with underscores `_`.
+
+You can also configure a few values in the UI via [server-side configuration](/docs/agents/manage-apm-agents/configuration/server-side-agent-configuration).
+
+The Ruby agent follows this order of precedence for configuration:
+
+1. Environment variables
+2. Server-side configuration
+3. Configuration file (`newrelic.yml`)
+4. Default configuration settings
+
+In other words, environment variables override all other configuration settings and info, server-side configuration overrides the configuration file and default config settings, and so on.
+
+## 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 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.
+
+Here is an example `newrelic.yml` config file:
+
+```yaml
+common: &default_settings
+  license_key: 'YOUR_LICENSE_KEY'
+  app_name: 'My Application Name'
+production:
+  <<: *default_settings
+  log_level: info
+development:
+  <<: *default_settings
+  log_level: debug
+```
+
+For non-Rails apps, the Ruby agent looks for the following environment variables, in this order, to determine the application environment:
+
+1. `NEW_RELIC_ENV`
+2. `RUBY_ENV`
+3. `RAILS_ENV`
+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.
+
+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 you edit the config file, be sure to:
+
+* Indent only with two spaces.
+* Indent only where relevant, in stanzas such as **`error_collector`**.
+
+If you do not indent correctly, the agent may throw an `Unable to parse configuration file` error on startup.
+
+To view the most current list of available Ruby agent configuration options, use the `rake newrelic:config:docs` command. This document describes the most common options.
+
+## Update the config file [#Updates]
+
+This documentation applies to the Ruby agent's latest release. For details on earlier versions, refer to the comments in `newrelic.yml` itself.
+
+To update `newrelic.yml` file after a new release, use the template in the base directory of the agent gem. When you update to new gem versions, examine or diff `config/newrelic.yml` and `newrelic.yml` in the [installation directory](/docs/agents/manage-apm-agents/troubleshooting/find-agent-root-directory#ruby-agent) to take advantage of new configuration options.
+
+<Callout variant="important">
+  Updating the gem does not automatically update `config/newrelic.yml`.
+</Callout>
+
 <% sections.each do |(section_key, section_name, section_description, configs)| %>
 ## <%=section_name%>
 

data/lib/tasks/helpers/format.rb

@@ -3,16 +3,19 @@
 # frozen_string_literal: true
 
 module Format
-  def output(format)
-    config_hash = build_config_hash
-    sections = flatten_config_hash(config_hash)
+  DEFAULT_CONFIG_PATH = 'ruby-agent-configuration.mdx'
 
-    puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
-    sections # silences unused warning to return this
+  def output(format)
+    result = build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
+    File.write(DEFAULT_CONFIG_PATH, result)
   end
 
   private
 
+  def sections
+    @sections ||= flatten_config_hash(build_config_hash)
+  end
+
   def add_data_to_sections(sections)
     sections.each do |section|
       section_key = section[0]
@@ -66,7 +69,7 @@ module Format
 
   def format_description(value)
     description = ''
-    description += '<b>DEPRECATED</b> ' if value[:deprecated]
+    description += '**DEPRECATED** ' if value[:deprecated]
     description += value[:description]
     description
   end
@@ -81,9 +84,10 @@ module Format
     name = NAME_OVERRIDES[key]
     return name if name
 
-    key.split('_')
+    title = key.split('_')
       .each { |fragment| fragment[0] = fragment[0].upcase }
       .join(' ')
+    "#{title} [##{key.tr('_', '-')}]"
   end
 
   def format_sections(key, value)

data/lib/tasks/helpers/newrelicyml.rb

@@ -0,0 +1,144 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative '../../new_relic/agent/configuration/default_source'
+
+module NewRelicYML
+  CRITICAL = [:'agent_enabled', :'app_name', :'license_key', :'log_level']
+  DEFAULTS = NewRelic::Agent::Configuration::DEFAULTS
+  # Skip because not configurable via yml
+  SKIP = [:'defer_rails_initialization']
+  # Don't evaluate Procs, instead use set values
+  PROCS = {:'config_path' => 'newrelic.yml',
+           :'process_host.display_name' => 'default hostname',
+           :'transaction_tracer.transaction_threshold' => 1.0}
+
+  HEADER = <<~HEADER
+    #
+    # This file configures the New Relic Agent.  New Relic monitors Ruby, Java,
+    # .NET, PHP, Python, Node, and Go applications with deep visibility and low
+    # overhead.  For more information, visit www.newrelic.com.
+
+    # Generated <%= Time.now.strftime('%B %d, %Y') %><%= ", for version \#{@agent_version}" if @agent_version %>
+    #<%= "\\n# \#{generated_for_user}\\n#" if generated_for_user %>
+    # For full documentation of agent configuration options, please refer to
+    # https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+
+    common: &default_settings
+      # Required license key associated with your New Relic account.
+      license_key: <%= license_key %>
+
+      # Your application name. Renaming here affects where data displays in New
+      # Relic. For more details, see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/renaming-applications
+      app_name: <%= app_name %>
+
+      # To disable the agent regardless of other settings, uncomment the following:
+      # agent_enabled: false
+
+      # Logging level for log/newrelic_agent.log; options are error, warn, info, or
+      # debug.
+      log_level: info
+
+      # All of the following configuration options are optional. Review them, and
+      # uncomment or edit them if they appear relevant to your application needs.
+
+  HEADER
+
+  FOOTER = <<~FOOTER
+    # Environment-specific settings are in this section.
+    # RAILS_ENV or RACK_ENV (as appropriate) is used to determine the environment.
+    # If your application has other named environments, configure them here.
+    development:
+      <<: *default_settings
+      app_name: <%= app_name %> (Development)
+
+    test:
+      <<: *default_settings
+      # It doesn't make sense to report to New Relic from automated test runs.
+      monitor_mode: false
+
+    staging:
+      <<: *default_settings
+      app_name: <%= app_name %> (Staging)
+
+    production:
+      <<: *default_settings
+  FOOTER
+
+  def self.get_configs(defaults)
+    defaults.sort.each_with_object({}) do |(key, value), final_configs|
+      next if CRITICAL.include?(key) || SKIP.include?(key)
+
+      next unless public_config?(value) && !deprecated?(value)
+
+      sanitized_description = sanitize_description(value[:description])
+      description = format_description(sanitized_description)
+      default = default_value(key, value)
+      final_configs[key] = {description: description, default: default}
+    end
+  end
+
+  def self.public_config?(value)
+    value[:public] == true
+  end
+
+  def self.deprecated?(value)
+    value[:deprecated] == true
+  end
+
+  def self.sanitize_description(description)
+    # remove callouts
+    description = description.split("\n").reject { |line| line.match?('</?Callout') }.join("\n")
+    # remove InlinePopover, keep the text inside type
+    description.gsub!(/<InlinePopover type="(.*)" \/>/, '\1')
+    # remove hyperlinks
+    description.gsub!(/\[([^\]]+)\]\([^\)]+\)/, '\1')
+    # remove single pairs of backticks
+    description.gsub!(/`([^`]+)`/, '\1')
+    # removed href links
+    description.gsub!(/<a href="(.*)">(.*)<\/a>/, '\2')
+
+    description
+  end
+
+  def self.format_description(description)
+    # remove leading and trailing whitespace
+    description.strip!
+    # wrap text after 80 characters
+    description.gsub!(/(.{1,80})(\s+|\Z)/, "\\1\n")
+    # add hashtags to lines
+    description = description.split("\n").map { |line| "  # #{line}" }.join("\n")
+
+    description
+  end
+
+  def self.default_value(key, config_hash)
+    if PROCS.include?(key)
+      PROCS[key]
+    else
+      default = config_hash[:documentation_default].nil? ? config_hash[:default] : config_hash[:documentation_default]
+      default = 'nil' if default.nil?
+      default = '""' if default == ''
+
+      default
+    end
+  end
+
+  def self.build_string(defaults)
+    configs = get_configs(defaults)
+    yml_string = ''
+
+    configs.each do |key, value|
+      yml_string += "#{value[:description]}\n  # #{key}: #{value[:default]}\n\n"
+    end
+
+    yml_string
+  end
+
+  # :nocov:
+  def self.write_file(defaults = DEFAULTS)
+    File.write('newrelic.yml', HEADER + build_string(defaults) + FOOTER)
+  end
+  # :nocov:
+end

data/lib/tasks/helpers/version_bump.rb

@@ -0,0 +1,62 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module VersionBump
+  MAJOR = 0
+  MINOR = 1
+  TINY = 2
+  VERSION = {major: MAJOR, minor: MINOR, tiny: TINY}
+
+  # Updates version.rb with new version number
+  def self.update_version
+    bump_type = determine_bump_type
+    file = read_file('lib/new_relic/version.rb')
+    new_version = {}
+
+    VERSION.each do |key, current|
+      file.gsub!(/(#{key.to_s.upcase} = )(\d+)/) do
+        match = Regexp.last_match
+
+        new_version[key] = if bump_type == current # bump type, increase by 1
+          match[2].to_i + 1
+        elsif bump_type < current # right of bump type, goes to 0
+          0
+        else # left of bump type, stays the same
+          match[2].to_i
+        end
+
+        match[1] + new_version[key].to_s
+      end
+    end
+
+    write_file('lib/new_relic/version.rb', file)
+    new_version.values.join('.')
+  end
+
+  def self.read_file(path)
+    File.read(File.expand_path(path))
+  end
+
+  def self.write_file(path, file)
+    File.write(File.expand_path(path), file)
+  end
+
+  # Determined version based on if changelog has a feature or not for version
+  def self.determine_bump_type
+    file = read_file('CHANGELOG.md')
+    lines = file.split('## ')[1].split('- **')
+    return MAJOR if lines.first.include?('Major version')
+    return MINOR if lines.any? { |line| line.include?('Feature:') }
+
+    TINY
+  end
+
+  # Replace dev with version number in changelog
+  def self.update_changelog(version)
+    file = read_file('CHANGELOG.md')
+    file.gsub!('## dev', "## v#{version}")
+    file.gsub!('Version <dev>', "Version #{version}")
+    write_file('CHANGELOG.md', file)
+  end
+end

data/lib/tasks/newrelicyml.rake

@@ -0,0 +1,13 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'helpers/newrelicyml'
+
+namespace :newrelic do
+  desc 'Update newrelic.yml with latest config options from default_source.rb'
+  task :update_newrelicyml do
+    NewRelicYML.write_file
+    puts 'newrelic.yml updated'
+  end
+end