newrelic_rpm 6.15.0 → 8.13.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (427) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +7 -1
  3. data/.rubocop.yml +1817 -0
  4. data/.rubocop_todo.yml +59 -0
  5. data/.simplecov +15 -0
  6. data/.snyk +11 -0
  7. data/.yardopts +1 -0
  8. data/Brewfile +12 -0
  9. data/CHANGELOG.md +754 -40
  10. data/CONTRIBUTING.md +32 -5
  11. data/DOCKER.md +167 -0
  12. data/Dockerfile +10 -0
  13. data/Gemfile +0 -1
  14. data/Guardfile +9 -8
  15. data/LICENSE +0 -6
  16. data/README.md +21 -20
  17. data/Rakefile +27 -29
  18. data/THIRD_PARTY_NOTICES.md +14 -199
  19. data/Thorfile +5 -0
  20. data/bin/newrelic +3 -2
  21. data/bin/newrelic_cmd +1 -0
  22. data/bin/nrdebug +76 -53
  23. data/config.dot +5 -5
  24. data/docker-compose.yml +107 -0
  25. data/init.rb +4 -6
  26. data/install.rb +2 -2
  27. data/lefthook.yml +9 -0
  28. data/lib/new_relic/agent/adaptive_sampler.rb +13 -9
  29. data/lib/new_relic/agent/agent/shutdown.rb +35 -0
  30. data/lib/new_relic/agent/agent/special_startup.rb +72 -0
  31. data/lib/new_relic/agent/agent/start_worker_thread.rb +163 -0
  32. data/lib/new_relic/agent/agent/startup.rb +197 -0
  33. data/lib/new_relic/agent/agent.rb +178 -555
  34. data/lib/new_relic/agent/agent_logger.rb +23 -19
  35. data/lib/new_relic/agent/attribute_filter.rb +66 -47
  36. data/lib/new_relic/agent/attribute_processing.rb +7 -7
  37. data/lib/new_relic/agent/attributes.rb +5 -4
  38. data/lib/new_relic/agent/audit_logger.rb +8 -3
  39. data/lib/new_relic/agent/autostart.rb +20 -19
  40. data/lib/new_relic/agent/chained_call.rb +1 -1
  41. data/lib/new_relic/agent/commands/agent_command.rb +3 -3
  42. data/lib/new_relic/agent/commands/agent_command_router.rb +12 -11
  43. data/lib/new_relic/agent/commands/thread_profiler_session.rb +9 -7
  44. data/lib/new_relic/agent/configuration/default_source.rb +1728 -1194
  45. data/lib/new_relic/agent/configuration/dotted_hash.rb +6 -5
  46. data/lib/new_relic/agent/configuration/environment_source.rb +11 -9
  47. data/lib/new_relic/agent/configuration/event_harvest_config.rb +40 -17
  48. data/lib/new_relic/agent/configuration/high_security_source.rb +9 -8
  49. data/lib/new_relic/agent/configuration/manager.rb +82 -69
  50. data/lib/new_relic/agent/configuration/manual_source.rb +1 -1
  51. data/lib/new_relic/agent/configuration/mask_defaults.rb +3 -3
  52. data/lib/new_relic/agent/configuration/security_policy_source.rb +90 -77
  53. data/lib/new_relic/agent/configuration/server_source.rb +21 -19
  54. data/lib/new_relic/agent/configuration/yaml_source.rb +31 -7
  55. data/lib/new_relic/agent/configuration.rb +1 -1
  56. data/lib/new_relic/agent/connect/request_builder.rb +18 -18
  57. data/lib/new_relic/agent/connect/response_handler.rb +5 -8
  58. data/lib/new_relic/agent/custom_event_aggregator.rb +14 -14
  59. data/lib/new_relic/agent/database/explain_plan_helpers.rb +4 -5
  60. data/lib/new_relic/agent/database/obfuscation_helpers.rb +14 -13
  61. data/lib/new_relic/agent/database/obfuscator.rb +2 -2
  62. data/lib/new_relic/agent/database/postgres_explain_obfuscator.rb +3 -3
  63. data/lib/new_relic/agent/database.rb +53 -47
  64. data/lib/new_relic/agent/database_adapter.rb +3 -1
  65. data/lib/new_relic/agent/datastores/metric_helper.rb +17 -18
  66. data/lib/new_relic/agent/datastores/mongo/event_formatter.rb +7 -6
  67. data/lib/new_relic/agent/datastores/mongo/metric_translator.rb +6 -10
  68. data/lib/new_relic/agent/datastores/mongo.rb +6 -11
  69. data/lib/new_relic/agent/datastores/nosql_obfuscator.rb +41 -0
  70. data/lib/new_relic/agent/datastores/redis.rb +5 -11
  71. data/lib/new_relic/agent/datastores.rb +11 -13
  72. data/lib/new_relic/agent/deprecator.rb +1 -1
  73. data/lib/new_relic/agent/distributed_tracing/cross_app_payload.rb +10 -10
  74. data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb +39 -32
  75. data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +22 -22
  76. data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb +19 -19
  77. data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb +50 -52
  78. data/lib/new_relic/agent/distributed_tracing/distributed_trace_transport_type.rb +5 -6
  79. data/lib/new_relic/agent/distributed_tracing/trace_context.rb +76 -77
  80. data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +39 -38
  81. data/lib/new_relic/agent/distributed_tracing.rb +32 -100
  82. data/lib/new_relic/agent/encoding_normalizer.rb +4 -2
  83. data/lib/new_relic/agent/error_collector.rb +73 -54
  84. data/lib/new_relic/agent/error_event_aggregator.rb +4 -5
  85. data/lib/new_relic/agent/error_filter.rb +174 -0
  86. data/lib/new_relic/agent/error_trace_aggregator.rb +4 -3
  87. data/lib/new_relic/agent/event_aggregator.rb +22 -21
  88. data/lib/new_relic/agent/event_buffer.rb +7 -8
  89. data/lib/new_relic/agent/event_listener.rb +1 -2
  90. data/lib/new_relic/agent/event_loop.rb +25 -23
  91. data/lib/new_relic/agent/external.rb +11 -44
  92. data/lib/new_relic/agent/guid_generator.rb +4 -11
  93. data/lib/new_relic/agent/harvester.rb +4 -5
  94. data/lib/new_relic/agent/heap.rb +6 -8
  95. data/lib/new_relic/agent/hostname.rb +20 -13
  96. data/lib/new_relic/agent/http_clients/abstract.rb +10 -11
  97. data/lib/new_relic/agent/http_clients/curb_wrappers.rb +6 -11
  98. data/lib/new_relic/agent/http_clients/excon_wrappers.rb +8 -9
  99. data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb +4 -5
  100. data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb +2 -4
  101. data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +8 -4
  102. data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb +4 -5
  103. data/lib/new_relic/agent/http_clients/uri_util.rb +1 -3
  104. data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb +8 -8
  105. data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +38 -31
  106. data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb +12 -13
  107. data/lib/new_relic/agent/instrumentation/active_job.rb +14 -7
  108. data/lib/new_relic/agent/instrumentation/active_merchant.rb +20 -6
  109. data/lib/new_relic/agent/instrumentation/active_record.rb +29 -27
  110. data/lib/new_relic/agent/instrumentation/active_record_helper.rb +71 -61
  111. data/lib/new_relic/agent/instrumentation/active_record_notifications.rb +31 -44
  112. data/lib/new_relic/agent/instrumentation/active_record_prepend.rb +4 -4
  113. data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +27 -20
  114. data/lib/new_relic/agent/instrumentation/active_storage.rb +2 -2
  115. data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb +18 -15
  116. data/lib/new_relic/agent/instrumentation/active_support_logger/chain.rb +23 -0
  117. data/lib/new_relic/agent/instrumentation/active_support_logger/instrumentation.rb +20 -0
  118. data/lib/new_relic/agent/instrumentation/active_support_logger/prepend.rb +12 -0
  119. data/lib/new_relic/agent/instrumentation/active_support_logger.rb +24 -0
  120. data/lib/new_relic/agent/instrumentation/acts_as_solr.rb +18 -10
  121. data/lib/new_relic/agent/instrumentation/authlogic.rb +10 -2
  122. data/lib/new_relic/agent/instrumentation/bunny/chain.rb +45 -0
  123. data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb +150 -0
  124. data/lib/new_relic/agent/instrumentation/bunny/prepend.rb +35 -0
  125. data/lib/new_relic/agent/instrumentation/bunny.rb +11 -154
  126. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +68 -58
  127. data/lib/new_relic/agent/instrumentation/curb/chain.rb +91 -0
  128. data/lib/new_relic/agent/instrumentation/curb/instrumentation.rb +221 -0
  129. data/lib/new_relic/agent/instrumentation/curb/prepend.rb +61 -0
  130. data/lib/new_relic/agent/instrumentation/curb.rb +11 -243
  131. data/lib/new_relic/agent/instrumentation/data_mapper.rb +65 -54
  132. data/lib/new_relic/agent/instrumentation/delayed_job/chain.rb +35 -0
  133. data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb +48 -0
  134. data/lib/new_relic/agent/instrumentation/delayed_job/prepend.rb +33 -0
  135. data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb +29 -53
  136. data/lib/new_relic/agent/instrumentation/elasticsearch/chain.rb +29 -0
  137. data/lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb +66 -0
  138. data/lib/new_relic/agent/instrumentation/elasticsearch/prepend.rb +13 -0
  139. data/lib/new_relic/agent/instrumentation/elasticsearch.rb +31 -0
  140. data/lib/new_relic/agent/instrumentation/excon/middleware.rb +5 -5
  141. data/lib/new_relic/agent/instrumentation/excon.rb +22 -24
  142. data/lib/new_relic/agent/instrumentation/grape/chain.rb +24 -0
  143. data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb +100 -0
  144. data/lib/new_relic/agent/instrumentation/grape/prepend.rb +17 -0
  145. data/lib/new_relic/agent/instrumentation/grape.rb +11 -112
  146. data/lib/new_relic/agent/instrumentation/grpc/client/chain.rb +97 -0
  147. data/lib/new_relic/agent/instrumentation/grpc/client/instrumentation.rb +89 -0
  148. data/lib/new_relic/agent/instrumentation/grpc/client/prepend.rb +111 -0
  149. data/lib/new_relic/agent/instrumentation/grpc/client/request_wrapper.rb +30 -0
  150. data/lib/new_relic/agent/instrumentation/grpc/helper.rb +32 -0
  151. data/lib/new_relic/agent/instrumentation/grpc/server/chain.rb +69 -0
  152. data/lib/new_relic/agent/instrumentation/grpc/server/instrumentation.rb +134 -0
  153. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_desc_prepend.rb +35 -0
  154. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_server_prepend.rb +26 -0
  155. data/lib/new_relic/agent/instrumentation/grpc_client.rb +23 -0
  156. data/lib/new_relic/agent/instrumentation/grpc_server.rb +25 -0
  157. data/lib/new_relic/agent/instrumentation/httpclient/chain.rb +24 -0
  158. data/lib/new_relic/agent/instrumentation/httpclient/instrumentation.rb +37 -0
  159. data/lib/new_relic/agent/instrumentation/httpclient/prepend.rb +15 -0
  160. data/lib/new_relic/agent/instrumentation/httpclient.rb +10 -32
  161. data/lib/new_relic/agent/instrumentation/httprb/chain.rb +22 -0
  162. data/lib/new_relic/agent/instrumentation/httprb/instrumentation.rb +30 -0
  163. data/lib/new_relic/agent/instrumentation/httprb/prepend.rb +15 -0
  164. data/lib/new_relic/agent/instrumentation/httprb.rb +29 -0
  165. data/lib/new_relic/agent/instrumentation/ignore_actions.rb +4 -5
  166. data/lib/new_relic/agent/instrumentation/logger/chain.rb +21 -0
  167. data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb +66 -0
  168. data/lib/new_relic/agent/instrumentation/logger/prepend.rb +13 -0
  169. data/lib/new_relic/agent/instrumentation/logger.rb +26 -0
  170. data/lib/new_relic/agent/instrumentation/memcache/chain.rb +15 -0
  171. data/lib/new_relic/agent/instrumentation/memcache/dalli.rb +57 -128
  172. data/lib/new_relic/agent/instrumentation/memcache/helper.rb +59 -0
  173. data/lib/new_relic/agent/instrumentation/memcache/instrumentation.rb +90 -0
  174. data/lib/new_relic/agent/instrumentation/memcache/prepend.rb +101 -0
  175. data/lib/new_relic/agent/instrumentation/memcache.rb +56 -72
  176. data/lib/new_relic/agent/instrumentation/middleware_proxy.rb +13 -12
  177. data/lib/new_relic/agent/instrumentation/middleware_tracing.rb +5 -7
  178. data/lib/new_relic/agent/instrumentation/mongo.rb +5 -136
  179. data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb +21 -18
  180. data/lib/new_relic/agent/instrumentation/net_http/chain.rb +24 -0
  181. data/lib/new_relic/agent/instrumentation/{net_prepend.rb → net_http/instrumentation.rb} +13 -13
  182. data/lib/new_relic/agent/instrumentation/net_http/prepend.rb +21 -0
  183. data/lib/new_relic/agent/instrumentation/net_http.rb +44 -0
  184. data/lib/new_relic/agent/instrumentation/notifications_subscriber.rb +10 -9
  185. data/lib/new_relic/agent/instrumentation/padrino/chain.rb +38 -0
  186. data/lib/new_relic/agent/instrumentation/padrino/instrumentation.rb +28 -0
  187. data/lib/new_relic/agent/instrumentation/padrino/prepend.rb +20 -0
  188. data/lib/new_relic/agent/instrumentation/padrino.rb +20 -58
  189. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +3 -3
  190. data/lib/new_relic/agent/instrumentation/queue_time.rb +8 -9
  191. data/lib/new_relic/agent/instrumentation/rack/chain.rb +66 -0
  192. data/lib/new_relic/agent/instrumentation/rack/helpers.rb +33 -0
  193. data/lib/new_relic/agent/instrumentation/rack/instrumentation.rb +75 -0
  194. data/lib/new_relic/agent/instrumentation/rack/prepend.rb +43 -0
  195. data/lib/new_relic/agent/instrumentation/rack.rb +30 -140
  196. data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +16 -52
  197. data/lib/new_relic/agent/instrumentation/rails_middleware.rb +1 -1
  198. data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb +5 -4
  199. data/lib/new_relic/agent/instrumentation/rails_notifications/action_controller.rb +3 -3
  200. data/lib/new_relic/agent/instrumentation/rails_notifications/action_view.rb +3 -2
  201. data/lib/new_relic/agent/instrumentation/rainbows_instrumentation.rb +13 -3
  202. data/lib/new_relic/agent/instrumentation/rake/chain.rb +20 -0
  203. data/lib/new_relic/agent/instrumentation/rake/instrumentation.rb +149 -0
  204. data/lib/new_relic/agent/instrumentation/rake/prepend.rb +14 -0
  205. data/lib/new_relic/agent/instrumentation/rake.rb +16 -157
  206. data/lib/new_relic/agent/instrumentation/redis/chain.rb +45 -0
  207. data/lib/new_relic/agent/instrumentation/redis/constants.rb +17 -0
  208. data/lib/new_relic/agent/instrumentation/redis/instrumentation.rb +72 -0
  209. data/lib/new_relic/agent/instrumentation/redis/middleware.rb +16 -0
  210. data/lib/new_relic/agent/instrumentation/redis/prepend.rb +29 -0
  211. data/lib/new_relic/agent/instrumentation/redis.rb +18 -107
  212. data/lib/new_relic/agent/instrumentation/resque/chain.rb +21 -0
  213. data/lib/new_relic/agent/instrumentation/resque/helper.rb +19 -0
  214. data/lib/new_relic/agent/instrumentation/resque/instrumentation.rb +34 -0
  215. data/lib/new_relic/agent/instrumentation/resque/prepend.rb +15 -0
  216. data/lib/new_relic/agent/instrumentation/resque.rb +28 -39
  217. data/lib/new_relic/agent/instrumentation/sequel.rb +14 -16
  218. data/lib/new_relic/agent/instrumentation/sequel_helper.rb +2 -2
  219. data/lib/new_relic/agent/instrumentation/sidekiq/client.rb +20 -0
  220. data/lib/new_relic/agent/instrumentation/sidekiq/extensions/delayed_class.rb +30 -0
  221. data/lib/new_relic/agent/instrumentation/sidekiq/server.rb +37 -0
  222. data/lib/new_relic/agent/instrumentation/sidekiq.rb +23 -64
  223. data/lib/new_relic/agent/instrumentation/sinatra/chain.rb +55 -0
  224. data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb +30 -36
  225. data/lib/new_relic/agent/instrumentation/sinatra/instrumentation.rb +125 -0
  226. data/lib/new_relic/agent/instrumentation/sinatra/prepend.rb +33 -0
  227. data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb +2 -2
  228. data/lib/new_relic/agent/instrumentation/sinatra.rb +34 -163
  229. data/lib/new_relic/agent/instrumentation/sunspot.rb +11 -3
  230. data/lib/new_relic/agent/instrumentation/thread/chain.rb +24 -0
  231. data/lib/new_relic/agent/instrumentation/thread/instrumentation.rb +28 -0
  232. data/lib/new_relic/agent/instrumentation/thread/prepend.rb +22 -0
  233. data/lib/new_relic/agent/instrumentation/thread.rb +20 -0
  234. data/lib/new_relic/agent/instrumentation/tilt/chain.rb +24 -0
  235. data/lib/new_relic/agent/instrumentation/tilt/instrumentation.rb +41 -0
  236. data/lib/new_relic/agent/instrumentation/tilt/prepend.rb +13 -0
  237. data/lib/new_relic/agent/instrumentation/tilt.rb +25 -0
  238. data/lib/new_relic/agent/instrumentation/typhoeus/chain.rb +22 -0
  239. data/lib/new_relic/agent/instrumentation/typhoeus/instrumentation.rb +80 -0
  240. data/lib/new_relic/agent/instrumentation/typhoeus/prepend.rb +14 -0
  241. data/lib/new_relic/agent/instrumentation/typhoeus.rb +12 -91
  242. data/lib/new_relic/agent/instrumentation.rb +1 -1
  243. data/lib/new_relic/agent/internal_agent_error.rb +2 -2
  244. data/lib/new_relic/agent/javascript_instrumentor.rb +47 -41
  245. data/lib/new_relic/agent/linking_metadata.rb +44 -0
  246. data/lib/new_relic/agent/local_log_decorator.rb +37 -0
  247. data/lib/new_relic/agent/log_event_aggregator.rb +235 -0
  248. data/lib/new_relic/agent/log_once.rb +1 -1
  249. data/lib/new_relic/agent/log_priority.rb +20 -0
  250. data/lib/new_relic/agent/logging.rb +24 -21
  251. data/lib/new_relic/agent/memory_logger.rb +2 -2
  252. data/lib/new_relic/agent/messaging.rb +65 -81
  253. data/lib/new_relic/agent/method_tracer.rb +154 -149
  254. data/lib/new_relic/agent/method_tracer_helpers.rb +85 -3
  255. data/lib/new_relic/agent/monitors/cross_app_monitor.rb +25 -17
  256. data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb +5 -4
  257. data/lib/new_relic/agent/monitors/inbound_request_monitor.rb +1 -2
  258. data/lib/new_relic/agent/monitors/synthetics_monitor.rb +6 -9
  259. data/lib/new_relic/agent/monitors.rb +6 -7
  260. data/lib/new_relic/agent/new_relic_service/encoders.rb +6 -6
  261. data/lib/new_relic/agent/new_relic_service/json_marshaller.rb +5 -5
  262. data/lib/new_relic/agent/new_relic_service/marshaller.rb +2 -2
  263. data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb +5 -4
  264. data/lib/new_relic/agent/new_relic_service.rb +248 -196
  265. data/lib/new_relic/agent/{noticible_error.rb → noticeable_error.rb} +2 -5
  266. data/lib/new_relic/agent/null_logger.rb +7 -3
  267. data/lib/new_relic/agent/obfuscator.rb +8 -10
  268. data/lib/new_relic/agent/parameter_filtering.rb +24 -10
  269. data/lib/new_relic/agent/payload_metric_mapping.rb +9 -10
  270. data/lib/new_relic/agent/pipe_channel_manager.rb +27 -17
  271. data/lib/new_relic/agent/pipe_service.rb +8 -5
  272. data/lib/new_relic/agent/prepend_supportability.rb +2 -2
  273. data/lib/new_relic/agent/priority_sampled_buffer.rb +8 -11
  274. data/lib/new_relic/agent/range_extensions.rb +8 -28
  275. data/lib/new_relic/agent/rules_engine/replacement_rule.rb +11 -11
  276. data/lib/new_relic/agent/rules_engine/segment_terms_rule.rb +13 -13
  277. data/lib/new_relic/agent/rules_engine.rb +5 -4
  278. data/lib/new_relic/agent/sampler.rb +3 -4
  279. data/lib/new_relic/agent/sampler_collection.rb +3 -4
  280. data/lib/new_relic/agent/samplers/cpu_sampler.rb +3 -2
  281. data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +12 -9
  282. data/lib/new_relic/agent/samplers/memory_sampler.rb +24 -13
  283. data/lib/new_relic/agent/samplers/object_sampler.rb +1 -1
  284. data/lib/new_relic/agent/samplers/vm_sampler.rb +21 -19
  285. data/lib/new_relic/agent/span_event_aggregator.rb +12 -12
  286. data/lib/new_relic/agent/span_event_primitive.rb +62 -56
  287. data/lib/new_relic/agent/sql_sampler.rb +18 -18
  288. data/lib/new_relic/agent/stats.rb +78 -41
  289. data/lib/new_relic/agent/stats_engine/gc_profiler.rb +9 -11
  290. data/lib/new_relic/agent/stats_engine/stats_hash.rb +12 -13
  291. data/lib/new_relic/agent/stats_engine.rb +8 -8
  292. data/lib/new_relic/agent/synthetics_event_aggregator.rb +7 -8
  293. data/lib/new_relic/agent/system_info.rb +85 -65
  294. data/lib/new_relic/agent/threading/agent_thread.rb +18 -14
  295. data/lib/new_relic/agent/threading/backtrace_node.rb +12 -13
  296. data/lib/new_relic/agent/threading/backtrace_service.rb +14 -14
  297. data/lib/new_relic/agent/threading/thread_profile.rb +23 -23
  298. data/lib/new_relic/agent/timestamp_sampled_buffer.rb +1 -1
  299. data/lib/new_relic/agent/tracer.rb +76 -85
  300. data/lib/new_relic/agent/transaction/abstract_segment.rb +103 -40
  301. data/lib/new_relic/agent/transaction/datastore_segment.rb +21 -17
  302. data/lib/new_relic/agent/transaction/distributed_tracer.rb +63 -56
  303. data/lib/new_relic/agent/transaction/distributed_tracing.rb +43 -44
  304. data/lib/new_relic/agent/transaction/external_request_segment.rb +44 -34
  305. data/lib/new_relic/agent/transaction/message_broker_segment.rb +31 -36
  306. data/lib/new_relic/agent/transaction/request_attributes.rb +35 -35
  307. data/lib/new_relic/agent/transaction/segment.rb +14 -10
  308. data/lib/new_relic/agent/transaction/slowest_sample_buffer.rb +1 -3
  309. data/lib/new_relic/agent/transaction/synthetics_sample_buffer.rb +1 -1
  310. data/lib/new_relic/agent/transaction/trace.rb +15 -11
  311. data/lib/new_relic/agent/transaction/trace_builder.rb +10 -10
  312. data/lib/new_relic/agent/transaction/trace_context.rb +35 -35
  313. data/lib/new_relic/agent/transaction/trace_node.rb +25 -24
  314. data/lib/new_relic/agent/transaction/tracing.rb +14 -11
  315. data/lib/new_relic/agent/transaction/transaction_sample_buffer.rb +4 -4
  316. data/lib/new_relic/agent/transaction.rb +164 -145
  317. data/lib/new_relic/agent/transaction_error_primitive.rb +27 -25
  318. data/lib/new_relic/agent/transaction_event_aggregator.rb +12 -12
  319. data/lib/new_relic/agent/transaction_event_primitive.rb +32 -33
  320. data/lib/new_relic/agent/transaction_event_recorder.rb +16 -15
  321. data/lib/new_relic/agent/transaction_metrics.rb +10 -9
  322. data/lib/new_relic/agent/transaction_sampler.rb +5 -6
  323. data/lib/new_relic/agent/transaction_time_aggregator.rb +26 -25
  324. data/lib/new_relic/agent/utilization/aws.rb +33 -3
  325. data/lib/new_relic/agent/utilization/azure.rb +3 -3
  326. data/lib/new_relic/agent/utilization/gcp.rb +7 -7
  327. data/lib/new_relic/agent/utilization/pcf.rb +5 -4
  328. data/lib/new_relic/agent/utilization/vendor.rb +43 -28
  329. data/lib/new_relic/agent/utilization_data.rb +7 -5
  330. data/lib/new_relic/agent/vm/jruby_vm.rb +1 -1
  331. data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb +2 -2
  332. data/lib/new_relic/agent/vm/mri_vm.rb +40 -15
  333. data/lib/new_relic/agent/vm/snapshot.rb +5 -5
  334. data/lib/new_relic/agent/vm.rb +1 -1
  335. data/lib/new_relic/agent/worker_loop.rb +10 -12
  336. data/lib/new_relic/agent.rb +64 -75
  337. data/lib/new_relic/cli/command.rb +20 -22
  338. data/lib/new_relic/cli/commands/deployments.rb +92 -42
  339. data/lib/new_relic/cli/commands/install.rb +12 -15
  340. data/lib/new_relic/coerce.rb +15 -13
  341. data/lib/new_relic/collection_helper.rb +50 -48
  342. data/lib/new_relic/constants.rb +1 -4
  343. data/lib/new_relic/control/class_methods.rb +3 -3
  344. data/lib/new_relic/control/frameworks/external.rb +2 -2
  345. data/lib/new_relic/control/frameworks/rails.rb +23 -17
  346. data/lib/new_relic/control/frameworks/rails3.rb +3 -4
  347. data/lib/new_relic/control/frameworks/rails4.rb +1 -1
  348. data/lib/new_relic/control/frameworks/rails_notifications.rb +1 -1
  349. data/lib/new_relic/control/frameworks/ruby.rb +3 -3
  350. data/lib/new_relic/control/frameworks/sinatra.rb +7 -1
  351. data/lib/new_relic/control/frameworks.rb +1 -1
  352. data/lib/new_relic/control/instance_methods.rb +23 -45
  353. data/lib/new_relic/control/instrumentation.rb +39 -11
  354. data/lib/new_relic/control/private_instance_methods.rb +48 -0
  355. data/lib/new_relic/control/server_methods.rb +3 -4
  356. data/lib/new_relic/control.rb +1 -2
  357. data/lib/new_relic/delayed_job_injection.rb +1 -1
  358. data/lib/new_relic/dependency_detection.rb +126 -19
  359. data/lib/new_relic/environment_report.rb +40 -32
  360. data/lib/new_relic/helper.rb +48 -7
  361. data/lib/new_relic/language_support.rb +29 -5
  362. data/lib/new_relic/latest_changes.rb +7 -6
  363. data/lib/new_relic/local_environment.rb +24 -18
  364. data/lib/new_relic/metric_data.rb +31 -26
  365. data/lib/new_relic/metric_spec.rb +8 -6
  366. data/lib/new_relic/noticed_error.rb +22 -30
  367. data/lib/new_relic/rack/agent_hooks.rb +1 -1
  368. data/lib/new_relic/rack/agent_middleware.rb +5 -3
  369. data/lib/new_relic/rack/browser_monitoring.rb +133 -123
  370. data/lib/new_relic/rack.rb +1 -1
  371. data/lib/new_relic/recipes/capistrano3.rb +3 -61
  372. data/lib/new_relic/recipes/capistrano_legacy.rb +23 -26
  373. data/lib/new_relic/recipes/helpers/send_deployment.rb +69 -0
  374. data/lib/new_relic/recipes.rb +1 -1
  375. data/lib/new_relic/supportability_helper.rb +9 -10
  376. data/lib/new_relic/traced_thread.rb +35 -0
  377. data/lib/new_relic/version.rb +6 -17
  378. data/lib/newrelic_rpm.rb +11 -35
  379. data/lib/sequel/extensions/newrelic_instrumentation.rb +12 -15
  380. data/lib/sequel/plugins/newrelic_instrumentation.rb +4 -10
  381. data/lib/tasks/all.rb +3 -3
  382. data/lib/tasks/config.rake +22 -117
  383. data/lib/tasks/coverage_report.rake +28 -0
  384. data/lib/tasks/helpers/config.html.erb +21 -0
  385. data/lib/tasks/{config.text.erb → helpers/config.text.erb} +0 -0
  386. data/lib/tasks/helpers/format.rb +123 -0
  387. data/lib/tasks/helpers/matches.rb +12 -0
  388. data/lib/tasks/helpers/prompt.rb +24 -0
  389. data/lib/tasks/helpers/removers.rb +33 -0
  390. data/lib/tasks/install.rake +4 -0
  391. data/lib/tasks/instrumentation_generator/README.md +63 -0
  392. data/lib/tasks/instrumentation_generator/TODO.md +33 -0
  393. data/lib/tasks/instrumentation_generator/instrumentation.thor +124 -0
  394. data/lib/tasks/instrumentation_generator/templates/Envfile.tt +9 -0
  395. data/lib/tasks/instrumentation_generator/templates/chain.tt +22 -0
  396. data/lib/tasks/instrumentation_generator/templates/chain_method.tt +8 -0
  397. data/lib/tasks/instrumentation_generator/templates/dependency_detection.tt +29 -0
  398. data/lib/tasks/instrumentation_generator/templates/instrumentation.tt +13 -0
  399. data/lib/tasks/instrumentation_generator/templates/instrumentation_method.tt +3 -0
  400. data/lib/tasks/instrumentation_generator/templates/newrelic.yml.tt +19 -0
  401. data/lib/tasks/instrumentation_generator/templates/prepend.tt +13 -0
  402. data/lib/tasks/instrumentation_generator/templates/prepend_method.tt +3 -0
  403. data/lib/tasks/instrumentation_generator/templates/test.tt +15 -0
  404. data/lib/tasks/multiverse.rake +4 -0
  405. data/lib/tasks/multiverse.rb +5 -32
  406. data/lib/tasks/newrelic.rb +1 -1
  407. data/lib/tasks/tests.rake +10 -15
  408. data/newrelic.yml +648 -3
  409. data/newrelic_rpm.gemspec +25 -25
  410. data/recipes/newrelic.rb +2 -2
  411. data/test/agent_helper.rb +219 -178
  412. metadata +164 -122
  413. data/ROADMAP.md +0 -24
  414. data/bin/mongrel_rpm +0 -33
  415. data/cert/cacert.pem +0 -1177
  416. data/lib/new_relic/agent/datastores/mongo/obfuscator.rb +0 -44
  417. data/lib/new_relic/agent/datastores/mongo/statement_formatter.rb +0 -53
  418. data/lib/new_relic/agent/instrumentation/excon/connection.rb +0 -49
  419. data/lib/new_relic/agent/instrumentation/http.rb +0 -49
  420. data/lib/new_relic/agent/instrumentation/merb/controller.rb +0 -44
  421. data/lib/new_relic/agent/instrumentation/merb/errors.rb +0 -33
  422. data/lib/new_relic/agent/instrumentation/net.rb +0 -70
  423. data/lib/new_relic/agent/instrumentation/rails/action_controller.rb +0 -125
  424. data/lib/new_relic/agent/instrumentation/rails/action_web_service.rb +0 -46
  425. data/lib/new_relic/agent/supported_versions.rb +0 -275
  426. data/lib/new_relic/control/frameworks/merb.rb +0 -29
  427. data/lib/tasks/config.html.erb +0 -32
@@ -1,6 +1,6 @@
1
- # encoding: utf-8
2
1
  # This file is distributed under New Relic's license terms.
3
2
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
4
 
5
5
  # This file may be independently required to set up method tracing prior to
6
6
  # the full agent loading. In those cases, we do need at least this require to
@@ -47,13 +47,12 @@ module NewRelic
47
47
  #
48
48
 
49
49
  module MethodTracer
50
-
51
- def self.included clazz
52
- clazz.extend ClassMethods
50
+ def self.included(klass)
51
+ klass.extend(ClassMethods)
53
52
  end
54
53
 
55
- def self.extended clazz
56
- clazz.extend ClassMethods
54
+ def self.extended(klass)
55
+ klass.extend(ClassMethods)
57
56
  end
58
57
 
59
58
  # Trace a given block with stats and keep track of the caller.
@@ -68,8 +67,8 @@ module NewRelic
68
67
  #
69
68
  # @api public
70
69
  #
71
- def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
72
- NewRelic::Agent.record_api_supportability_metric :trace_execution_scoped
70
+ def trace_execution_scoped(metric_names, options = NewRelic::EMPTY_HASH) # THREAD_LOCAL_ACCESS
71
+ NewRelic::Agent.record_api_supportability_metric(:trace_execution_scoped) unless options[:internal]
73
72
  NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(metric_names, options) do
74
73
  # Using an implicit block avoids object allocation for a &block param
75
74
  yield
@@ -79,19 +78,20 @@ module NewRelic
79
78
  # Trace a given block with stats assigned to the given metric_name. It does not
80
79
  # provide scoped measurements, meaning whatever is being traced will not 'blame the
81
80
  # Controller'--that is to say appear in the breakdown chart.
82
- # This is code is inlined in #add_method_tracer.
81
+ #
83
82
  # * <tt>metric_names</tt> is a single name or an array of names of metrics
84
83
  #
85
84
  # @api public
86
85
  #
87
- def trace_execution_unscoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
88
- NewRelic::Agent.record_api_supportability_metric :trace_execution_unscoped
86
+ def trace_execution_unscoped(metric_names, options = NewRelic::EMPTY_HASH) # THREAD_LOCAL_ACCESS
87
+ NewRelic::Agent.record_api_supportability_metric(:trace_execution_unscoped) unless options[:internal]
89
88
  return yield unless NewRelic::Agent.tl_is_execution_traced?
90
- t0 = Time.now
89
+
90
+ t0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
91
91
  begin
92
92
  yield
93
93
  ensure
94
- duration = (Time.now - t0).to_f # for some reason this is 3 usec faster than Time - Time
94
+ duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - t0
95
95
  NewRelic::Agent.instance.stats_engine.tl_record_unscoped_metrics(metric_names, duration)
96
96
  end
97
97
  end
@@ -101,52 +101,40 @@ module NewRelic
101
101
  module ClassMethods
102
102
  # contains methods refactored out of the #add_method_tracer method
103
103
  module AddMethodTracer
104
- ALLOWED_KEYS = [:metric, :push_scope, :code_header, :code_footer].freeze
105
-
106
- # raises an error when the
107
- # NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer
108
- # method is called with improper keys. This aids in
109
- # debugging new instrumentation by failing fast
110
- def check_for_illegal_keys!(method_name, options)
111
- unrecognized_keys = options.keys - ALLOWED_KEYS
112
-
113
- if unrecognized_keys.any?
114
- raise "Unrecognized options when adding method tracer to #{method_name}: " +
115
- unrecognized_keys.join(', ')
116
- end
117
- end
118
-
119
- # validity checking - add_method_tracer must receive either
120
- # push scope or metric, or else it would record no
121
- # data. Raises an error if this is the case
122
- def check_for_push_scope_and_metric(options)
123
- unless options[:push_scope] || options[:metric]
124
- raise "Can't add a tracer where push_scope is false and metric is false"
125
- end
126
- end
104
+ ALLOWED_KEYS = [:metric, :push_scope, :code_header, :code_information, :code_footer].freeze
127
105
 
128
- DEFAULT_SETTINGS = {:push_scope => true, :metric => true, :code_header => "", :code_footer => "" }.freeze
106
+ DEFAULT_SETTINGS = {:push_scope => true, :metric => true, :code_header => "", :code_footer => ""}.freeze
129
107
 
130
108
  # Checks the provided options to make sure that they make
131
109
  # sense. Raises an error if the options are incorrect to
132
110
  # assist with debugging, so that errors occur at class
133
111
  # construction time rather than instrumentation run time
134
- def validate_options(method_name, options)
112
+ def _nr_validate_method_tracer_options(method_name, options)
135
113
  unless options.is_a?(Hash)
136
114
  raise TypeError.new("Error adding method tracer to #{method_name}: provided options must be a Hash")
137
115
  end
138
- check_for_illegal_keys!(method_name, options)
116
+
117
+ unrecognized_keys = options.keys - ALLOWED_KEYS
118
+ if unrecognized_keys.any?
119
+ raise "Unrecognized options when adding method tracer to #{method_name}: " +
120
+ unrecognized_keys.join(', ')
121
+ end
122
+
139
123
  options = DEFAULT_SETTINGS.merge(options)
140
- check_for_push_scope_and_metric(options)
124
+ unless options[:push_scope] || options[:metric]
125
+ raise "Can't add a tracer where push_scope is false and metric is false"
126
+ end
127
+
141
128
  options
142
129
  end
143
130
 
144
131
  # Default to the class where the method is defined.
145
132
  #
146
133
  # Example:
147
- # Foo.default_metric_name_code('bar') #=> "Custom/#{Foo.name}/bar"
148
- def default_metric_name_code(method_name)
149
- "Custom/#{derived_class_name}/#{method_name}"
134
+ # Foo._nr_default_metric_name_code('bar') #=> "Custom/#{Foo.name}/bar"
135
+ def _nr_default_metric_name(method_name)
136
+ class_name = _nr_derived_class_name
137
+ -> (*) { "Custom/#{class_name}/#{method_name}" }
150
138
  end
151
139
 
152
140
  # Checks to see if the method we are attempting to trace
@@ -154,7 +142,7 @@ module NewRelic
154
142
  # anything if the method doesn't exist.
155
143
  def newrelic_method_exists?(method_name)
156
144
  exists = method_defined?(method_name) || private_method_defined?(method_name)
157
- ::NewRelic::Agent.logger.error("Did not trace #{derived_class_name}##{method_name} because that method does not exist") unless exists
145
+ ::NewRelic::Agent.logger.error("Did not trace #{_nr_derived_class_name}##{method_name} because that method does not exist") unless exists
158
146
  exists
159
147
  end
160
148
 
@@ -162,67 +150,25 @@ module NewRelic
162
150
  # given metric by checking to see if the traced method
163
151
  # exists. Warns the user if methods are being double-traced
164
152
  # to help with debugging custom instrumentation.
165
- def traced_method_exists?(method_name, metric_name_code)
166
- exists = method_defined?(_traced_method_name(method_name, metric_name_code))
167
- ::NewRelic::Agent.logger.error("Attempt to trace a method twice with the same metric: Method = #{method_name}, Metric Name = #{metric_name_code}") if exists
153
+ def method_traced?(method_name)
154
+ exists = method_name && _nr_traced_method_module.method_defined?(method_name)
155
+ ::NewRelic::Agent.logger.error("Attempt to trace a method twice: Method = #{method_name}") if exists
168
156
  exists
169
157
  end
170
158
 
171
- # Returns a code snippet to be eval'd that skips tracing
172
- # when the agent is not tracing execution. turns
173
- # instrumentation into effectively one method call overhead
174
- # when the agent is disabled
175
- def assemble_code_header(method_name, metric_name_code, options)
176
- header = "return #{_untraced_method_name(method_name, metric_name_code)}(#{ARGS_FOR_RUBY_VERSION}) unless NewRelic::Agent.tl_is_execution_traced?\n"
177
- header += options[:code_header].to_s
178
- header
159
+ # Returns an anonymous module that stores prepended trace methods.
160
+ def _nr_traced_method_module
161
+ @_nr_traced_method_module ||= Module.new
179
162
  end
180
163
 
181
- # returns an eval-able string that contains the traced
182
- # method code used if the agent is not creating a scope for
183
- # use in scoped metrics.
184
- def method_without_push_scope(method_name, metric_name_code, options)
185
- "def #{_traced_method_name(method_name, metric_name_code)}(#{ARGS_FOR_RUBY_VERSION})
186
- #{assemble_code_header(method_name, metric_name_code, options)}
187
- t0 = Time.now
188
- begin
189
- #{_untraced_method_name(method_name, metric_name_code)}(#{ARGS_FOR_RUBY_VERSION})\n
190
- ensure
191
- duration = (Time.now - t0).to_f
192
- NewRelic::Agent.record_metric(\"#{metric_name_code}\", duration)
193
- #{options[:code_footer]}
194
- end
195
- end"
196
- end
197
-
198
- # returns an eval-able string that contains the tracing code
199
- # for a fully traced metric including scoping
200
- def method_with_push_scope(method_name, metric_name_code, options)
201
- "def #{_traced_method_name(method_name, metric_name_code)}(#{ARGS_FOR_RUBY_VERSION})
202
- #{options[:code_header]}
203
- result = ::NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(\"#{metric_name_code}\",
204
- :metric => #{options[:metric]}) do
205
- #{_untraced_method_name(method_name, metric_name_code)}(#{ARGS_FOR_RUBY_VERSION})
206
- end
207
- #{options[:code_footer]}
208
- result
209
- end"
210
- end
211
-
212
- # Decides which code snippet we should be eval'ing in this
213
- # context, based on the options.
214
- def code_to_eval(method_name, metric_name_code, options)
215
- options = validate_options(method_name, options)
216
- if options[:push_scope]
217
- method_with_push_scope(method_name, metric_name_code, options)
218
- else
219
- method_without_push_scope(method_name, metric_name_code, options)
164
+ # for testing only
165
+ def _nr_clear_traced_methods!
166
+ _nr_traced_method_module.module_eval do
167
+ self.instance_methods.each { |m| remove_method(m) }
220
168
  end
221
169
  end
222
170
 
223
- private
224
-
225
- def derived_class_name
171
+ def _nr_derived_class_name
226
172
  return self.name if self.name && !self.name.empty?
227
173
  return "AnonymousModule" if self.to_s.start_with?("#<Module:")
228
174
 
@@ -248,22 +194,26 @@ module NewRelic
248
194
  #
249
195
  # === Overriding the metric name
250
196
  #
251
- # +metric_name_code+ is a string that is eval'd to get the name of the
252
- # metric associated with the call, so if you want to use interpolation
253
- # evaluated at call time, then single quote the value like this:
197
+ # +metric_name+ is a String or Proc. If a Proc is given, it is bound to
198
+ # the object that called the traced method. For example:
254
199
  #
255
- # add_method_tracer :foo, 'Custom/#{self.class.name}/foo'
200
+ # add_method_tracer :foo, -> { "Custom/#{self.class.name}/foo" }
256
201
  #
257
202
  # This would name the metric according to the class of the runtime
258
- # intance, as opposed to the class where +foo+ is defined.
203
+ # instance, as opposed to the class where +foo+ is defined.
259
204
  #
260
205
  # If not provided, the metric name will be <tt>Custom/ClassName/method_name</tt>.
261
206
  #
262
- # @param [Symbol] method_name the name of the method to trace
263
- # @param [String] metric_name_code the metric name to record calls to
264
- # the traced method under. This may be either a static string, or Ruby
265
- # code to be evaluated at call-time in order to determine the metric
207
+ # @param method_name [Symbol] the name of the method to trace
208
+ # @param metric_name [String,Proc,Array] the metric name to record calls to
209
+ # the traced method under. This may be either a String, or a Proc
210
+ # to be evaluated at call-time in order to determine the metric
266
211
  # name dynamically.
212
+ # This method also accepts an array of Strings/Procs, in which case the
213
+ # first metric given will be scoped, while the remaining metrics will be
214
+ # recorded as though passed with :push_scope => false. If an Array of
215
+ # metric names is given with :push_scope => false, all metrics will be
216
+ # unscoped.
267
217
  # @param [Hash] options additional options controlling how the method is
268
218
  # traced.
269
219
  # @option options [Boolean] :push_scope (true) If false, the traced method will
@@ -272,16 +222,17 @@ module NewRelic
272
222
  # @option options [Boolean] :metric (true) If false, the traced method will
273
223
  # only appear in transaction traces, but no metrics will be recorded
274
224
  # for it.
275
- # @option options [String] :code_header ('') Ruby code to be inserted and run
225
+ # @option options [Proc] :code_header ('') Ruby code to be inserted and run
276
226
  # before the tracer begins timing.
277
- # @option options [String] :code_footer ('') Ruby code to be inserted and run
227
+ # @option options [Proc] :code_footer ('') Ruby code to be inserted and run
278
228
  # after the tracer stops timing.
279
229
  #
280
230
  # @example
281
231
  # add_method_tracer :foo
282
232
  #
283
233
  # # With a custom metric name
284
- # add_method_tracer :foo, 'Custom/#{self.class.name}/foo'
234
+ # add_method_tracer :foo, "Custom/MyClass/foo"
235
+ # add_method_tracer :bar, -> { "Custom/#{self.class.name}/bar" }
285
236
  #
286
237
  # # Instrument foo only for custom dashboards (not in transaction
287
238
  # # traces or breakdown charts)
@@ -292,65 +243,119 @@ module NewRelic
292
243
  #
293
244
  # @api public
294
245
  #
295
- def add_method_tracer(method_name, metric_name_code = nil, options = {})
296
- ::NewRelic::Agent.add_or_defer_method_tracer(self, method_name, metric_name_code, options)
246
+ def add_method_tracer(method_name, metric_name = nil, options = {})
247
+ ::NewRelic::Agent.add_or_defer_method_tracer(self, method_name, metric_name, options)
297
248
  end
298
249
 
299
250
  # For tests only because tracers must be removed in reverse-order
300
251
  # from when they were added, or else other tracers that were added to the same method
301
252
  # may get removed as well.
302
- def remove_method_tracer(method_name, metric_name_code) # :nodoc:
253
+ def remove_method_tracer(method_name) # :nodoc:
303
254
  return unless Agent.config[:agent_enabled]
304
- if method_defined? "#{_traced_method_name(method_name, metric_name_code)}"
305
- alias_method method_name, "#{_untraced_method_name(method_name, metric_name_code)}"
306
- undef_method "#{_traced_method_name(method_name, metric_name_code)}"
307
- ::NewRelic::Agent.logger.debug("removed method tracer #{method_name} #{metric_name_code}\n")
255
+
256
+ if _nr_traced_method_module.method_defined?(method_name)
257
+ _nr_traced_method_module.send(:remove_method, method_name)
258
+ ::NewRelic::Agent.logger.debug("removed method tracer #{method_name}\n")
308
259
  else
309
- raise "No tracer for '#{metric_name_code}' on method '#{method_name}'"
260
+ raise "No tracer on method '#{method_name}'"
310
261
  end
311
262
  end
312
263
 
313
264
  private
314
265
 
315
- def _add_method_tracer_now(method_name, metric_name_code, options)
266
+ def _nr_add_method_tracer_now(method_name, metric_name, options)
316
267
  NewRelic::Agent.record_api_supportability_metric(:add_method_tracer)
317
-
318
268
  return unless newrelic_method_exists?(method_name)
319
- metric_name_code ||= default_metric_name_code(method_name)
320
- return if traced_method_exists?(method_name, metric_name_code)
321
-
322
- traced_method = code_to_eval(method_name, metric_name_code, options)
323
-
324
- visibility = NewRelic::Helper.instance_method_visibility self, method_name
325
-
326
- class_eval traced_method, __FILE__, __LINE__
327
- alias_method _untraced_method_name(method_name, metric_name_code), method_name
328
- alias_method method_name, _traced_method_name(method_name, metric_name_code)
329
- ruby2_keywords(_traced_method_name(method_name, metric_name_code)) if respond_to?(:ruby2_keywords, true)
330
- send visibility, method_name
331
- send visibility, _traced_method_name(method_name, metric_name_code)
332
- ::NewRelic::Agent.logger.debug("Traced method: class = #{derived_class_name},"+
333
- "method = #{method_name}, "+
334
- "metric = '#{metric_name_code}'")
335
- end
336
269
 
337
- # given a method and a metric, this method returns the
338
- # untraced alias of the method name
339
- def _untraced_method_name(method_name, metric_name)
340
- "#{_sanitize_name(method_name)}_without_trace_#{_sanitize_name(metric_name)}"
270
+ remove_method_tracer(method_name) if method_traced?(method_name)
271
+
272
+ options = _nr_validate_method_tracer_options(method_name, options)
273
+
274
+ visibility = NewRelic::Helper.instance_method_visibility(self, method_name)
275
+
276
+ scoped_metric, unscoped_metrics = _nr_scoped_unscoped_metrics(metric_name, method_name, push_scope: options[:push_scope])
277
+
278
+ _nr_define_traced_method(method_name, scoped_metric: scoped_metric, unscoped_metrics: unscoped_metrics,
279
+ code_header: options[:code_header], code_footer: options[:code_footer],
280
+ record_metrics: options[:metric], visibility: visibility,
281
+ code_information: options[:code_information])
282
+
283
+ prepend(_nr_traced_method_module)
284
+
285
+ ::NewRelic::Agent.logger.debug("Traced method: class = #{_nr_derived_class_name}," +
286
+ "method = #{method_name}, " +
287
+ "metric = '#{metric_name}'")
341
288
  end
342
289
 
343
- # given a method and a metric, this method returns the traced
344
- # alias of the method name
345
- def _traced_method_name(method_name, metric_name)
346
- "#{_sanitize_name(method_name)}_with_trace_#{_sanitize_name(metric_name)}"
290
+ # See #add_method_tracer; if multiple metric names are given, the first is
291
+ # treated as scoped, the rest unscoped. If options[:push_scope] is false,
292
+ # all given metrics are unscoped.
293
+ def _nr_scoped_unscoped_metrics(metric_name, method_name, push_scope: true)
294
+ if metric_name.is_a?(Array) && push_scope
295
+ [metric_name.shift, metric_name]
296
+ elsif push_scope
297
+ [metric_name || _nr_default_metric_name(method_name), []]
298
+ else
299
+ [nil, Array(metric_name)]
300
+ end
347
301
  end
348
302
 
349
- # makes sure that method names do not contain characters that
350
- # might break the interpreter, for example ! or ? characters
351
- # that are not allowed in the middle of method names
352
- def _sanitize_name(name)
353
- name.to_s.tr_s('^a-zA-Z0-9', '_')
303
+ def _nr_define_traced_method(method_name, scoped_metric: nil, unscoped_metrics: [],
304
+ code_header: nil, code_footer: nil, record_metrics: true,
305
+ visibility: :public, code_information: {})
306
+
307
+ _nr_traced_method_module.module_eval do
308
+ define_method(method_name) do |*args, &block|
309
+ return super(*args, &block) unless NewRelic::Agent.tl_is_execution_traced?
310
+
311
+ scoped_metric_eval, unscoped_metrics_eval = nil, []
312
+
313
+ scoped_metric_eval = case scoped_metric
314
+ when Proc
315
+ instance_exec(*args, &scoped_metric)
316
+ when String
317
+ scoped_metric
318
+ end
319
+
320
+ unscoped_metrics_eval = unscoped_metrics.map do |metric|
321
+ metric.kind_of?(Proc) ? instance_exec(*args, &metric) : metric.to_s
322
+ end
323
+
324
+ instance_exec(&code_header) if code_header.kind_of?(Proc)
325
+
326
+ # NOTE: Calling ::NewRelic::Agent::MethodTracer.trace_execution_scoped and
327
+ # .trace_execution_unscoped below relies on the fact that MethodTracer is included
328
+ # in Module on agent startup. If/when this changes, these methods should be
329
+ # explicitly namespaced and extended in MethodTracer.
330
+
331
+ # If tracing multiple metrics on this method, nest one unscoped trace inside the scoped trace.
332
+ begin
333
+ if scoped_metric_eval
334
+ ::NewRelic::Agent::MethodTracer.trace_execution_scoped(scoped_metric_eval,
335
+ metric: record_metrics,
336
+ internal: true,
337
+ code_information: code_information) do
338
+ if unscoped_metrics_eval.empty?
339
+ super(*args, &block)
340
+ else
341
+ ::NewRelic::Agent::MethodTracer.trace_execution_unscoped(unscoped_metrics_eval, internal: true) do
342
+ super(*args, &block)
343
+ end
344
+ end
345
+ end
346
+ elsif !unscoped_metrics_eval.empty?
347
+ ::NewRelic::Agent::MethodTracer.trace_execution_unscoped(unscoped_metrics_eval, internal: true) do
348
+ super(*args, &block)
349
+ end
350
+ end
351
+ ensure
352
+ instance_exec(&code_footer) if code_footer.kind_of?(Proc)
353
+ end
354
+ end
355
+
356
+ send(visibility, method_name)
357
+ ruby2_keywords(method_name) if respond_to?(:ruby2_keywords, true)
358
+ end
354
359
  end
355
360
  end
356
361
 
@@ -1,20 +1,27 @@
1
- # encoding: utf-8
2
1
  # This file is distributed under New Relic's license terms.
3
2
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
4
 
5
5
  module NewRelic
6
6
  module Agent
7
7
  module MethodTracerHelpers
8
+ # These are code level metrics (CLM) attributes. For Ruby, they map like so:
9
+ # filepath: full path to an .rb file on disk
10
+ # lineno: the line number a Ruby method is defined on within a given .rb file
11
+ # function: the name of the Ruby method
12
+ # namespace: the Ruby class' namespace as a string, ex: 'MyModule::MyClass'
13
+ SOURCE_CODE_INFORMATION_PARAMETERS = %i[filepath lineno function namespace].freeze
14
+ SOURCE_CODE_INFORMATION_FAILURE_METRIC = "Supportability/CodeLevelMetrics/Ruby/Failure".freeze
8
15
  MAX_ALLOWED_METRIC_DURATION = 1_000_000_000 # roughly 31 years
9
16
 
10
17
  extend self
11
18
 
12
- def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
19
+ def trace_execution_scoped(metric_names, options = NewRelic::EMPTY_HASH) # THREAD_LOCAL_ACCESS
13
20
  state = NewRelic::Agent::Tracer.state
14
21
  return yield unless state.is_execution_traced?
15
22
 
16
23
  metric_names = Array(metric_names)
17
- first_name = metric_names.shift
24
+ first_name = metric_names.shift
18
25
  return yield unless first_name
19
26
 
20
27
  segment = NewRelic::Agent::Tracer.start_segment(
@@ -26,12 +33,87 @@ module NewRelic
26
33
  segment.record_metrics = false
27
34
  end
28
35
 
36
+ unless !options.key?(:code_information) || options[:code_information].nil? || options[:code_information].empty?
37
+ segment.code_information = options[:code_information]
38
+ end
39
+
29
40
  begin
30
41
  Tracer.capture_segment_error(segment) { yield }
31
42
  ensure
32
43
  segment.finish if segment
33
44
  end
34
45
  end
46
+
47
+ def code_information(object, method_name)
48
+ return ::NewRelic::EMPTY_HASH unless clm_enabled? && object && method_name
49
+
50
+ @code_information ||= {}
51
+ cache_key = "#{object.object_id}#{method_name}".freeze
52
+ return @code_information[cache_key] if @code_information.key?(cache_key)
53
+
54
+ namespace, location, is_class_method = namespace_and_location(object, method_name.to_sym)
55
+
56
+ @code_information[cache_key] = {filepath: location.first,
57
+ lineno: location.last,
58
+ function: "#{'self.' if is_class_method}#{method_name}",
59
+ namespace: namespace}.freeze
60
+ rescue => e
61
+ ::NewRelic::Agent.logger.warn("Unable to determine source code info for '#{object}', " \
62
+ "method '#{method_name}' - #{e.class}: #{e.message}")
63
+ ::NewRelic::Agent.increment_metric(SOURCE_CODE_INFORMATION_FAILURE_METRIC, 1)
64
+ ::NewRelic::EMPTY_HASH
65
+ end
66
+
67
+ private
68
+
69
+ def clm_enabled?
70
+ ::NewRelic::Agent.config[:'code_level_metrics.enabled']
71
+ end
72
+
73
+ # The string representation of a singleton class looks like
74
+ # '#<Class:MyModule::MyClass>'. Return the 'MyModule::MyClass' part of
75
+ # that string
76
+ def klass_name(object)
77
+ name = Regexp.last_match(1) if object.to_s =~ /^#<Class:(.*)>$/
78
+ return name if name
79
+
80
+ raise "Unable to glean a class name from string '#{object}'" unless name
81
+ end
82
+
83
+ # get at the underlying class from the singleton class
84
+ #
85
+ # note: even with the regex hit from klass_name(), `Object.const_get`
86
+ # is more performant than iterating through `ObjectSpace`
87
+ def klassify_singleton(object)
88
+ Object.const_get(klass_name(object))
89
+ end
90
+
91
+ # determine the namespace (class name including all module names in scope)
92
+ # and source code location (file path and line number) for the given
93
+ # object and method name
94
+ #
95
+ # traced class methods:
96
+ # * object is a singleton class, `#<Class::MyClass>`
97
+ # * get at the underlying non-singleton class
98
+ #
99
+ # traced instance methods and Rails controller methods:
100
+ # * object is a class, `MyClass`
101
+ #
102
+ # anonymous class based methods (`c = Class.new { def method; end; }`:
103
+ # * `#name` returns `nil`, so use '(Anonymous)' instead
104
+ #
105
+ def namespace_and_location(object, method_name)
106
+ klass = object.singleton_class? ? klassify_singleton(object) : object
107
+ name = klass.name || '(Anonymous)'
108
+ is_class_method = false
109
+ method = if (klass.instance_methods + klass.private_instance_methods).include?(method_name)
110
+ klass.instance_method(method_name)
111
+ else
112
+ is_class_method = true
113
+ klass.method(method_name)
114
+ end
115
+ [name, method.source_location, is_class_method]
116
+ end
35
117
  end
36
118
  end
37
119
  end
@@ -1,6 +1,6 @@
1
- # encoding: utf-8
2
1
  # This file is distributed under New Relic's license terms.
3
2
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
4
 
5
5
  require 'digest'
6
6
  require 'json'
@@ -12,22 +12,28 @@ module NewRelic
12
12
  module Agent
13
13
  module DistributedTracing
14
14
  class CrossAppMonitor < InboundRequestMonitor
15
-
16
- NEWRELIC_ID_HEADER = 'X-NewRelic-ID'.freeze
17
- NEWRELIC_TXN_HEADER = 'X-NewRelic-Transaction'.freeze
15
+ NEWRELIC_ID_HEADER = 'X-NewRelic-ID'.freeze
16
+ NEWRELIC_TXN_HEADER = 'X-NewRelic-Transaction'.freeze
18
17
  NEWRELIC_APPDATA_HEADER = 'X-NewRelic-App-Data'.freeze
19
18
 
20
- NEWRELIC_ID_HEADER_KEY = 'HTTP_X_NEWRELIC_ID'.freeze
21
- NEWRELIC_TXN_HEADER_KEY = 'HTTP_X_NEWRELIC_TRANSACTION'.freeze
19
+ NEWRELIC_ID_HEADER_KEY = 'HTTP_X_NEWRELIC_ID'.freeze
20
+ NEWRELIC_TXN_HEADER_KEY = 'HTTP_X_NEWRELIC_TRANSACTION'.freeze
22
21
  CONTENT_LENGTH_HEADER_KEY = 'HTTP_CONTENT_LENGTH'.freeze
23
22
 
24
23
  def on_finished_configuring(events)
24
+ if CrossAppTracing.cross_app_enabled?
25
+ Deprecator.deprecate('cross_application_tracer')
26
+ ::NewRelic::Agent.logger.warn(
27
+ "[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`"
28
+ )
29
+ end
30
+
25
31
  register_event_listeners(events)
26
32
  end
27
33
 
28
34
  def path_hash(txn_name, seed)
29
- rotated = ((seed << 1) | (seed >> 31)) & 0xffffffff
30
- app_name = NewRelic::Agent.config[:app_name].first
35
+ rotated = ((seed << 1) | (seed >> 31)) & 0xffffffff
36
+ app_name = NewRelic::Agent.config[:app_name].first
31
37
  identifier = "#{app_name};#{txn_name}"
32
38
  sprintf("%08x", rotated ^ hash_transaction_name(identifier))
33
39
  end
@@ -38,10 +44,10 @@ module NewRelic
38
44
  # :before_call will save our cross application request id to the thread
39
45
  # :after_call will write our response headers/metrics and clean up the thread
40
46
  def register_event_listeners(events)
41
- NewRelic::Agent.logger.
42
- debug("Wiring up Cross Application Tracing to events after finished configuring")
47
+ NewRelic::Agent.logger
48
+ .debug("Wiring up Cross Application Tracing to events after finished configuring")
43
49
 
44
- events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
50
+ events.subscribe(:before_call) do |env| # THREAD_LOCAL_ACCESS
45
51
  if id = decoded_id(env) and should_process_request?(id)
46
52
  state = NewRelic::Agent::Tracer.state
47
53
 
@@ -52,11 +58,11 @@ module NewRelic
52
58
  txn.distributed_tracer.cross_app_payload = payload
53
59
  end
54
60
 
55
- CrossAppTracing.assign_intrinsic_transaction_attributes state
61
+ CrossAppTracing.assign_intrinsic_transaction_attributes(state)
56
62
  end
57
63
  end
58
64
 
59
- events.subscribe(:after_call) do |env, (_status_code, headers, _body)| #THREAD_LOCAL_ACCESS
65
+ events.subscribe(:after_call) do |env, (_status_code, headers, _body)| # THREAD_LOCAL_ACCESS
60
66
  state = NewRelic::Agent::Tracer.state
61
67
 
62
68
  insert_response_header(state, env, headers)
@@ -78,21 +84,23 @@ module NewRelic
78
84
  end
79
85
  end
80
86
 
81
- def should_process_request? id
87
+ def should_process_request?(id)
82
88
  CrossAppTracing.cross_app_enabled? && CrossAppTracing.trusts?(id)
83
89
  end
84
90
 
85
91
  def set_response_headers(transaction, response_headers, content_length)
86
92
  payload = obfuscator.obfuscate(
87
93
  ::JSON.dump(
88
- transaction.distributed_tracer.cross_app_payload.as_json_array(content_length)))
94
+ transaction.distributed_tracer.cross_app_payload.as_json_array(content_length)
95
+ )
96
+ )
89
97
 
90
98
  response_headers[NEWRELIC_APPDATA_HEADER] = payload
91
99
  end
92
100
 
93
101
  def decoded_id(request)
94
102
  encoded_id = request[NEWRELIC_ID_HEADER_KEY]
95
- return "" if encoded_id.nil? || encoded_id.empty?
103
+ return NewRelic::EMPTY_STR if encoded_id.nil? || encoded_id.empty?
96
104
 
97
105
  obfuscator.deobfuscate(encoded_id)
98
106
  end
@@ -107,4 +115,4 @@ module NewRelic
107
115
  end
108
116
  end
109
117
  end
110
- end
118
+ end