Merge pull request #1541 from newrelic/custom_events_reservoir_limit

Increase custom_insights_events.max_samples_stored from 1000 to 3000

CHANGELOG.md

@@ -2,15 +2,17 @@
 
   ## v8.12.0
 
-  Version 8.12.0 of the agent delivers some valuable code cleanup.
+  Version 8.12.0 of the agent delivers some valuable code cleanup, and increases the default number of recorded Custom Events.
 
   * **Cleanup: Remove orphaned code from unit tests**
 
     As outlined by [newrelic/newrelic-ruby-agent#1181](https://github.com/newrelic/newrelic-ruby-agent/issues/1181), the project's unit tests have ended up with orphaned content that has become vestigal. Some good related cleanup was performed for this release. [PR#1537](https://github.com/newrelic/newrelic-ruby-agent/pull/1537)
 
     Thank you to [@ohbarye](https://github.com/ohbarye) for contributing this helpful cleanup!
 
+  * **Increase default for `custom_insights_events.max_samples_stored`**
 
+    New Relic has discovered a large number of [Custom Events](https://docs.newrelic.com/docs/data-apis/custom-data/custom-events/report-custom-event-data/) are dropped due to the configured value for `custom_insights_events.max_samples_stored`. In an effort to help customers receive more of their custom events, we're raising the default maximum value for custom events stored per minute from 1,000 events to 3,000 events. The highest possible number of events that can be sent per minute is 100,000.
   ## v8.11.0
 
   Version 8.11.0 of the agent updates the `newrelic deployments` command to work with API keys issued to newer accounts, fixes a memory leak in the instrumentation of Curb error handling, further preps for Ruby 3.2.0 support, and includes several community member driven cleanup and improvement efforts. Thank you to everyone involved!
@@ -60,15 +62,15 @@
 
 
   * **Bugfix: Missing unscoped metrics when instrumentation.thread.tracing is enabled**
-    
+
     Previously, when `instrumentation.thread.tracing` was set to true, some puma applications encountered a bug where a varying number of unscoped metrics would be missing. The agent now will correctly store and send all unscoped metrics.
-    
+
     Thank you to @texpert for providing details of their situation to help resolve the issue.
-  
-  
+
+
   * **Bugfix: gRPC instrumentation causes ArgumentError when other Google gems are present**
 
-    Previously, when the agent had gRPC instrumentation enabled in an application using other gems (such as google-ads-googleads), the instrumentation could cause the error `ArgumentError: wrong number of arguments (given 3, expected 2)`. The gRPC instrumentation has been updated to prevent this issue from occurring in the future. 
+    Previously, when the agent had gRPC instrumentation enabled in an application using other gems (such as google-ads-googleads), the instrumentation could cause the error `ArgumentError: wrong number of arguments (given 3, expected 2)`. The gRPC instrumentation has been updated to prevent this issue from occurring in the future.
 
     Thank you to @FeminismIsAwesome for bringing this issue to our attention.
 
@@ -105,26 +107,26 @@
 
 
   * **Bugfix: Error when setting the yaml configuration with `transaction_tracer.transaction_threshold: apdex_f`**
-    
-    Originally, the agent was only checking the `transaction_tracer.transaction_threshold` from the newrelic.yml correctly if it was on two lines. 
+
+    Originally, the agent was only checking the `transaction_tracer.transaction_threshold` from the newrelic.yml correctly if it was on two lines.
 
     Example:
 
     ```
     # newrelic.yml
     transaction_tracer:
-      transaction_threshold: apdex_f 
+      transaction_threshold: apdex_f
     ```
 
-    When this was instead changed to be on one line, the agent was not able to correctly identify the value of apdex_f. 
+    When this was instead changed to be on one line, the agent was not able to correctly identify the value of apdex_f.
 
     Example:
     ```
     # newrelic.yml
     transaction_tracer.transaction_threshold: apdex_f
     ```
-    This would cause prevent transactions from finishing due to the error `ArgumentError: comparison of Float with String failed`. This has now been corrected and the agent is able to process newrelic.yml with a one line `transaction_tracer.transaction_threshold: apdex_f` correctly now. 
-    
+    This would cause prevent transactions from finishing due to the error `ArgumentError: comparison of Float with String failed`. This has now been corrected and the agent is able to process newrelic.yml with a one line `transaction_tracer.transaction_threshold: apdex_f` correctly now.
+
     Thank you to @oboxodo for bringing this to our attention.
 
 
@@ -134,8 +136,8 @@
 
 
   ## v8.9.0
-  
-  
+
+
   * **Add support for Dalli 3.1.0 to Dalli 3.2.2**
 
     Dalli versions 3.1.0 and above include breaking changes where the agent previously hooked into the gem. We have updated our instrumentation to correctly hook into Dalli 3.1.0 and above. At this time, 3.2.2 is the latest Dalli version and is confirmed to be supported.
@@ -147,9 +149,9 @@
 
   * **Bugfix: Use read_nonblock instead of read on pipe**
 
-    Previously, our PipeChannelManager was using read which could cause Resque jobs to get stuck in some versions. This change updates the PipeChannelManager to use read_nonblock instead. This method can leverage error handling to allow the instrumentation to gracefully log a message and exit the stuck Resque job. 
+    Previously, our PipeChannelManager was using read which could cause Resque jobs to get stuck in some versions. This change updates the PipeChannelManager to use read_nonblock instead. This method can leverage error handling to allow the instrumentation to gracefully log a message and exit the stuck Resque job.
+
 
-    
   ## v8.8.0
 
   * **Support Makara database adapters with ActiveRecord**
@@ -246,7 +248,7 @@
   * **Bugfix: Error events missing attributes when created outside of a transaction**
 
     Previously the agent was not assigning a priority to error events that were created by calling notice_error outside the scope of a transaction. This caused issues with sampling when the error event buffer was full, resulting in a `NoMethodError: undefined method '<' for nil:NilClass` in the newrelic_agent.log. This bugfix ensures that a priority is always assigned on error events so that the agent will be able to sample these error events correctly. Thank you to @olleolleolle for bringing this issue to our attention.
-    
+
 
 
   ## v8.6.0

lib/new_relic/agent/configuration/default_source.rb

@@ -2004,7 +2004,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil)
           :description => 'If `true`, the agent captures [custom events](/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-new-relic-apm-agents).'
         },
         :'custom_insights_events.max_samples_stored' => {
-          :default => 1000,
+          :default => 3000,
           :public => true,
           :type => Integer,
           :allowed_from_server => true,

newrelic.yml

@@ -145,7 +145,7 @@ common: &default_settings
 
   # Specify a maximum number of custom Insights events to buffer in memory at a
   # time.
-  # custom_insights_events.max_samples_stored: 1000
+  # custom_insights_events.max_samples_stored: 3000
 
   # If false, the agent will not add database_name parameter to transaction or #
   # slow sql traces.

test/multiverse/suites/agent_only/custom_analytics_events_test.rb

@@ -72,7 +72,7 @@ def test_post_includes_metadata
     NewRelic::Agent.agent.send(:harvest_and_send_custom_event_data)
     post = last_custom_event_post
 
-    assert_equal({"reservoir_size" => 1000, "events_seen" => 10}, post.reservoir_metadata)
+    assert_equal({"reservoir_size" => 3000, "events_seen" => 10}, post.reservoir_metadata)
   end
 
   def last_custom_event_post

test/multiverse/suites/agent_only/event_data_collection_test.rb

@@ -11,7 +11,7 @@ def test_sends_all_event_capacities_on_connect
     expected = {
       'harvest_limits' => {
         "analytic_event_data" => 1200,
-        "custom_event_data" => 1000,
+        "custom_event_data" => 3000,
         "error_event_data" => 100,
         "span_event_data" => 2000,
         "log_event_data" => 10000
@@ -30,7 +30,7 @@ def test_sets_event_report_period_on_connect_response
         "report_period_ms" => 5000,
         "harvest_limits" => {
           "analytic_event_data" => 1200,
-          "custom_event_data" => 1000,
+          "custom_event_data" => 3000,
           "error_event_data" => 100,
           "log_event_data" => 10000
         }
@@ -51,7 +51,7 @@ def test_resets_event_report_period_on_reconnect
         "report_period_ms" => 5000,
         "harvest_limits" => {
           "analytic_event_data" => 1200,
-          "custom_event_data" => 1000,
+          "custom_event_data" => 3000,
           "error_event_data" => 100,
           "log_event_data" => 10000
         }