newrelic_rpm 9.0.0 → 9.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (224) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +6 -16
  4. data/.rubocop_todo.yml +4 -43
  5. data/.simplecov +1 -1
  6. data/CHANGELOG.md +60 -2
  7. data/Gemfile +1 -1
  8. data/Guardfile +7 -7
  9. data/README.md +1 -2
  10. data/Rakefile +8 -8
  11. data/Thorfile +1 -1
  12. data/bin/nrdebug +20 -20
  13. data/init.rb +1 -1
  14. data/lib/new_relic/agent/agent.rb +3 -16
  15. data/lib/new_relic/agent/agent_helpers/connect.rb +4 -9
  16. data/lib/new_relic/agent/agent_helpers/harvest.rb +4 -4
  17. data/lib/new_relic/agent/agent_helpers/shutdown.rb +5 -5
  18. data/lib/new_relic/agent/agent_helpers/special_startup.rb +2 -2
  19. data/lib/new_relic/agent/agent_helpers/start_worker_thread.rb +47 -39
  20. data/lib/new_relic/agent/agent_helpers/startup.rb +13 -13
  21. data/lib/new_relic/agent/agent_helpers/transmit.rb +6 -6
  22. data/lib/new_relic/agent/agent_logger.rb +9 -9
  23. data/lib/new_relic/agent/attribute_filter.rb +2 -2
  24. data/lib/new_relic/agent/attribute_processing.rb +2 -2
  25. data/lib/new_relic/agent/audit_logger.rb +5 -5
  26. data/lib/new_relic/agent/autostart.rb +1 -1
  27. data/lib/new_relic/agent/commands/agent_command.rb +2 -2
  28. data/lib/new_relic/agent/commands/agent_command_router.rb +5 -4
  29. data/lib/new_relic/agent/commands/thread_profiler_session.rb +5 -5
  30. data/lib/new_relic/agent/configuration/default_source.rb +57 -56
  31. data/lib/new_relic/agent/configuration/environment_source.rb +2 -2
  32. data/lib/new_relic/agent/configuration/high_security_source.rb +3 -3
  33. data/lib/new_relic/agent/configuration/manager.rb +2 -2
  34. data/lib/new_relic/agent/configuration/security_policy_source.rb +10 -10
  35. data/lib/new_relic/agent/configuration/server_source.rb +24 -24
  36. data/lib/new_relic/agent/configuration/yaml_source.rb +4 -4
  37. data/lib/new_relic/agent/connect/request_builder.rb +1 -1
  38. data/lib/new_relic/agent/connect/response_handler.rb +1 -1
  39. data/lib/new_relic/agent/custom_event_aggregator.rb +4 -4
  40. data/lib/new_relic/agent/database/explain_plan_helpers.rb +1 -1
  41. data/lib/new_relic/agent/database/obfuscation_helpers.rb +2 -2
  42. data/lib/new_relic/agent/database/obfuscator.rb +2 -2
  43. data/lib/new_relic/agent/database.rb +4 -4
  44. data/lib/new_relic/agent/datastores/metric_helper.rb +5 -5
  45. data/lib/new_relic/agent/datastores/mongo/metric_translator.rb +11 -11
  46. data/lib/new_relic/agent/datastores/redis.rb +6 -6
  47. data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb +7 -8
  48. data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +10 -10
  49. data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb +7 -7
  50. data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb +1 -1
  51. data/lib/new_relic/agent/distributed_tracing/distributed_trace_transport_type.rb +6 -6
  52. data/lib/new_relic/agent/distributed_tracing/trace_context.rb +7 -7
  53. data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +4 -4
  54. data/lib/new_relic/agent/distributed_tracing.rb +5 -5
  55. data/lib/new_relic/agent/error_collector.rb +35 -7
  56. data/lib/new_relic/agent/error_filter.rb +2 -2
  57. data/lib/new_relic/agent/error_trace_aggregator.rb +5 -4
  58. data/lib/new_relic/agent/event_loop.rb +3 -3
  59. data/lib/new_relic/agent/external.rb +1 -1
  60. data/lib/new_relic/agent/harvester.rb +1 -3
  61. data/lib/new_relic/agent/heap.rb +2 -1
  62. data/lib/new_relic/agent/hostname.rb +1 -1
  63. data/lib/new_relic/agent/http_clients/abstract.rb +9 -21
  64. data/lib/new_relic/agent/http_clients/curb_wrappers.rb +7 -3
  65. data/lib/new_relic/agent/http_clients/excon_wrappers.rb +7 -5
  66. data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb +4 -0
  67. data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb +6 -2
  68. data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +5 -1
  69. data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb +8 -5
  70. data/lib/new_relic/agent/http_clients/uri_util.rb +2 -2
  71. data/lib/new_relic/agent/instrumentation/action_controller_other_subscriber.rb +5 -2
  72. data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +3 -2
  73. data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb +3 -3
  74. data/lib/new_relic/agent/instrumentation/active_job.rb +1 -1
  75. data/lib/new_relic/agent/instrumentation/active_record.rb +3 -2
  76. data/lib/new_relic/agent/instrumentation/active_record_helper.rb +38 -35
  77. data/lib/new_relic/agent/instrumentation/active_record_notifications.rb +3 -3
  78. data/lib/new_relic/agent/instrumentation/active_record_prepend.rb +2 -2
  79. data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +3 -2
  80. data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb +3 -3
  81. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +5 -3
  82. data/lib/new_relic/agent/instrumentation/curb/chain.rb +1 -1
  83. data/lib/new_relic/agent/instrumentation/curb/instrumentation.rb +5 -5
  84. data/lib/new_relic/agent/instrumentation/curb.rb +1 -1
  85. data/lib/new_relic/agent/instrumentation/custom_events_subscriber.rb +2 -1
  86. data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb +1 -1
  87. data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb +2 -1
  88. data/lib/new_relic/agent/instrumentation/elasticsearch/chain.rb +1 -1
  89. data/lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb +3 -3
  90. data/lib/new_relic/agent/instrumentation/elasticsearch.rb +1 -1
  91. data/lib/new_relic/agent/instrumentation/excon/middleware.rb +2 -1
  92. data/lib/new_relic/agent/instrumentation/excon.rb +3 -3
  93. data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb +4 -4
  94. data/lib/new_relic/agent/instrumentation/grape.rb +3 -3
  95. data/lib/new_relic/agent/instrumentation/grpc/client/instrumentation.rb +2 -1
  96. data/lib/new_relic/agent/instrumentation/grpc/server/instrumentation.rb +3 -3
  97. data/lib/new_relic/agent/instrumentation/httprb.rb +1 -1
  98. data/lib/new_relic/agent/instrumentation/ignore_actions.rb +1 -1
  99. data/lib/new_relic/agent/instrumentation/logger.rb +1 -1
  100. data/lib/new_relic/agent/instrumentation/memcache/instrumentation.rb +2 -2
  101. data/lib/new_relic/agent/instrumentation/memcache.rb +6 -6
  102. data/lib/new_relic/agent/instrumentation/middleware_proxy.rb +3 -3
  103. data/lib/new_relic/agent/instrumentation/middleware_tracing.rb +1 -1
  104. data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb +5 -5
  105. data/lib/new_relic/agent/instrumentation/net_http.rb +1 -1
  106. data/lib/new_relic/agent/instrumentation/notifications_subscriber.rb +1 -1
  107. data/lib/new_relic/agent/instrumentation/padrino/instrumentation.rb +3 -3
  108. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +2 -2
  109. data/lib/new_relic/agent/instrumentation/rack/instrumentation.rb +1 -1
  110. data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +3 -2
  111. data/lib/new_relic/agent/instrumentation/rails_middleware.rb +1 -1
  112. data/lib/new_relic/agent/instrumentation/rake/instrumentation.rb +7 -7
  113. data/lib/new_relic/agent/instrumentation/rake.rb +2 -2
  114. data/lib/new_relic/agent/instrumentation/redis/constants.rb +1 -1
  115. data/lib/new_relic/agent/instrumentation/redis/instrumentation.rb +2 -1
  116. data/lib/new_relic/agent/instrumentation/resque/helper.rb +1 -1
  117. data/lib/new_relic/agent/instrumentation/sequel.rb +4 -4
  118. data/lib/new_relic/agent/instrumentation/sequel_helper.rb +10 -10
  119. data/lib/new_relic/agent/instrumentation/sidekiq/extensions/delayed_class.rb +1 -1
  120. data/lib/new_relic/agent/instrumentation/sidekiq/server.rb +1 -1
  121. data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb +1 -1
  122. data/lib/new_relic/agent/instrumentation/sinatra/instrumentation.rb +6 -5
  123. data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb +1 -1
  124. data/lib/new_relic/agent/instrumentation/tilt/instrumentation.rb +2 -1
  125. data/lib/new_relic/agent/instrumentation/typhoeus/instrumentation.rb +5 -5
  126. data/lib/new_relic/agent/javascript_instrumentor.rb +29 -24
  127. data/lib/new_relic/agent/linking_metadata.rb +2 -2
  128. data/lib/new_relic/agent/log_event_aggregator.rb +15 -15
  129. data/lib/new_relic/agent/logging.rb +73 -33
  130. data/lib/new_relic/agent/messaging.rb +7 -5
  131. data/lib/new_relic/agent/method_tracer.rb +6 -6
  132. data/lib/new_relic/agent/method_tracer_helpers.rb +1 -1
  133. data/lib/new_relic/agent/monitors/cross_app_monitor.rb +4 -4
  134. data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb +1 -1
  135. data/lib/new_relic/agent/new_relic_service/encoders.rb +1 -1
  136. data/lib/new_relic/agent/new_relic_service/json_marshaller.rb +2 -2
  137. data/lib/new_relic/agent/new_relic_service.rb +14 -14
  138. data/lib/new_relic/agent/obfuscator.rb +1 -1
  139. data/lib/new_relic/agent/parameter_filtering.rb +6 -6
  140. data/lib/new_relic/agent/pipe_channel_manager.rb +7 -6
  141. data/lib/new_relic/agent/pipe_service.rb +5 -3
  142. data/lib/new_relic/agent/priority_sampled_buffer.rb +1 -1
  143. data/lib/new_relic/agent/sampler.rb +1 -1
  144. data/lib/new_relic/agent/sampler_collection.rb +1 -1
  145. data/lib/new_relic/agent/samplers/cpu_sampler.rb +5 -5
  146. data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +9 -9
  147. data/lib/new_relic/agent/samplers/memory_sampler.rb +9 -9
  148. data/lib/new_relic/agent/samplers/object_sampler.rb +1 -1
  149. data/lib/new_relic/agent/span_event_aggregator.rb +4 -4
  150. data/lib/new_relic/agent/span_event_primitive.rb +2 -2
  151. data/lib/new_relic/agent/sql_sampler.rb +2 -2
  152. data/lib/new_relic/agent/stats.rb +1 -1
  153. data/lib/new_relic/agent/synthetics_event_aggregator.rb +1 -1
  154. data/lib/new_relic/agent/system_info.rb +10 -10
  155. data/lib/new_relic/agent/threading/agent_thread.rb +1 -1
  156. data/lib/new_relic/agent/threading/backtrace_node.rb +3 -3
  157. data/lib/new_relic/agent/threading/backtrace_service.rb +3 -7
  158. data/lib/new_relic/agent/threading/thread_profile.rb +5 -5
  159. data/lib/new_relic/agent/timestamp_sampled_buffer.rb +1 -1
  160. data/lib/new_relic/agent/tracer.rb +8 -7
  161. data/lib/new_relic/agent/transaction/abstract_segment.rb +7 -7
  162. data/lib/new_relic/agent/transaction/datastore_segment.rb +1 -1
  163. data/lib/new_relic/agent/transaction/distributed_tracer.rb +7 -6
  164. data/lib/new_relic/agent/transaction/distributed_tracing.rb +6 -6
  165. data/lib/new_relic/agent/transaction/external_request_segment.rb +11 -11
  166. data/lib/new_relic/agent/transaction/message_broker_segment.rb +1 -1
  167. data/lib/new_relic/agent/transaction/request_attributes.rb +2 -2
  168. data/lib/new_relic/agent/transaction/segment.rb +1 -1
  169. data/lib/new_relic/agent/transaction/synthetics_sample_buffer.rb +1 -1
  170. data/lib/new_relic/agent/transaction/trace.rb +1 -1
  171. data/lib/new_relic/agent/transaction/trace_context.rb +4 -4
  172. data/lib/new_relic/agent/transaction/trace_node.rb +8 -7
  173. data/lib/new_relic/agent/transaction/tracing.rb +2 -2
  174. data/lib/new_relic/agent/transaction/transaction_sample_buffer.rb +1 -1
  175. data/lib/new_relic/agent/transaction.rb +39 -36
  176. data/lib/new_relic/agent/transaction_error_primitive.rb +5 -5
  177. data/lib/new_relic/agent/transaction_event_aggregator.rb +4 -4
  178. data/lib/new_relic/agent/transaction_event_primitive.rb +3 -3
  179. data/lib/new_relic/agent/transaction_sampler.rb +3 -3
  180. data/lib/new_relic/agent/transaction_time_aggregator.rb +7 -3
  181. data/lib/new_relic/agent/utilization/aws.rb +1 -1
  182. data/lib/new_relic/agent/utilization/azure.rb +3 -3
  183. data/lib/new_relic/agent/utilization/gcp.rb +3 -3
  184. data/lib/new_relic/agent/utilization/pcf.rb +1 -1
  185. data/lib/new_relic/agent/utilization/vendor.rb +1 -1
  186. data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb +1 -1
  187. data/lib/new_relic/agent/vm/mri_vm.rb +9 -8
  188. data/lib/new_relic/agent/worker_loop.rb +1 -1
  189. data/lib/new_relic/agent.rb +78 -16
  190. data/lib/new_relic/cli/command.rb +3 -3
  191. data/lib/new_relic/cli/commands/deployments.rb +26 -25
  192. data/lib/new_relic/cli/commands/install.rb +14 -14
  193. data/lib/new_relic/collection_helper.rb +2 -2
  194. data/lib/new_relic/constants.rb +7 -8
  195. data/lib/new_relic/control/class_methods.rb +3 -3
  196. data/lib/new_relic/control/frameworks/rails.rb +30 -18
  197. data/lib/new_relic/control/instance_methods.rb +5 -5
  198. data/lib/new_relic/control/instrumentation.rb +1 -1
  199. data/lib/new_relic/control/private_instance_methods.rb +1 -1
  200. data/lib/new_relic/dependency_detection.rb +4 -17
  201. data/lib/new_relic/environment_report.rb +4 -4
  202. data/lib/new_relic/helper.rb +2 -1
  203. data/lib/new_relic/language_support.rb +1 -1
  204. data/lib/new_relic/latest_changes.rb +5 -5
  205. data/lib/new_relic/noticed_error.rb +20 -18
  206. data/lib/new_relic/rack/browser_monitoring.rb +20 -16
  207. data/lib/new_relic/recipes/capistrano3.rb +1 -1
  208. data/lib/new_relic/recipes/capistrano_legacy.rb +6 -6
  209. data/lib/new_relic/recipes/helpers/send_deployment.rb +5 -5
  210. data/lib/new_relic/supportability_helper.rb +2 -0
  211. data/lib/new_relic/version.rb +1 -1
  212. data/lib/newrelic_rpm.rb +3 -3
  213. data/lib/sequel/extensions/new_relic_instrumentation.rb +3 -3
  214. data/lib/sequel/plugins/new_relic_instrumentation.rb +1 -1
  215. data/lib/tasks/config.rake +12 -12
  216. data/lib/tasks/coverage_report.rake +3 -3
  217. data/lib/tasks/helpers/format.rb +9 -9
  218. data/lib/tasks/helpers/removers.rb +5 -5
  219. data/lib/tasks/install.rake +4 -4
  220. data/lib/tasks/multiverse.rb +12 -6
  221. data/lib/tasks/tests.rake +6 -6
  222. data/newrelic_rpm.gemspec +13 -13
  223. data/test/agent_helper.rb +25 -24
  224. metadata +2 -2
@@ -34,13 +34,13 @@ module NewRelic
34
34
  threshold = Agent.config[:'transaction_tracer.transaction_threshold']
35
35
  ::NewRelic::Agent.logger.debug("Transaction tracing threshold is #{threshold} seconds.")
36
36
  else
37
- ::NewRelic::Agent.logger.debug("Transaction traces will not be sent to the New Relic service.")
37
+ ::NewRelic::Agent.logger.debug('Transaction traces will not be sent to the New Relic service.')
38
38
  end
39
39
  end
40
40
 
41
41
  Agent.config.register_callback(:'transaction_tracer.record_sql') do |config|
42
42
  if config == 'raw'
43
- ::NewRelic::Agent.logger.warn("Agent is configured to send raw SQL to the service")
43
+ ::NewRelic::Agent.logger.warn('Agent is configured to send raw SQL to the service')
44
44
  end
45
45
  end
46
46
  end
@@ -81,7 +81,7 @@ module NewRelic
81
81
  begin
82
82
  sample.prepare_to_send!
83
83
  rescue => e
84
- NewRelic::Agent.logger.error("Failed to prepare transaction trace. Error: ", e)
84
+ NewRelic::Agent.logger.error('Failed to prepare transaction trace. Error: ', e)
85
85
  false
86
86
  else
87
87
  true
@@ -101,7 +101,8 @@ module NewRelic
101
101
 
102
102
  def thread_is_alive?(thread_id)
103
103
  thread = thread_by_id(thread_id)
104
- thread && thread.alive?
104
+ # needs else branch coverage
105
+ thread && thread.alive? # rubocop:disable Style/SafeNavigation
105
106
  rescue StandardError
106
107
  false
107
108
  end
@@ -144,10 +145,13 @@ module NewRelic
144
145
  elapsed
145
146
  end
146
147
 
148
+ # this method has no test coverage
147
149
  def log_missing_elapsed_transaction_time
148
- transaction_name = Tracer.current_transaction &&
150
+ # rubocop:disable Style/SafeNavigation
151
+ transaction_name = transaction_name = Tracer.current_transaction &&
149
152
  Tracer.current_transaction.best_name ||
150
- "unknown"
153
+ 'unknown'
154
+ # rubocop:enable Style/SafeNavigation
151
155
  NewRelic::Agent.logger.warn("Unable to calculate elapsed transaction time for #{transaction_name}")
152
156
  end
153
157
  end
@@ -37,7 +37,7 @@ module NewRelic
37
37
  end
38
38
  end
39
39
 
40
- vendor_name "aws"
40
+ vendor_name 'aws'
41
41
  endpoint "#{IMDS_BASE_URL}/dynamic/instance-identity/document"
42
42
  keys IMDS_KEYS
43
43
  headers 'X-aws-ec2-metadata-token' => -> { imds_token }
@@ -6,9 +6,9 @@ module NewRelic
6
6
  module Agent
7
7
  module Utilization
8
8
  class Azure < Vendor
9
- vendor_name "azure"
10
- endpoint "http://169.254.169.254/metadata/instance/compute?api-version=2017-03-01"
11
- headers "Metadata" => "true"
9
+ vendor_name 'azure'
10
+ endpoint 'http://169.254.169.254/metadata/instance/compute?api-version=2017-03-01'
11
+ headers 'Metadata' => 'true'
12
12
  keys %w[vmId name vmSize location]
13
13
  key_transforms :to_sym
14
14
  end
@@ -8,9 +8,9 @@ module NewRelic
8
8
  module Agent
9
9
  module Utilization
10
10
  class GCP < Vendor
11
- vendor_name "gcp"
12
- endpoint "http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true"
13
- headers "Metadata-Flavor" => "Google"
11
+ vendor_name 'gcp'
12
+ endpoint 'http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true'
13
+ headers 'Metadata-Flavor' => 'Google'
14
14
  keys %w[id machineType name zone]
15
15
  key_transforms :to_sym
16
16
 
@@ -8,7 +8,7 @@ module NewRelic
8
8
  module Agent
9
9
  module Utilization
10
10
  class PCF < Vendor
11
- vendor_name "pcf"
11
+ vendor_name 'pcf'
12
12
  keys %w[CF_INSTANCE_GUID CF_INSTANCE_IP MEMORY_LIMIT]
13
13
  key_transforms [:downcase, :to_sym]
14
14
 
@@ -133,7 +133,7 @@ module NewRelic
133
133
 
134
134
  def valid_chars?(value)
135
135
  value.each_char do |ch|
136
- next if ch =~ VALID_CHARS
136
+ next if VALID_CHARS.match?(ch)
137
137
 
138
138
  code_point = ch[0].ord # this works in Ruby 1.8.7 - 2.1.2
139
139
  next if code_point >= 0x80
@@ -34,7 +34,7 @@ module NewRelic
34
34
  end
35
35
  else
36
36
  NewRelic::Agent.logger.log_once(:warn, :gc_profiler_disabled,
37
- "Tried to measure GC time, but GC::Profiler was not enabled.")
37
+ 'Tried to measure GC time, but GC::Profiler was not enabled.')
38
38
  end
39
39
 
40
40
  @total_time_s
@@ -82,18 +82,19 @@ module NewRelic
82
82
 
83
83
  def supports?(key)
84
84
  case key
85
- when :gc_runs, :total_allocated_object, :heap_live, :heap_free, :thread_count
85
+ when :gc_runs,
86
+ :total_allocated_object,
87
+ :heap_live,
88
+ :heap_free,
89
+ :thread_count,
90
+ :major_gc_count,
91
+ :minor_gc_count,
92
+ :constant_cache_invalidations
86
93
  true
87
94
  when :gc_total_time
88
95
  NewRelic::LanguageSupport.gc_profiler_enabled?
89
- when :major_gc_count
90
- RUBY_VERSION >= '2.1.0'
91
- when :minor_gc_count
92
- RUBY_VERSION >= '2.1.0'
93
96
  when :method_cache_invalidations
94
- RUBY_VERSION >= '2.1.0' && RUBY_VERSION < '3.0.0'
95
- when :constant_cache_invalidations
96
- RUBY_VERSION >= '2.1.0'
97
+ RUBY_VERSION < '3.0.0'
97
98
  when :constant_cache_misses
98
99
  RUBY_VERSION >= '3.2.0'
99
100
  else
@@ -88,7 +88,7 @@ module NewRelic
88
88
  raise
89
89
  rescue => e
90
90
  # Don't blow out the stack for anything that hasn't already propagated
91
- ::NewRelic::Agent.logger.error("Error running task in Agent Worker Loop:", e)
91
+ ::NewRelic::Agent.logger.error('Error running task in Agent Worker Loop:', e)
92
92
  end
93
93
  end
94
94
  end
@@ -105,7 +105,10 @@ module NewRelic
105
105
  # placeholder name used when we cannot determine a transaction's name
106
106
  UNKNOWN_METRIC = '(unknown)'.freeze
107
107
 
108
+ attr_reader :error_group_callback
109
+
108
110
  @agent = nil
111
+ @error_group_callback = nil
109
112
  @logger = nil
110
113
  @tracer_lock = Mutex.new
111
114
  @tracer_queue = []
@@ -210,6 +213,8 @@ module NewRelic
210
213
  record_metric(metric_name, value)
211
214
  end
212
215
 
216
+ SUPPORTABILITY_INCREMENT_METRIC = 'Supportability/API/increment_metric'.freeze
217
+
213
218
  # Increment a simple counter metric.
214
219
  #
215
220
  # +metric_name+ should follow a slash separated path convention. Application
@@ -218,9 +223,7 @@ module NewRelic
218
223
  # This method is safe to use from any thread.
219
224
  #
220
225
  # @api public
221
-
222
- SUPPORTABILITY_INCREMENT_METRIC = 'Supportability/API/increment_metric'.freeze
223
-
226
+ #
224
227
  def increment_metric(metric_name, amount = 1) # THREAD_LOCAL_ACCESS
225
228
  return unless agent
226
229
 
@@ -293,6 +296,47 @@ module NewRelic
293
296
  nil # don't return a noticed error data structure. it can only hurt.
294
297
  end
295
298
 
299
+ # Set a callback proc for determining an error's error group name
300
+ #
301
+ # @param [Proc] the callback proc
302
+ #
303
+ # Typically this method should be called only once to set a callback for
304
+ # use with all noticed errors. If it is called multiple times, each new
305
+ # callback given will replace the old one.
306
+ #
307
+ # The proc will be called with a single hash as its input argument and is
308
+ # expected to return a string representing the desired error group.
309
+ #
310
+ # see https://docs.newrelic.com/docs/errors-inbox/errors-inbox/#groups
311
+ #
312
+ # The hash passed to the customer defined callback proc has the following
313
+ # keys:
314
+ #
315
+ # :error => The Ruby error class instance, likely inheriting from
316
+ # StandardError. Call `#class`, `#message`, and `#backtrace` on
317
+ # the error object to retrieve the error's class, message, and
318
+ # backtrace.
319
+ # :customAttributes => Any customer defined custom attributes that have been
320
+ # associated with the current transaction.
321
+ # :'request.uri' => The current request URI if available
322
+ # :'http.statusCode' => The HTTP status code (200, 404, etc.) if available
323
+ # :'http.method' => The HTTP method (GET, PUT, etc.) if available
324
+ # :'error.expected' => Whether (true) or not (false) the error was expected
325
+ # :options => The options hash passed to `NewRelic::Agent.notice_error`
326
+ #
327
+ # @api public
328
+ #
329
+ def set_error_group_callback(callback_proc)
330
+ unless callback_proc.is_a?(Proc)
331
+ NewRelic::Agent.logger.error("#{self}.#{__method__}: expected an argument of type Proc, " \
332
+ "got #{callback_proc.class}")
333
+ return
334
+ end
335
+
336
+ record_api_supportability_metric(:set_error_group_callback)
337
+ @error_group_callback = callback_proc
338
+ end
339
+
296
340
  # @!endgroup
297
341
 
298
342
  # @!group Recording custom Insights events
@@ -353,7 +397,7 @@ module NewRelic
353
397
  # @api public
354
398
  #
355
399
  def manual_start(options = {})
356
- raise "Options must be a hash" unless Hash === options
400
+ raise 'Options must be a hash' unless Hash === options
357
401
 
358
402
  NewRelic::Control.instance.init_plugin({:agent_enabled => true, :sync_startup => true}.merge(options))
359
403
  record_api_supportability_metric(:manual_start)
@@ -386,7 +430,8 @@ module NewRelic
386
430
  #
387
431
  def after_fork(options = {})
388
432
  record_api_supportability_metric(:after_fork)
389
- agent.after_fork(options) if agent
433
+ # the following line needs else branch coverage
434
+ agent.after_fork(options) if agent # rubocop:disable Style/SafeNavigation
390
435
  end
391
436
 
392
437
  # Shutdown the agent. Call this before exiting. Sends any queued data
@@ -398,7 +443,7 @@ module NewRelic
398
443
  #
399
444
  def shutdown(options = {})
400
445
  record_api_supportability_metric(:shutdown)
401
- agent.shutdown if agent
446
+ agent&.shutdown
402
447
  end
403
448
 
404
449
  # Clear out any data the agent has buffered but has not yet transmitted
@@ -406,7 +451,8 @@ module NewRelic
406
451
  #
407
452
  # @api public
408
453
  def drop_buffered_data
409
- agent.drop_buffered_data if agent
454
+ # the following line needs else branch coverage
455
+ agent.drop_buffered_data if agent # rubocop:disable Style/SafeNavigation
410
456
  record_api_supportability_metric(:drop_buffered_data)
411
457
  end
412
458
 
@@ -465,8 +511,7 @@ module NewRelic
465
511
  #
466
512
  def ignore_transaction
467
513
  record_api_supportability_metric(:ignore_transaction)
468
- txn = NewRelic::Agent::Transaction.tl_current
469
- txn.ignore! if txn
514
+ NewRelic::Agent::Transaction.tl_current&.ignore!
470
515
  end
471
516
 
472
517
  # This method disables the recording of Apdex metrics in the current
@@ -476,8 +521,7 @@ module NewRelic
476
521
  #
477
522
  def ignore_apdex
478
523
  record_api_supportability_metric(:ignore_apdex)
479
- txn = NewRelic::Agent::Transaction.tl_current
480
- txn.ignore_apdex! if txn
524
+ NewRelic::Agent::Transaction.tl_current&.ignore_apdex!
481
525
  end
482
526
 
483
527
  # This method disables browser monitoring javascript injection in the
@@ -487,8 +531,7 @@ module NewRelic
487
531
  #
488
532
  def ignore_enduser
489
533
  record_api_supportability_metric(:ignore_enduser)
490
- txn = NewRelic::Agent::Transaction.tl_current
491
- txn.ignore_enduser! if txn
534
+ NewRelic::Agent::Transaction.tl_current&.ignore_enduser!
492
535
  end
493
536
 
494
537
  # Yield to the block without collecting any metrics or traces in
@@ -564,8 +607,7 @@ module NewRelic
564
607
  record_api_supportability_metric(:add_custom_attributes)
565
608
 
566
609
  if params.is_a?(Hash)
567
- txn = Transaction.tl_current
568
- txn.add_custom_attributes(params) if txn
610
+ Transaction.tl_current&.add_custom_attributes(params)
569
611
 
570
612
  segment = ::NewRelic::Agent::Tracer.current_segment
571
613
  if segment
@@ -607,6 +649,26 @@ module NewRelic
607
649
  end
608
650
  end
609
651
 
652
+ # Set the user id for the current transaction. When present, this value will be included in the agent attributes for transaction and error events as 'enduser.id'.
653
+ #
654
+ # @param [String] user_id The user id to add to the current transaction attributes
655
+ #
656
+ # @api public
657
+ def set_user_id(user_id)
658
+ record_api_supportability_metric(:set_user_id)
659
+
660
+ if user_id.nil? || user_id.empty?
661
+ ::NewRelic::Agent.logger.warn('NewRelic::Agent.set_user_id called with a nil or empty user id.')
662
+ return
663
+ end
664
+
665
+ default_destinations = NewRelic::Agent::AttributeFilter::DST_TRANSACTION_TRACER |
666
+ NewRelic::Agent::AttributeFilter::DST_TRANSACTION_EVENTS |
667
+ NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
668
+
669
+ NewRelic::Agent::Transaction.add_agent_attribute(:'enduser.id', user_id, default_destinations)
670
+ end
671
+
610
672
  # @!endgroup
611
673
 
612
674
  # @!group Transaction naming
@@ -686,7 +748,7 @@ module NewRelic
686
748
  def notify(event_type, *args)
687
749
  agent.events.notify(event_type, *args)
688
750
  rescue
689
- NewRelic::Agent.logger.debug("Ignoring exception during %p event notification" % [event_type])
751
+ NewRelic::Agent.logger.debug('Ignoring exception during %p event notification' % [event_type])
690
752
  end
691
753
 
692
754
  # @!group Trace and Entity metadata
@@ -38,7 +38,7 @@ module NewRelic
38
38
  else
39
39
  # parse command line args. Throw an exception on a bad arg.
40
40
  @options = options do |opts|
41
- opts.on("-h", "Show this help") { raise CommandFailure, opts.to_s }
41
+ opts.on('-h', 'Show this help') { raise CommandFailure, opts.to_s }
42
42
  end
43
43
  @leftover = @options.parse(command_line_args)
44
44
  end
@@ -60,11 +60,11 @@ module NewRelic
60
60
  extra = []
61
61
  options = ARGV.options do |opts|
62
62
  script_name = File.basename($0)
63
- if script_name =~ /newrelic_cmd$/
63
+ if /newrelic_cmd$/.match?(script_name)
64
64
  $stdout.puts "warning: the 'newrelic_cmd' script has been renamed 'newrelic'"
65
65
  script_name = 'newrelic'
66
66
  end
67
- opts.banner = "Usage: #{script_name} [ #{@command_names.join(" | ")} ] [options]"
67
+ opts.banner = "Usage: #{script_name} [ #{@command_names.join(' | ')} ] [options]"
68
68
  opts.separator("use '#{script_name} <command> -h' to see detailed command options")
69
69
  opts
70
70
  end
@@ -16,7 +16,7 @@ require 'new_relic/control' unless defined? NewRelic::Control
16
16
 
17
17
  class NewRelic::Cli::Deployments < NewRelic::Cli::Command
18
18
  attr_reader :control
19
- def self.command; "deployments"; end
19
+ def self.command; 'deployments'; end
20
20
 
21
21
  # Initialize the deployment uploader with command line args.
22
22
  # Use -h to see options.
@@ -33,7 +33,8 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
33
33
  @changelog = nil
34
34
  @user = nil
35
35
  super(command_line_args)
36
- @description ||= @leftover && @leftover.join(" ")
36
+ # needs else branch coverage
37
+ @description ||= @leftover && @leftover.join(' ') # rubocop:disable Style/SafeNavigation
37
38
  @user ||= ENV['USER']
38
39
  control.env = @environment if @environment
39
40
 
@@ -71,17 +72,17 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
71
72
  end
72
73
 
73
74
  if !api_v1? && (@revision.nil? || @revision.empty?)
74
- raise "revision required when using New Relic REST API v2 with api_key. Pass in revision using: -r, --revision=REV"
75
+ raise 'revision required when using New Relic REST API v2 with api_key. Pass in revision using: -r, --revision=REV'
75
76
  end
76
77
 
77
78
  request = if api_v1?
78
- uri = "/deployments.xml"
79
- create_request(uri, {'x-license-key' => @license_key}, "application/octet-stream").tap do |req|
79
+ uri = '/deployments.xml'
80
+ create_request(uri, {'x-license-key' => @license_key}, 'application/octet-stream').tap do |req|
80
81
  set_params_v1(req)
81
82
  end
82
83
  else
83
84
  uri = "/v2/applications/#{application_id}/deployments.json"
84
- create_request(uri, {"Api-Key" => @api_key}, "application/json").tap do |req|
85
+ create_request(uri, {'Api-Key' => @api_key}, 'application/json').tap do |req|
85
86
  set_params_v2(req)
86
87
  end
87
88
  end
@@ -92,7 +93,7 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
92
93
  if response.is_a?(Net::HTTPSuccess)
93
94
  info("Recorded deployment to '#{@appname}' (#{@description || Time.now})")
94
95
  else
95
- err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join("; ") rescue response.message
96
+ err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join('; ') rescue response.message
96
97
  raise NewRelic::Cli::Command::CommandFailure, "Deployment not recorded: #{err_string}"
97
98
  end
98
99
  rescue SystemCallError, SocketError => e
@@ -150,7 +151,7 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
150
151
 
151
152
  def set_params_v2(request)
152
153
  request.body = {
153
- "deployment" => {
154
+ 'deployment' => {
154
155
  :description => @description,
155
156
  :user => @user,
156
157
  :revision => @revision,
@@ -161,25 +162,25 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
161
162
 
162
163
  def options
163
164
  OptionParser.new(%Q(Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] ), 40) do |o|
164
- o.separator("OPTIONS:")
165
- o.on("-a", "--appname=NAME", String,
166
- "Set the application name.",
167
- "Default is app_name setting in newrelic.yml. Available only when using API v1.") { |e| @appname = e }
168
- o.on("-i", "--appid=ID", String,
169
- "Set the application ID",
170
- "If not provided, will connect to the New Relic collector to get it") { |i| @application_id = i }
171
- o.on("-e", "--environment=name", String,
172
- "Override the (RAILS|RUBY|RACK)_ENV setting",
165
+ o.separator('OPTIONS:')
166
+ o.on('-a', '--appname=NAME', String,
167
+ 'Set the application name.',
168
+ 'Default is app_name setting in newrelic.yml. Available only when using API v1.') { |e| @appname = e }
169
+ o.on('-i', '--appid=ID', String,
170
+ 'Set the application ID',
171
+ 'If not provided, will connect to the New Relic collector to get it') { |i| @application_id = i }
172
+ o.on('-e', '--environment=name', String,
173
+ 'Override the (RAILS|RUBY|RACK)_ENV setting',
173
174
  "currently: #{control.env}") { |e| @environment = e }
174
- o.on("-u", "--user=USER", String,
175
- "Specify the user deploying, for information only",
175
+ o.on('-u', '--user=USER', String,
176
+ 'Specify the user deploying, for information only',
176
177
  "Default: #{@user || '<none>'}") { |u| @user = u }
177
- o.on("-r", "--revision=REV", String,
178
- "Specify the revision being deployed. Required when using New Relic REST API v2") { |r| @revision = r }
179
- o.on("-l", "--license-key=KEY", String,
180
- "Specify the license key of the account for the app being deployed") { |l| @license_key = l }
181
- o.on("-c", "--changes",
182
- "Read in a change log from the standard input") { @changelog = STDIN.read }
178
+ o.on('-r', '--revision=REV', String,
179
+ 'Specify the revision being deployed. Required when using New Relic REST API v2') { |r| @revision = r }
180
+ o.on('-l', '--license-key=KEY', String,
181
+ 'Specify the license key of the account for the app being deployed') { |l| @license_key = l }
182
+ o.on('-c', '--changes',
183
+ 'Read in a change log from the standard input') { @changelog = STDIN.read }
183
184
  yield(o) if block_given?
184
185
  end
185
186
  end
@@ -7,9 +7,9 @@ require 'new_relic/version'
7
7
  require 'erb'
8
8
 
9
9
  class NewRelic::Cli::Install < NewRelic::Cli::Command
10
- NO_LICENSE_KEY = "<PASTE LICENSE KEY HERE>"
10
+ NO_LICENSE_KEY = '<PASTE LICENSE KEY HERE>'
11
11
 
12
- def self.command; "install"; end
12
+ def self.command; 'install'; end
13
13
 
14
14
  # Use -h to see options.
15
15
  # When command_line_args is a hash, we are invoking directly and
@@ -25,22 +25,22 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
25
25
  super(command_line_args)
26
26
  if @dest_dir.nil?
27
27
  # Install a newrelic.yml file into the local config directory.
28
- if File.directory?("config")
29
- @dest_dir = "config"
28
+ if File.directory?('config')
29
+ @dest_dir = 'config'
30
30
  else
31
- @dest_dir = "."
31
+ @dest_dir = '.'
32
32
  end
33
33
  end
34
34
  @license_key ||= NO_LICENSE_KEY
35
- @app_name ||= @leftover.join(" ")
35
+ @app_name ||= @leftover.join(' ')
36
36
  @agent_version = NewRelic::VERSION::STRING
37
- raise CommandFailure.new("Application name required.", @options) unless @app_name && @app_name.size > 0
37
+ raise CommandFailure.new('Application name required.', @options) unless @app_name && @app_name.size > 0
38
38
  end
39
39
 
40
40
  def run
41
- dest_file = File.expand_path(@dest_dir + "/newrelic.yml")
41
+ dest_file = File.expand_path(@dest_dir + '/newrelic.yml')
42
42
  if File.exist?(dest_file) && !@force
43
- raise NewRelic::Cli::Command::CommandFailure, "newrelic.yml file already exists. Use --force flag to overwrite."
43
+ raise NewRelic::Cli::Command::CommandFailure, 'newrelic.yml file already exists. Use --force flag to overwrite.'
44
44
  end
45
45
 
46
46
  File.open(dest_file, 'w') { |out| out.puts(content) }
@@ -63,7 +63,7 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
63
63
  end
64
64
 
65
65
  def content
66
- @src_file ||= File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "newrelic.yml"))
66
+ @src_file ||= File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'newrelic.yml'))
67
67
  template = File.read(@src_file)
68
68
  ERB.new(template).result(binding)
69
69
  end
@@ -72,10 +72,10 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
72
72
 
73
73
  def options
74
74
  OptionParser.new("Usage: #{$0} #{self.class.command} [ OPTIONS] 'application name'", 40) do |o|
75
- o.on("-f", "--force", "Overwrite newrelic.yml if it exists") { |e| @force = true }
76
- o.on("-l", "--license_key=NAME", String,
77
- "Use the given license key") { |e| @license_key = e }
78
- o.on("-d", "--destdir=name", String,
75
+ o.on('-f', '--force', 'Overwrite newrelic.yml if it exists') { |e| @force = true }
76
+ o.on('-l', '--license_key=NAME', String,
77
+ 'Use the given license key') { |e| @license_key = e }
78
+ o.on('-d', '--destdir=name', String,
79
79
  "Write the newrelic.yml to the given directory, default is '.'") { |e| @dest_dir = e }
80
80
  yield(o) if block_given?
81
81
  end
@@ -40,7 +40,7 @@ module NewRelic
40
40
  when nil then ''
41
41
  when object.instance_of?(String) then object
42
42
  when String then String.new(object) # convert string subclasses to strings
43
- else String.new("#<#{object.class}>")
43
+ else +"#<#{object.class}>"
44
44
  end
45
45
  end
46
46
 
@@ -52,7 +52,7 @@ module NewRelic
52
52
  real_string = flatten(string)
53
53
  if real_string.size > len
54
54
  real_string = real_string.slice(0...len)
55
- real_string << "..."
55
+ real_string << '...'
56
56
  end
57
57
  real_string
58
58
  else
@@ -7,16 +7,16 @@ module NewRelic
7
7
 
8
8
  EMPTY_ARRAY = [].freeze
9
9
  EMPTY_HASH = {}.freeze
10
- EMPTY_STR = ""
10
+ EMPTY_STR = ''
11
11
 
12
- HTTP = "HTTP"
13
- HTTPS = "HTTPS"
14
- UNKNOWN = "Unknown"
12
+ HTTP = 'HTTP'
13
+ HTTPS = 'HTTPS'
14
+ UNKNOWN = 'Unknown'
15
15
 
16
16
  FORMAT_NON_RACK = 0
17
17
  FORMAT_RACK = 1
18
18
 
19
- NEWRELIC_KEY = "newrelic"
19
+ NEWRELIC_KEY = 'newrelic'
20
20
  CANDIDATE_NEWRELIC_KEYS = [
21
21
  NEWRELIC_KEY,
22
22
  'NEWRELIC',
@@ -24,8 +24,8 @@ module NewRelic
24
24
  'Newrelic'
25
25
  ].freeze
26
26
 
27
- TRACEPARENT_KEY = "traceparent"
28
- TRACESTATE_KEY = "tracestate"
27
+ TRACEPARENT_KEY = 'traceparent'
28
+ TRACESTATE_KEY = 'tracestate'
29
29
 
30
30
  STANDARD_OUT = 'STDOUT'
31
31
 
@@ -34,6 +34,5 @@ module NewRelic
34
34
  HTTP_NEWRELIC_KEY = "HTTP_#{NEWRELIC_KEY.upcase}"
35
35
 
36
36
  CONNECT_RETRY_PERIODS = [15, 15, 30, 60, 120, 300]
37
- MIN_RETRY_PERIOD = 15
38
37
  MAX_RETRY_PERIOD = 300
39
38
  end
@@ -35,8 +35,8 @@ module NewRelic
35
35
 
36
36
  # nb this does not 'load test' the framework, it loads the 'test framework'
37
37
  def load_test_framework
38
- config = File.expand_path(File.join('..', '..', '..', '..', "test", "config", "newrelic.yml"), __FILE__)
39
- require "config/test_control"
38
+ config = File.expand_path(File.join('..', '..', '..', '..', 'test', 'config', 'newrelic.yml'), __FILE__)
39
+ require 'config/test_control'
40
40
  NewRelic::Control::Frameworks::Test.new(local_env, config)
41
41
  end
42
42
 
@@ -54,7 +54,7 @@ module NewRelic
54
54
 
55
55
  # The root directory for the plugin or gem
56
56
  def newrelic_root
57
- File.expand_path(File.join("..", "..", "..", ".."), __FILE__)
57
+ File.expand_path(File.join('..', '..', '..', '..'), __FILE__)
58
58
  end
59
59
 
60
60
  def camelize(snake_case_name)