Add elasticsearch.capture_cluster_name config

CHANGELOG.md

@@ -1,5 +1,11 @@
 # New Relic Ruby Agent Release Notes
 
+## dev
+
+- **Feature: Add elasticsearch.capture_cluster_name configuration option**
+
+    A new configuration option, `elasticsearch.capture_cluster_name`, has been added to control capturing Elasticsearch cluster names. Cluster names are captured by default, but can now be disabled as needed. [PR#3038](https://github.com/newrelic/newrelic-ruby-agent/pull/3038)
+
 ## v9.17.0
 
 - **Feature: Support Ruby 3.4.0**

lib/new_relic/agent/configuration/default_source.rb

@@ -1466,6 +1466,13 @@ def self.notify
           :description => 'Distributed tracing lets you see the path that a request takes through your distributed system. Enabling distributed tracing changes the behavior of some New Relic features, so carefully consult the [transition guide](/docs/transition-guide-distributed-tracing) before you enable this feature.'
         },
         # Elasticsearch
+        :'elasticsearch.capture_cluster_name' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => true,
+          :description => 'If `true`, the agent captures the Elasticsearch cluster name in transaction traces.'
+        },
         :'elasticsearch.capture_queries' => {
           :default => true,
           :public => true,
@@ -2730,7 +2737,7 @@ def self.notify
           :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => "If `true`, the security agent loads (the agent performs a Ruby 'require')"
+          :description => "If `true`, the security agent is loaded (a Ruby 'require' is performed)"
         },
         :'security.enabled' => {
           :default => false,

lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb

@@ -102,6 +102,7 @@ def nr_reported_query(query)
     end
 
     def nr_cluster_name
+      return unless NewRelic::Agent.config[:'elasticsearch.capture_cluster_name']
       return @nr_cluster_name if defined?(@nr_cluster_name)
       return if nr_hosts.empty?
 

newrelic.yml

@@ -957,7 +957,6 @@ common: &default_settings
   #   NOTE: All "security.*" configuration parameters are related only to the
   #         security agent, and all other configuration parameters that may
   #         have "security" in the name somewhere are related to the APM agent.
-
   # If true, the security agent loads (the agent performs a Ruby 'require')
   # security.agent.enabled: false
 

test/multiverse/suites/elasticsearch/elasticsearch_instrumentation_test.rb

@@ -111,6 +111,14 @@ def test_cluster_name_doesnt_try_again_if_defined_but_nil
     assert_nil @segment.database_name
   end
 
+  def test_capture_cluster_name_config_is_false
+    with_config(:'elasticsearch.capture_cluster_name' => false) do
+      search
+
+      assert_nil @segment.database_name
+    end
+  end
+
   def test_nosql_statement_recorded_params_obfuscated
     with_config(:'elasticsearch.obfuscate_queries' => true) do
       txn = in_transaction do