newrelic_rpm 9.14.0 → 9.18.0

data/newrelic.yml

@@ -40,9 +40,11 @@ common: &default_settings
 
   # If false, LLM instrumentation (OpenAI only for now) will not capture input and
   # output content on specific LLM events.
+  # 
   # The excluded attributes include:
-  # * content from LlmChatCompletionMessage events
-  # * input from LlmEmbedding events
+  # - content from LlmChatCompletionMessage events
+  # - input from LlmEmbedding events
+  # 
   # This is an optional security setting to prevent recording sensitive data sent
   # to and received from your LLMs.
   # ai_monitoring.record_content.enabled: true
@@ -65,21 +67,31 @@ common: &default_settings
   # If true, the agent captures log records emitted by your application.
   # application_logging.forwarding.enabled: true
 
+  # If true, the agent attaches labels to log records.
+  # application_logging.forwarding.labels.enabled: false
+
+  # A case-insensitive array or comma-delimited string containing the labels to
+  # exclude from log records.
+  # application_logging.forwarding.labels.exclude: []
+
   # Sets the minimum level a log event must have to be forwarded to New Relic.
-  # This is based on the integer values of Ruby's Logger::Severity constants:
-  # https://github.com/ruby/ruby/blob/master/lib/logger/severity.rb
+  # 
+  # This is based on the integer values of Ruby's Logger::Severity constants.
+  # 
   # The intention is to forward logs with the level given to the configuration, as
   # well as any logs with a higher level of severity.
+  # 
   # For example, setting this value to "debug" will forward all log events to New
   # Relic. Setting this value to "error" will only forward log events with the
   # levels "error", "fatal", and "unknown".
+  # 
   # Valid values (ordered lowest to highest):
-  # * "debug"
-  # * "info"
-  # * "warn"
-  # * "error"
-  # * "fatal"
-  # * "unknown"
+  # - "debug"
+  # - "info"
+  # - "warn"
+  # - "error"
+  # - "fatal"
+  # - "unknown"
   # application_logging.forwarding.log_level: debug
 
   # Defines the maximum number of log records to buffer in memory at a time.
@@ -114,13 +126,13 @@ common: &default_settings
   # audit_log.path: log/newrelic_audit.log
 
   # An array of CLASS#METHOD (for instance methods) and/or CLASS.METHOD (for class
-  # methods) strings representing Ruby methods for the agent to automatically add
-  # custom instrumentation to without the need for altering any of the source code
-  # that defines the methods.
-  #
+  # methods) strings representing Ruby methods that the agent can automatically
+  # add custom instrumentation to. This doesn't require any modifications of the
+  # source code that defines the methods.
+  # 
   # Use fully qualified class names (using the :: delimiter) that include any
   # module or class namespacing.
-  #
+  # 
   # Here is some Ruby source code that defines a render_png instance method for an
   # Image class and a notify class method for a User class, both within a
   # MyCompany module namespace:
@@ -131,7 +143,7 @@ common: &default_settings
   #       # code to render a PNG
   #     end
   #   end
-  #
+  # 
   #   class User
   #     def self.notify
   #       # code to notify users
@@ -139,25 +151,30 @@ common: &default_settings
   #   end
   # end
   # 
+  # 
   # Given that source code, the newrelic.yml config file might request
   # instrumentation for both of these methods like so:
   # 
   # automatic_custom_instrumentation_method_list:
-  # - MyCompany::Image#render_png
-  # - MyCompany::User.notify
-  #
+  #   - MyCompany::Image#render_png
+  #   - MyCompany::User.notify
+  # 
+  # 
   # That configuration example uses YAML array syntax to specify both methods.
-  # Alternatively, a comma-delimited string can be used instead:
+  # Alternatively, you can use a comma-delimited string:
+  # 
+  # automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png,
+  # MyCompany::User.notify'
   # 
-  # automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
   # 
   # Whitespace around the comma(s) in the list is optional. When configuring the
   # agent with a list of methods via the
   # NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST environment variable,
-  # this comma-delimited string format should be used:
-  # 
-  # export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'
+  # use this comma-delimited string format:
   # 
+  # export
+  # NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png,
+  # MyCompany::User.notify'
   # automatic_custom_instrumentation_method_list: []
 
   # Specify a list of constants that should prevent the agent from starting
@@ -197,9 +214,8 @@ common: &default_settings
   # monitoring scripts. For now, auto-injection only works with Rails 5.2+.
   # browser_monitoring.content_security_policy_nonce: true
 
-  # Manual override for the path to your local CA bundle. This CA bundle will be
-  # used to validate the SSL certificate presented by New Relic's data collection
-  # service.
+  # Manual override for the path to your local CA bundle. This CA bundle validates
+  # the SSL certificate presented by New Relic's data collection service.
   # ca_bundle_path: nil
 
   # Enable or disable the capture of memcache keys from transaction traces.
@@ -207,6 +223,7 @@ common: &default_settings
 
   # When true, the agent captures HTTP request parameters and attaches them to
   # transaction traces, traced errors, and TransactionError events.
+  # 
   # When using the capture_params setting, the Ruby agent will not attempt to
   # filter secret information. Recommendation: To filter secret information from
   # request parameters, use the attributes.include setting instead. For more
@@ -216,6 +233,9 @@ common: &default_settings
   # If true, the agent will clear Tracer::State in Agent.drop_buffered_data.
   # clear_transaction_state_after_fork: false
 
+  # The AWS account ID for the AWS account associated with this app
+  # cloud.aws.account_id: nil
+
   # If true, the agent will report source code level metrics for traced methods.
   # See:
   # https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/
@@ -223,10 +243,10 @@ common: &default_settings
 
   # Path to newrelic.yml. If undefined, the agent checks the following directories
   # (in order):
-  # * config/newrelic.yml
-  # * newrelic.yml
-  # * $HOME/.newrelic/newrelic.yml
-  # * $HOME/newrelic.yml
+  # - config/newrelic.yml
+  # - newrelic.yml
+  # - $HOME/.newrelic/newrelic.yml
+  # - $HOME/newrelic.yml
   # config_path: newrelic.yml
 
   # If false, custom attributes will not be sent on events.
@@ -235,9 +255,9 @@ common: &default_settings
   # If true, the agent captures custom events.
   # custom_insights_events.enabled: true
 
-  # * Specify a maximum number of custom events to buffer in memory at a time.
-  # * When configuring the agent for AI monitoring, set to max value 100000. This
-  # ensures the agent captures the maximum amount of LLM events.
+  # - Specify a maximum number of custom events to buffer in memory at a time.
+  #   - When configuring the agent for AI monitoring, set to max value 100000.
+  # This ensures the agent captures the maximum amount of LLM events.
   # custom_insights_events.max_samples_stored: 3000
 
   # If false, the agent will not add database_name parameter to transaction or
@@ -290,6 +310,7 @@ common: &default_settings
 
   # If true, the agent won't wrap third-party middlewares in instrumentation
   # (regardless of whether they are installed via Rack::Builder or Rails).
+  # 
   # When middleware instrumentation is disabled, if an application is using
   # middleware that could alter the response code, the HTTP status code reported
   # on the transaction may not reflect the altered value.
@@ -312,18 +333,18 @@ common: &default_settings
   # If true, disables agent middleware for Sinatra. This middleware is responsible
   # for advanced feature support such as cross application tracing, page load
   # timing, and error collection.
+  # 
   # Cross application tracing is deprecated in favor of distributed tracing.
   # Distributed tracing is on by default for Ruby agent versions 8.0.0 and above.
   # Middlewares are not required to support distributed tracing.
+  # 
   # To continue using cross application tracing, update the following options in
   # your newrelic.yml configuration file:
-  # ``yaml
-  # # newrelic.yml
+  # 
   # cross_application_tracer:
-  # enabled: true
+  #   enabled: true
   # distributed_tracing:
-  # enabled: false
-  # ``
+  #   enabled: false
   # disable_sinatra_auto_middleware: false
 
   # If true, disables view instrumentation.
@@ -338,6 +359,10 @@ common: &default_settings
   # enable this feature.
   # distributed_tracing.enabled: true
 
+  # If true, the agent captures the Elasticsearch cluster name in transaction
+  # traces.
+  # elasticsearch.capture_cluster_name: true
+
   # If true, the agent captures Elasticsearch queries in transaction traces.
   # elasticsearch.capture_queries: true
 
@@ -384,7 +409,7 @@ common: &default_settings
   # classes specified here occurs, if its error message contains one of the
   # strings corresponding to it here, that error will be ignored.
   # This option can't be set via environment variable.
-  # error_collector.ignore_messages: {}
+  # error_collector.ignore_messages: {"ThreadError" => ["queue empty"]}
 
   # A comma separated list of status codes, possibly including ranges. Errors
   # associated with these status codes, where applicable, will be ignored.
@@ -430,9 +455,9 @@ common: &default_settings
   # sending each span individually.
   # infinite_tracing.batching: true
 
-  # Configure the compression level for data sent to the trace observer.
-  # May be one of: :none, :low, :medium, :high.
-  # Set the level to :none to disable compression.
+  # Configure the compression level for data sent to the trace observer. May be
+  # one of: :none, :low, :medium, :high. Set the level to :none to disable
+  # compression.
   # infinite_tracing.compression_level: high
 
   # Configures the hostname for the trace observer Host. When configured, enables
@@ -455,6 +480,18 @@ common: &default_settings
   # prepend, chain, disabled.
   # instrumentation.async_http: auto
 
+  # Controls auto-instrumentation of the aws-sdk-firehose library at start-up. May
+  # be one of auto, prepend, chain, disabled.
+  # instrumentation.aws_sdk_firehose: auto
+
+  # Controls auto-instrumentation of the aws-sdk-kinesis library at start-up. May
+  # be one of auto, prepend, chain, disabled.
+  # instrumentation.aws_sdk_kinesis: auto
+
+  # Controls auto-instrumentation of the aws_sdk_lambda library at start-up. May
+  # be one of auto, prepend, chain, disabled.
+  # instrumentation.aws_sdk_lambda: auto
+
   # Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be
   # one of: auto, prepend, chain, disabled.
   # instrumentation.aws_sqs: auto
@@ -719,8 +756,8 @@ common: &default_settings
 
   # If true, the agent will operate in a streamlined mode suitable for use with
   # short-lived serverless functions. NOTE: Only AWS Lambda functions are
-  # supported currently and this option is not intended for use without New
-  # Relic's Ruby Lambda layer offering.
+  # supported currently and this option isn't intended for use without New Relic's
+  # Ruby Lambda layer offering.
   # serverless_mode.enabled: false
 
   # An array of strings that will collectively serve as a denylist for filtering
@@ -775,9 +812,9 @@ common: &default_settings
   # If true, enables span event sampling.
   # span_events.enabled: true
 
-  # * Defines the maximum number of span events reported from a single harvest.
+  # - Defines the maximum number of span events reported from a single harvest.
   # Any Integer between 1 and 10000 is valid.'
-  # * When configuring the agent for AI monitoring, set to max value 10000.This
+  #   - When configuring the agent for AI monitoring, set to max value 10000.This
   # ensures the agent captures the maximum amount of distributed traces.
   # span_events.max_samples_stored: 2000
 
@@ -791,7 +828,7 @@ common: &default_settings
   # strip_exception_messages.allowed_classes: ""
 
   # If true, the agent strips messages from all exceptions except those in the
-  # allowlist. Enabled automatically in high security mode.
+  # allowed classes list. Enabled automatically in high security mode.
   # strip_exception_messages.enabled: false
 
   # An array of strings to specify which keys and/or values inside a Stripe
@@ -799,17 +836,17 @@ common: &default_settings
   # not be reported to New Relic. Each string in this array will be turned into a
   # regular expression via
   # Regexp.new to permit advanced matching. For each hash pair, if either the key
-  # or value is matched the
-  # pair will not be reported. By default, no user_data is reported, so this
-  # option should only be used if
-  # the stripe.user_data.include option is being used.
+  # or value is matched the pair
+  # isn't reported. By default, no user_data is reported. Use this option only if
+  # the
+  # stripe.user_data.include option is also used.
   # stripe.user_data.exclude: []
 
   # An array of strings to specify which keys inside a Stripe event's user_data
   # hash should be reported
   # to New Relic. Each string in this array will be turned into a regular
   # expression via Regexp.new to
-  # permit advanced matching. Setting the value to ["."] will report all
+  # enable advanced matching. Setting the value to ["."] will report all
   # user_data.
   # stripe.user_data.include: []
 
@@ -873,7 +910,7 @@ common: &default_settings
 
   # If true, enables the collection of explain plans in transaction traces. This
   # setting will also apply to explain plans in slow SQL traces if
-  # slow_sql.explain_enabled is not set separately.
+  # slow_sql.explain_enabled isn't set separately.
   # transaction_tracer.explain_enabled: true
 
   # Threshold (in seconds) above which the agent will collect explain plans.
@@ -952,28 +989,99 @@ common: &default_settings
   # security.agent.enabled: false
 
   # The port the application is listening on. This setting is mandatory for
-  # Passenger servers. Other servers should be detected by default.
+  # Passenger servers. The agent detects other servers by default.
   # security.application_info.port: nil
 
-  # If true, enables deserialization detection
-  # security.detection.deserialization.enabled: true
+  # If true, the security agent is started (the agent runs in its event loop)
+  # security.enabled: false
+
+  # Defines API paths the security agent should ignore in IAST scans. Accepts an
+  # array of regex patterns matching the URI to ignore. The regex pattern should
+  # find a complete match for the URL without the endpoint. For example,
+  # [".*account.*"], [".*/\api\/v1\/.*?\/login"]
+  # security.exclude_from_iast_scan.api: []
 
-  # If true, enables RCI (remote code injection) detection
-  # security.detection.rci.enabled: true
+  # An array of HTTP request body keys the security agent should ignore in IAST
+  # scans.
+  # security.exclude_from_iast_scan.http_request_parameters.body: []
 
-  # If true, enables RXSS (reflected cross-site scripting) detection
-  # security.detection.rxss.enabled: true
+  # An array of HTTP request headers the security agent should ignore in IAST
+  # scans. The array should specify a list of patterns matching the headers to
+  # ignore.
+  # security.exclude_from_iast_scan.http_request_parameters.header: []
 
-  # If true, the security agent is started (the agent runs in its event loop)
-  # security.enabled: false
+  # An array of HTTP request query parameters the security agent should ignore in
+  # IAST scans. The array should specify a list of patterns matching the HTTP
+  # request query parameters to ignore.
+  # security.exclude_from_iast_scan.http_request_parameters.query: []
+
+  # If true, disables system command injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.command_injection: false
+
+  # If true, disables the detection of low-severity insecure settings. For
+  # example, hash, crypto, cookie, random generators, trust boundary).
+  # security.exclude_from_iast_scan.iast_detection_category.insecure_settings: false
+
+  # If true, disables file operation-related IAST detections (File Access &
+  # Application integrity violation)
+  # security.exclude_from_iast_scan.iast_detection_category.invalid_file_access: false
+
+  # If true, disables Javascript injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.javascript_injection: false
+
+  # If true, disables LDAP injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.ldap_injection: false
+
+  # If true, disables NOSQL injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.nosql_injection: false
+
+  # If true, disables Reflected Cross-Site Scripting (RXSS) detection in IAST
+  # scans.
+  # security.exclude_from_iast_scan.iast_detection_category.rxss: false
+
+  # If true, disables SQL injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.sql_injection: false
+
+  # If true, disables Sever-Side Request Forgery (SSRF) detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.ssrf: false
+
+  # If true, disables XPATH injection detection in IAST scans.
+  # security.exclude_from_iast_scan.iast_detection_category.xpath_injection: false
+
+  # A unique test identifier when runnning IAST in a CI/CD environment to
+  # differentiate between different test runs. For example, a build number.
+  # security.iast_test_identifier: nil
 
   # Defines the mode for the security agent to operate in. Currently only IAST is
   # supported
   # security.mode: IAST
 
-  # Defines the request body limit to process in security events (in KB). The
-  # default value is 300, for 300KB.
-  # security.request.body_limit: 300
+  # Sets the maximum number of HTTP requests allowed for the IAST scan per minute.
+  # Any Integer between 12 and 3600 is valid. The default value is 3600.
+  # security.scan_controllers.iast_scan_request_rate_limit: 3600
+
+  # If true, enables the sending of HTTP responses bodies. Disabling this also
+  # disables Reflected Cross-Site Scripting (RXSS) vulnerability detection.
+  # security.scan_controllers.report_http_response_body: true
+
+  # The number of application instances for a specific entity to perform IAST
+  # analysis on.
+  # security.scan_controllers.scan_instance_count: 0
+
+  # If true, allows IAST to continuously gather trace data in the background. The
+  # security agent uses collected data to perform an IAST scan at the scheduled
+  # time.
+  # security.scan_schedule.always_sample_traces: false
+
+  # Specifies the delay time (in minutes) before the IAST scan begins after the
+  # application starts.
+  # security.scan_schedule.delay: 0
+
+  # Indicates the duration (in minutes) for which the IAST scan will be performed.
+  # security.scan_schedule.duration: 0
+
+  # Specifies a cron expression that sets when the IAST scan should run.
+  # security.scan_schedule.schedule: ""
 
   # Defines the endpoint URL for posting security-related data
   # security.validator_service_url: wss://csec.nr-data.net

data/test/agent_helper.rb

@@ -112,7 +112,14 @@ def assert_log_contains(log, message)
   lines = log.array
 
   assert (lines.any? { |line| line.match(message) }),
-    "Could not find message. Log contained: #{lines.join("\n")}"
+    "Could not find message: '#{message.inspect}'. Log contained: #{lines.join("\n")}"
+end
+
+def refute_log_contains(log, message)
+  lines = log.array
+
+  refute (lines.any? { |line| line.match(message) }),
+    "Found message: '#{message.inspect}'. Log contained: #{lines.join("\n")}"
 end
 
 def assert_audit_log_contains(audit_log_contents, needle)

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 9.14.0
+  version: 9.18.0
 platform: ruby
 authors:
 - Tanna McClure
 - Kayla Reopelle
 - James Bunch
 - Hannah Ramadan
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -344,6 +343,7 @@ files:
 - lib/new_relic/agent/external.rb
 - lib/new_relic/agent/guid_generator.rb
 - lib/new_relic/agent/harvester.rb
+- lib/new_relic/agent/health_check.rb
 - lib/new_relic/agent/heap.rb
 - lib/new_relic/agent/hostname.rb
 - lib/new_relic/agent/http_clients/abstract.rb
@@ -392,6 +392,18 @@ files:
 - lib/new_relic/agent/instrumentation/async_http/chain.rb
 - lib/new_relic/agent/instrumentation/async_http/instrumentation.rb
 - lib/new_relic/agent/instrumentation/async_http/prepend.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_firehose.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_firehose/chain.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_firehose/instrumentation.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_firehose/prepend.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_kinesis.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_kinesis/chain.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_kinesis/prepend.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_lambda.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_lambda/chain.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_lambda/instrumentation.rb
+- lib/new_relic/agent/instrumentation/aws_sdk_lambda/prepend.rb
 - lib/new_relic/agent/instrumentation/aws_sqs.rb
 - lib/new_relic/agent/instrumentation/aws_sqs/chain.rb
 - lib/new_relic/agent/instrumentation/aws_sqs/instrumentation.rb
@@ -543,6 +555,7 @@ files:
 - lib/new_relic/agent/instrumentation/sequel_helper.rb
 - lib/new_relic/agent/instrumentation/sidekiq.rb
 - lib/new_relic/agent/instrumentation/sidekiq/client.rb
+- lib/new_relic/agent/instrumentation/sidekiq/extensions/delay_extensions.rb
 - lib/new_relic/agent/instrumentation/sidekiq/extensions/delayed_class.rb
 - lib/new_relic/agent/instrumentation/sidekiq/server.rb
 - lib/new_relic/agent/instrumentation/sinatra.rb
@@ -734,19 +747,6 @@ files:
 - lib/tasks/helpers/prompt.rb
 - lib/tasks/helpers/version_bump.rb
 - lib/tasks/install.rake
-- lib/tasks/instrumentation_generator/README.md
-- lib/tasks/instrumentation_generator/TODO.md
-- lib/tasks/instrumentation_generator/instrumentation.thor
-- lib/tasks/instrumentation_generator/templates/Envfile.tt
-- lib/tasks/instrumentation_generator/templates/chain.tt
-- lib/tasks/instrumentation_generator/templates/chain_method.tt
-- lib/tasks/instrumentation_generator/templates/dependency_detection.tt
-- lib/tasks/instrumentation_generator/templates/instrumentation.tt
-- lib/tasks/instrumentation_generator/templates/instrumentation_method.tt
-- lib/tasks/instrumentation_generator/templates/newrelic.yml.tt
-- lib/tasks/instrumentation_generator/templates/prepend.tt
-- lib/tasks/instrumentation_generator/templates/prepend_method.tt
-- lib/tasks/instrumentation_generator/templates/test.tt
 - lib/tasks/newrelic.rb
 - lib/tasks/newrelicyml.rake
 - lib/tasks/tests.rake
@@ -763,7 +763,6 @@ metadata:
   documentation_uri: https://docs.newrelic.com/docs/agents/ruby-agent
   source_code_uri: https://github.com/newrelic/newrelic-ruby-agent
   homepage_uri: https://newrelic.com/ruby
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -778,8 +777,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: New Relic Ruby Agent
 test_files: []

data/lib/tasks/instrumentation_generator/README.md

@@ -1,63 +0,0 @@
-# Instrumentation Generator
-
-## Usage
-
-`thor list` can be passed to get a list of all available thor commands
-
-### instrumentation:scaffold
-
-This task requires one parameter by default: the name of the library or class you are instrumenting. This task generates the basic file structure needed to add new instrumentation to the Ruby agent.
-
-Run it using:
-
-`thor instrumentation:scaffold gem_name`
-
-It accepts two optional parameters:
-
-- `--method`: the name of a method to instrument. Only one method can be accepted at this time. Defaults to `method_to_instrument`
-- `--args`: the arguments for the instrumented method. A comma-separated list can be given if there are multiple arguments. Defaults to `*args`.
-
-With the optional parameters, the task can be run like so:
-
-`thor instrumentation:scaffold gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
-
-### WIP: instrumentation:add_new_method
-
-Are you trying add instrumentation for a method within library we already instrument? This task is for you! Instead of building the entire scaffold, this task inserts only the changes needed within the `instrumentation.rb` and test files to instrument the new method. It requires one argument, the name of the existing instrumentation to add the method to. If the instrumented library does not already exist, it will create a new scaffold for that library.
-
-Run it using:
-
-`thor instrumentation:scaffold gem_name`
-
-It accepts two optional parameters:
-
-- `--method`: the name of a method to instrument. Only one method can be accepted at this time. Defaults to `method_to_instrument`
-- `--args`: the arguments for the instrumented method. A comma-separated list can be given if there are multiple arguments. Defaults to `*args`.
-
-With the optional parameters, the task can be run like so:
-
-`thor instrumentation:add_new_method gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
-
-## Idea
-
-Create a CLI, similar to Rails’ generators and scaffold scripts, to create the required files and basic classes for instrumenting new libraries. The hope is that the parts of adding new instrumentation that is repetitive can be eliminated and/or reduced so that it takes less time to add new instrumentation and we can spend development time considering the best attributes to collect and interactions to measure. I also hope this project will reduce the overall toil related to adding new instrumentation.
-
-The files we create with little variation besides library and method names are:
-
-- Lib
-  - Dependency detection
-  - Chain
-  - Prepend
-  - Instrumentation
-- Tests
-  - configuration/newrelic.yml
-  - Envfile
-  - Test file
-
-Furthermore, we also create very similar snippets inside the default source configuration file that could be generated by this project as well.
-
-## Outcome
-
-A prototype outside the agent was first created. This prototype generated the required files to add instrumentation. The prototype accepted three arguments: name (name of the library), method (method to instrument), args (arguments for the method). This prototype has evolved into the current directory.
-
-This project leverages the Ruby gem Thor, a toolkit for building powerful command-line interfaces used in Bundler, Vagrant, Rails and others powers this CLI.

data/lib/tasks/instrumentation_generator/TODO.md

@@ -1,33 +0,0 @@
-# TODO
-
-# - [X] Create instrumentation file
-
-# - [X] Create chain file
-
-# - [X] Create prepend file
-
-# - [X] Create dependency detection file
-
-# - [X] Add config to default source
-
-# - [X] Create multiverse suite
-
-# - [X] Create Envfile
-
-# - [X] Create test file with examples
-
-# - [X] Create option for method names to instrument
-
-# - [X] Add entry to newrelic.yml
-
-# - [ ] Append a new method to instrument to an existing instrumentation class (with tests?)
-
-# - [ ] Documentation: examples of what to add in each gap (Good examples of tests, instrumentation, etc. as comments to guide users)
-
-# - [ ] Handle multi-word gem names (camel case for classes, handle hyphens, concurrent-ruby as example)
-
-# - [ ] Allow multiple method arguments to be passed to the command line
-
-# - [ ] Add tests for the instrumentation_generator code
-
-# - [ ] See if instrumentation PRs can get automatically generated when an already instrumented library adds methods to its codebase