newrelic_rpm 7.0.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (448) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +7 -2
  3. data/.rubocop.yml +1919 -0
  4. data/.rubocop_todo.yml +100 -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 +3754 -2825
  10. data/CONTRIBUTING.md +33 -7
  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 +23 -19
  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.rb +96 -925
  30. data/lib/new_relic/agent/agent_helpers/connect.rb +227 -0
  31. data/lib/new_relic/agent/agent_helpers/harvest.rb +153 -0
  32. data/lib/new_relic/agent/agent_helpers/shutdown.rb +72 -0
  33. data/lib/new_relic/agent/agent_helpers/special_startup.rb +74 -0
  34. data/lib/new_relic/agent/agent_helpers/start_worker_thread.rb +167 -0
  35. data/lib/new_relic/agent/agent_helpers/startup.rb +202 -0
  36. data/lib/new_relic/agent/agent_helpers/transmit.rb +76 -0
  37. data/lib/new_relic/agent/agent_logger.rb +23 -19
  38. data/lib/new_relic/agent/attribute_filter.rb +64 -47
  39. data/lib/new_relic/agent/attribute_processing.rb +7 -7
  40. data/lib/new_relic/agent/attributes.rb +5 -4
  41. data/lib/new_relic/agent/audit_logger.rb +8 -3
  42. data/lib/new_relic/agent/autostart.rb +20 -18
  43. data/lib/new_relic/agent/chained_call.rb +1 -1
  44. data/lib/new_relic/agent/commands/agent_command.rb +3 -3
  45. data/lib/new_relic/agent/commands/agent_command_router.rb +12 -11
  46. data/lib/new_relic/agent/commands/thread_profiler_session.rb +12 -10
  47. data/lib/new_relic/agent/configuration/default_source.rb +1366 -1297
  48. data/lib/new_relic/agent/configuration/dotted_hash.rb +6 -5
  49. data/lib/new_relic/agent/configuration/environment_source.rb +11 -9
  50. data/lib/new_relic/agent/configuration/event_harvest_config.rb +40 -17
  51. data/lib/new_relic/agent/configuration/high_security_source.rb +8 -9
  52. data/lib/new_relic/agent/configuration/manager.rb +82 -69
  53. data/lib/new_relic/agent/configuration/manual_source.rb +1 -1
  54. data/lib/new_relic/agent/configuration/mask_defaults.rb +3 -3
  55. data/lib/new_relic/agent/configuration/security_policy_source.rb +82 -85
  56. data/lib/new_relic/agent/configuration/server_source.rb +21 -19
  57. data/lib/new_relic/agent/configuration/yaml_source.rb +31 -7
  58. data/lib/new_relic/agent/configuration.rb +1 -1
  59. data/lib/new_relic/agent/connect/request_builder.rb +18 -18
  60. data/lib/new_relic/agent/connect/response_handler.rb +5 -8
  61. data/lib/new_relic/agent/custom_event_aggregator.rb +14 -14
  62. data/lib/new_relic/agent/database/explain_plan_helpers.rb +4 -5
  63. data/lib/new_relic/agent/database/obfuscation_helpers.rb +14 -13
  64. data/lib/new_relic/agent/database/obfuscator.rb +2 -2
  65. data/lib/new_relic/agent/database/postgres_explain_obfuscator.rb +3 -3
  66. data/lib/new_relic/agent/database.rb +42 -50
  67. data/lib/new_relic/agent/database_adapter.rb +3 -1
  68. data/lib/new_relic/agent/datastores/metric_helper.rb +17 -18
  69. data/lib/new_relic/agent/datastores/mongo/event_formatter.rb +7 -6
  70. data/lib/new_relic/agent/datastores/mongo/metric_translator.rb +6 -10
  71. data/lib/new_relic/agent/datastores/mongo.rb +6 -11
  72. data/lib/new_relic/agent/datastores/nosql_obfuscator.rb +41 -0
  73. data/lib/new_relic/agent/datastores/redis.rb +5 -7
  74. data/lib/new_relic/agent/datastores.rb +13 -15
  75. data/lib/new_relic/agent/deprecator.rb +1 -1
  76. data/lib/new_relic/agent/distributed_tracing/cross_app_payload.rb +10 -10
  77. data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb +40 -34
  78. data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +22 -22
  79. data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb +19 -19
  80. data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb +50 -52
  81. data/lib/new_relic/agent/distributed_tracing/distributed_trace_transport_type.rb +5 -6
  82. data/lib/new_relic/agent/distributed_tracing/trace_context.rb +76 -77
  83. data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +39 -38
  84. data/lib/new_relic/agent/distributed_tracing.rb +33 -35
  85. data/lib/new_relic/agent/encoding_normalizer.rb +4 -2
  86. data/lib/new_relic/agent/error_collector.rb +73 -54
  87. data/lib/new_relic/agent/error_event_aggregator.rb +4 -5
  88. data/lib/new_relic/agent/error_filter.rb +174 -0
  89. data/lib/new_relic/agent/error_trace_aggregator.rb +4 -3
  90. data/lib/new_relic/agent/event_aggregator.rb +22 -21
  91. data/lib/new_relic/agent/event_buffer.rb +7 -8
  92. data/lib/new_relic/agent/event_listener.rb +1 -2
  93. data/lib/new_relic/agent/event_loop.rb +26 -24
  94. data/lib/new_relic/agent/external.rb +11 -44
  95. data/lib/new_relic/agent/guid_generator.rb +13 -11
  96. data/lib/new_relic/agent/harvester.rb +4 -5
  97. data/lib/new_relic/agent/heap.rb +7 -9
  98. data/lib/new_relic/agent/hostname.rb +20 -13
  99. data/lib/new_relic/agent/http_clients/abstract.rb +10 -11
  100. data/lib/new_relic/agent/http_clients/curb_wrappers.rb +6 -11
  101. data/lib/new_relic/agent/http_clients/excon_wrappers.rb +8 -9
  102. data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb +4 -5
  103. data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb +2 -4
  104. data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +8 -4
  105. data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb +4 -5
  106. data/lib/new_relic/agent/http_clients/uri_util.rb +1 -3
  107. data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb +9 -22
  108. data/lib/new_relic/agent/instrumentation/action_controller_other_subscriber.rb +39 -0
  109. data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +38 -31
  110. data/lib/new_relic/agent/instrumentation/action_dispatch.rb +31 -0
  111. data/lib/new_relic/agent/instrumentation/action_dispatch_subscriber.rb +64 -0
  112. data/lib/new_relic/agent/instrumentation/action_mailbox.rb +30 -0
  113. data/lib/new_relic/agent/instrumentation/action_mailbox_subscriber.rb +33 -0
  114. data/lib/new_relic/agent/instrumentation/action_mailer.rb +30 -0
  115. data/lib/new_relic/agent/instrumentation/action_mailer_subscriber.rb +85 -0
  116. data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb +18 -19
  117. data/lib/new_relic/agent/instrumentation/active_job.rb +33 -13
  118. data/lib/new_relic/agent/instrumentation/active_job_subscriber.rb +41 -0
  119. data/lib/new_relic/agent/instrumentation/active_merchant.rb +20 -6
  120. data/lib/new_relic/agent/instrumentation/active_record.rb +37 -35
  121. data/lib/new_relic/agent/instrumentation/active_record_helper.rb +71 -61
  122. data/lib/new_relic/agent/instrumentation/active_record_notifications.rb +49 -46
  123. data/lib/new_relic/agent/instrumentation/active_record_prepend.rb +4 -4
  124. data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +27 -20
  125. data/lib/new_relic/agent/instrumentation/active_storage.rb +7 -3
  126. data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb +8 -33
  127. data/lib/new_relic/agent/instrumentation/active_support.rb +27 -0
  128. data/lib/new_relic/agent/instrumentation/active_support_logger/chain.rb +23 -0
  129. data/lib/new_relic/agent/instrumentation/active_support_logger/instrumentation.rb +20 -0
  130. data/lib/new_relic/agent/instrumentation/active_support_logger/prepend.rb +12 -0
  131. data/lib/new_relic/agent/instrumentation/active_support_logger.rb +24 -0
  132. data/lib/new_relic/agent/instrumentation/active_support_subscriber.rb +41 -0
  133. data/lib/new_relic/agent/instrumentation/bunny/chain.rb +11 -11
  134. data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb +21 -23
  135. data/lib/new_relic/agent/instrumentation/bunny/prepend.rb +4 -4
  136. data/lib/new_relic/agent/instrumentation/bunny.rb +4 -5
  137. data/lib/new_relic/agent/instrumentation/concurrent_ruby/chain.rb +36 -0
  138. data/lib/new_relic/agent/instrumentation/concurrent_ruby/instrumentation.rb +21 -0
  139. data/lib/new_relic/agent/instrumentation/concurrent_ruby/prepend.rb +27 -0
  140. data/lib/new_relic/agent/instrumentation/concurrent_ruby.rb +31 -0
  141. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +69 -59
  142. data/lib/new_relic/agent/instrumentation/curb/chain.rb +41 -43
  143. data/lib/new_relic/agent/instrumentation/curb/instrumentation.rb +52 -53
  144. data/lib/new_relic/agent/instrumentation/curb/prepend.rb +12 -14
  145. data/lib/new_relic/agent/instrumentation/curb.rb +7 -7
  146. data/lib/new_relic/agent/instrumentation/custom_events.rb +12 -0
  147. data/lib/new_relic/agent/instrumentation/custom_events_subscriber.rb +37 -0
  148. data/lib/new_relic/agent/instrumentation/delayed_job/chain.rb +6 -9
  149. data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb +7 -12
  150. data/lib/new_relic/agent/instrumentation/delayed_job/prepend.rb +1 -2
  151. data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb +28 -10
  152. data/lib/new_relic/agent/instrumentation/elasticsearch/chain.rb +29 -0
  153. data/lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb +66 -0
  154. data/lib/new_relic/agent/instrumentation/elasticsearch/prepend.rb +13 -0
  155. data/lib/new_relic/agent/instrumentation/elasticsearch.rb +31 -0
  156. data/lib/new_relic/agent/instrumentation/excon/middleware.rb +6 -6
  157. data/lib/new_relic/agent/instrumentation/excon.rb +27 -30
  158. data/lib/new_relic/agent/instrumentation/fiber/chain.rb +20 -0
  159. data/lib/new_relic/agent/instrumentation/fiber/instrumentation.rb +24 -0
  160. data/lib/new_relic/agent/instrumentation/fiber/prepend.rb +18 -0
  161. data/lib/new_relic/agent/instrumentation/fiber.rb +25 -0
  162. data/lib/new_relic/agent/instrumentation/grape/chain.rb +7 -8
  163. data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb +12 -12
  164. data/lib/new_relic/agent/instrumentation/grape/prepend.rb +4 -4
  165. data/lib/new_relic/agent/instrumentation/grape.rb +12 -13
  166. data/lib/new_relic/agent/instrumentation/grpc/client/chain.rb +97 -0
  167. data/lib/new_relic/agent/instrumentation/grpc/client/instrumentation.rb +89 -0
  168. data/lib/new_relic/agent/instrumentation/grpc/client/prepend.rb +111 -0
  169. data/lib/new_relic/agent/instrumentation/grpc/client/request_wrapper.rb +30 -0
  170. data/lib/new_relic/agent/instrumentation/grpc/helper.rb +32 -0
  171. data/lib/new_relic/agent/instrumentation/grpc/server/chain.rb +69 -0
  172. data/lib/new_relic/agent/instrumentation/grpc/server/instrumentation.rb +134 -0
  173. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_desc_prepend.rb +35 -0
  174. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_server_prepend.rb +26 -0
  175. data/lib/new_relic/agent/instrumentation/grpc_client.rb +23 -0
  176. data/lib/new_relic/agent/instrumentation/grpc_server.rb +25 -0
  177. data/lib/new_relic/agent/instrumentation/httpclient/chain.rb +3 -4
  178. data/lib/new_relic/agent/instrumentation/httpclient/instrumentation.rb +7 -8
  179. data/lib/new_relic/agent/instrumentation/httpclient/prepend.rb +1 -3
  180. data/lib/new_relic/agent/instrumentation/httpclient.rb +3 -3
  181. data/lib/new_relic/agent/instrumentation/httprb/chain.rb +3 -3
  182. data/lib/new_relic/agent/instrumentation/httprb/instrumentation.rb +11 -11
  183. data/lib/new_relic/agent/instrumentation/httprb/prepend.rb +2 -2
  184. data/lib/new_relic/agent/instrumentation/httprb.rb +4 -4
  185. data/lib/new_relic/agent/instrumentation/ignore_actions.rb +4 -5
  186. data/lib/new_relic/agent/instrumentation/logger/chain.rb +21 -0
  187. data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb +66 -0
  188. data/lib/new_relic/agent/instrumentation/logger/prepend.rb +13 -0
  189. data/lib/new_relic/agent/instrumentation/logger.rb +26 -0
  190. data/lib/new_relic/agent/instrumentation/memcache/chain.rb +2 -3
  191. data/lib/new_relic/agent/instrumentation/memcache/dalli.rb +31 -19
  192. data/lib/new_relic/agent/instrumentation/memcache/helper.rb +12 -9
  193. data/lib/new_relic/agent/instrumentation/memcache/instrumentation.rb +20 -18
  194. data/lib/new_relic/agent/instrumentation/memcache/prepend.rb +28 -15
  195. data/lib/new_relic/agent/instrumentation/memcache.rb +22 -23
  196. data/lib/new_relic/agent/instrumentation/middleware_proxy.rb +11 -12
  197. data/lib/new_relic/agent/instrumentation/middleware_tracing.rb +5 -7
  198. data/lib/new_relic/agent/instrumentation/mongo.rb +6 -144
  199. data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb +21 -18
  200. data/lib/new_relic/agent/instrumentation/net_http/chain.rb +4 -5
  201. data/lib/new_relic/agent/instrumentation/net_http/instrumentation.rb +10 -10
  202. data/lib/new_relic/agent/instrumentation/net_http/prepend.rb +5 -5
  203. data/lib/new_relic/agent/instrumentation/net_http.rb +12 -7
  204. data/lib/new_relic/agent/instrumentation/notifications_subscriber.rb +51 -9
  205. data/lib/new_relic/agent/instrumentation/padrino/chain.rb +24 -20
  206. data/lib/new_relic/agent/instrumentation/padrino/instrumentation.rb +4 -3
  207. data/lib/new_relic/agent/instrumentation/padrino/prepend.rb +3 -3
  208. data/lib/new_relic/agent/instrumentation/padrino.rb +5 -8
  209. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +6 -6
  210. data/lib/new_relic/agent/instrumentation/queue_time.rb +8 -9
  211. data/lib/new_relic/agent/instrumentation/rack/chain.rb +30 -21
  212. data/lib/new_relic/agent/instrumentation/rack/helpers.rb +3 -2
  213. data/lib/new_relic/agent/instrumentation/rack/instrumentation.rb +14 -12
  214. data/lib/new_relic/agent/instrumentation/rack/prepend.rb +15 -8
  215. data/lib/new_relic/agent/instrumentation/rack.rb +15 -15
  216. data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +18 -54
  217. data/lib/new_relic/agent/instrumentation/rails_middleware.rb +4 -4
  218. data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb +9 -8
  219. data/lib/new_relic/agent/instrumentation/rails_notifications/action_controller.rb +17 -5
  220. data/lib/new_relic/agent/instrumentation/rails_notifications/action_view.rb +8 -5
  221. data/lib/new_relic/agent/instrumentation/rails_notifications/custom_events.rb +30 -0
  222. data/lib/new_relic/agent/instrumentation/rake/chain.rb +2 -7
  223. data/lib/new_relic/agent/instrumentation/rake/instrumentation.rb +14 -16
  224. data/lib/new_relic/agent/instrumentation/rake/prepend.rb +1 -1
  225. data/lib/new_relic/agent/instrumentation/rake.rb +9 -9
  226. data/lib/new_relic/agent/instrumentation/redis/chain.rb +25 -14
  227. data/lib/new_relic/agent/instrumentation/redis/constants.rb +17 -0
  228. data/lib/new_relic/agent/instrumentation/redis/instrumentation.rb +53 -25
  229. data/lib/new_relic/agent/instrumentation/redis/middleware.rb +16 -0
  230. data/lib/new_relic/agent/instrumentation/redis/prepend.rb +10 -5
  231. data/lib/new_relic/agent/instrumentation/redis.rb +16 -6
  232. data/lib/new_relic/agent/instrumentation/resque/chain.rb +4 -5
  233. data/lib/new_relic/agent/instrumentation/resque/helper.rb +19 -0
  234. data/lib/new_relic/agent/instrumentation/resque/instrumentation.rb +9 -8
  235. data/lib/new_relic/agent/instrumentation/resque/prepend.rb +2 -3
  236. data/lib/new_relic/agent/instrumentation/resque.rb +25 -16
  237. data/lib/new_relic/agent/instrumentation/sequel.rb +16 -19
  238. data/lib/new_relic/agent/instrumentation/sequel_helper.rb +2 -2
  239. data/lib/new_relic/agent/instrumentation/sidekiq/client.rb +20 -0
  240. data/lib/new_relic/agent/instrumentation/sidekiq/extensions/delayed_class.rb +30 -0
  241. data/lib/new_relic/agent/instrumentation/sidekiq/server.rb +37 -0
  242. data/lib/new_relic/agent/instrumentation/sidekiq.rb +24 -65
  243. data/lib/new_relic/agent/instrumentation/sinatra/chain.rb +1 -1
  244. data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb +2 -3
  245. data/lib/new_relic/agent/instrumentation/sinatra/instrumentation.rb +13 -6
  246. data/lib/new_relic/agent/instrumentation/sinatra/prepend.rb +1 -1
  247. data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb +2 -2
  248. data/lib/new_relic/agent/instrumentation/sinatra.rb +26 -17
  249. data/lib/new_relic/agent/instrumentation/thread/chain.rb +24 -0
  250. data/lib/new_relic/agent/instrumentation/thread/instrumentation.rb +28 -0
  251. data/lib/new_relic/agent/instrumentation/thread/prepend.rb +22 -0
  252. data/lib/new_relic/agent/instrumentation/thread.rb +20 -0
  253. data/lib/new_relic/agent/instrumentation/tilt/chain.rb +24 -0
  254. data/lib/new_relic/agent/instrumentation/tilt/instrumentation.rb +41 -0
  255. data/lib/new_relic/agent/instrumentation/tilt/prepend.rb +13 -0
  256. data/lib/new_relic/agent/instrumentation/tilt.rb +25 -0
  257. data/lib/new_relic/agent/instrumentation/typhoeus/chain.rb +5 -5
  258. data/lib/new_relic/agent/instrumentation/typhoeus/instrumentation.rb +13 -15
  259. data/lib/new_relic/agent/instrumentation/typhoeus/prepend.rb +2 -2
  260. data/lib/new_relic/agent/instrumentation/typhoeus.rb +2 -2
  261. data/lib/new_relic/agent/instrumentation.rb +1 -1
  262. data/lib/new_relic/agent/internal_agent_error.rb +2 -2
  263. data/lib/new_relic/agent/javascript_instrumentor.rb +48 -42
  264. data/lib/new_relic/agent/linking_metadata.rb +44 -0
  265. data/lib/new_relic/agent/local_log_decorator.rb +37 -0
  266. data/lib/new_relic/agent/log_event_aggregator.rb +235 -0
  267. data/lib/new_relic/agent/log_once.rb +1 -1
  268. data/lib/new_relic/agent/log_priority.rb +20 -0
  269. data/lib/new_relic/agent/logging.rb +24 -21
  270. data/lib/new_relic/agent/memory_logger.rb +2 -2
  271. data/lib/new_relic/agent/messaging.rb +65 -81
  272. data/lib/new_relic/agent/method_tracer.rb +154 -149
  273. data/lib/new_relic/agent/method_tracer_helpers.rb +88 -11
  274. data/lib/new_relic/agent/monitors/cross_app_monitor.rb +24 -17
  275. data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb +5 -4
  276. data/lib/new_relic/agent/monitors/inbound_request_monitor.rb +1 -2
  277. data/lib/new_relic/agent/monitors/synthetics_monitor.rb +6 -9
  278. data/lib/new_relic/agent/monitors.rb +6 -7
  279. data/lib/new_relic/agent/new_relic_service/encoders.rb +6 -6
  280. data/lib/new_relic/agent/new_relic_service/json_marshaller.rb +5 -5
  281. data/lib/new_relic/agent/new_relic_service/marshaller.rb +2 -2
  282. data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb +4 -4
  283. data/lib/new_relic/agent/new_relic_service.rb +247 -186
  284. data/lib/new_relic/agent/{noticible_error.rb → noticeable_error.rb} +2 -5
  285. data/lib/new_relic/agent/null_logger.rb +7 -3
  286. data/lib/new_relic/agent/obfuscator.rb +8 -10
  287. data/lib/new_relic/agent/parameter_filtering.rb +24 -10
  288. data/lib/new_relic/agent/payload_metric_mapping.rb +9 -10
  289. data/lib/new_relic/agent/pipe_channel_manager.rb +27 -17
  290. data/lib/new_relic/agent/pipe_service.rb +8 -5
  291. data/lib/new_relic/agent/prepend_supportability.rb +2 -2
  292. data/lib/new_relic/agent/priority_sampled_buffer.rb +8 -11
  293. data/lib/new_relic/agent/range_extensions.rb +8 -28
  294. data/lib/new_relic/agent/rules_engine/replacement_rule.rb +11 -11
  295. data/lib/new_relic/agent/rules_engine/segment_terms_rule.rb +12 -13
  296. data/lib/new_relic/agent/rules_engine.rb +5 -4
  297. data/lib/new_relic/agent/sampler.rb +3 -4
  298. data/lib/new_relic/agent/sampler_collection.rb +3 -4
  299. data/lib/new_relic/agent/samplers/cpu_sampler.rb +3 -2
  300. data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +13 -10
  301. data/lib/new_relic/agent/samplers/memory_sampler.rb +24 -13
  302. data/lib/new_relic/agent/samplers/object_sampler.rb +1 -1
  303. data/lib/new_relic/agent/samplers/vm_sampler.rb +21 -19
  304. data/lib/new_relic/agent/span_event_aggregator.rb +12 -12
  305. data/lib/new_relic/agent/span_event_primitive.rb +62 -56
  306. data/lib/new_relic/agent/sql_sampler.rb +17 -17
  307. data/lib/new_relic/agent/stats.rb +78 -41
  308. data/lib/new_relic/agent/stats_engine/gc_profiler.rb +9 -11
  309. data/lib/new_relic/agent/stats_engine/stats_hash.rb +12 -13
  310. data/lib/new_relic/agent/stats_engine.rb +8 -8
  311. data/lib/new_relic/agent/synthetics_event_aggregator.rb +7 -8
  312. data/lib/new_relic/agent/system_info.rb +85 -65
  313. data/lib/new_relic/agent/threading/agent_thread.rb +18 -14
  314. data/lib/new_relic/agent/threading/backtrace_node.rb +12 -13
  315. data/lib/new_relic/agent/threading/backtrace_service.rb +14 -14
  316. data/lib/new_relic/agent/threading/thread_profile.rb +23 -23
  317. data/lib/new_relic/agent/timestamp_sampled_buffer.rb +1 -1
  318. data/lib/new_relic/agent/tracer.rb +89 -85
  319. data/lib/new_relic/agent/transaction/abstract_segment.rb +103 -40
  320. data/lib/new_relic/agent/transaction/datastore_segment.rb +21 -17
  321. data/lib/new_relic/agent/transaction/distributed_tracer.rb +63 -56
  322. data/lib/new_relic/agent/transaction/distributed_tracing.rb +43 -44
  323. data/lib/new_relic/agent/transaction/external_request_segment.rb +44 -34
  324. data/lib/new_relic/agent/transaction/message_broker_segment.rb +31 -36
  325. data/lib/new_relic/agent/transaction/request_attributes.rb +35 -35
  326. data/lib/new_relic/agent/transaction/segment.rb +20 -10
  327. data/lib/new_relic/agent/transaction/slowest_sample_buffer.rb +1 -3
  328. data/lib/new_relic/agent/transaction/synthetics_sample_buffer.rb +1 -1
  329. data/lib/new_relic/agent/transaction/trace.rb +15 -11
  330. data/lib/new_relic/agent/transaction/trace_builder.rb +10 -10
  331. data/lib/new_relic/agent/transaction/trace_context.rb +35 -35
  332. data/lib/new_relic/agent/transaction/trace_node.rb +25 -24
  333. data/lib/new_relic/agent/transaction/tracing.rb +14 -11
  334. data/lib/new_relic/agent/transaction/transaction_sample_buffer.rb +5 -5
  335. data/lib/new_relic/agent/transaction.rb +175 -152
  336. data/lib/new_relic/agent/transaction_error_primitive.rb +27 -25
  337. data/lib/new_relic/agent/transaction_event_aggregator.rb +12 -12
  338. data/lib/new_relic/agent/transaction_event_primitive.rb +32 -33
  339. data/lib/new_relic/agent/transaction_event_recorder.rb +16 -15
  340. data/lib/new_relic/agent/transaction_metrics.rb +10 -9
  341. data/lib/new_relic/agent/transaction_sampler.rb +5 -6
  342. data/lib/new_relic/agent/transaction_time_aggregator.rb +26 -25
  343. data/lib/new_relic/agent/utilization/aws.rb +33 -3
  344. data/lib/new_relic/agent/utilization/azure.rb +3 -3
  345. data/lib/new_relic/agent/utilization/gcp.rb +7 -7
  346. data/lib/new_relic/agent/utilization/pcf.rb +5 -4
  347. data/lib/new_relic/agent/utilization/vendor.rb +43 -28
  348. data/lib/new_relic/agent/utilization_data.rb +7 -5
  349. data/lib/new_relic/agent/vm/jruby_vm.rb +1 -1
  350. data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb +2 -2
  351. data/lib/new_relic/agent/vm/mri_vm.rb +40 -15
  352. data/lib/new_relic/agent/vm/snapshot.rb +5 -5
  353. data/lib/new_relic/agent/vm.rb +1 -1
  354. data/lib/new_relic/agent/worker_loop.rb +10 -12
  355. data/lib/new_relic/agent.rb +70 -86
  356. data/lib/new_relic/cli/command.rb +20 -22
  357. data/lib/new_relic/cli/commands/deployments.rb +92 -42
  358. data/lib/new_relic/cli/commands/install.rb +21 -24
  359. data/lib/new_relic/coerce.rb +15 -13
  360. data/lib/new_relic/collection_helper.rb +50 -48
  361. data/lib/new_relic/constants.rb +1 -4
  362. data/lib/new_relic/control/class_methods.rb +3 -3
  363. data/lib/new_relic/control/frameworks/external.rb +2 -2
  364. data/lib/new_relic/control/frameworks/rails.rb +13 -9
  365. data/lib/new_relic/control/frameworks/rails3.rb +3 -4
  366. data/lib/new_relic/control/frameworks/rails4.rb +1 -1
  367. data/lib/new_relic/control/frameworks/rails_notifications.rb +1 -1
  368. data/lib/new_relic/control/frameworks/ruby.rb +3 -3
  369. data/lib/new_relic/control/frameworks/sinatra.rb +7 -1
  370. data/lib/new_relic/control/frameworks.rb +1 -1
  371. data/lib/new_relic/control/instance_methods.rb +26 -45
  372. data/lib/new_relic/control/instrumentation.rb +39 -11
  373. data/lib/new_relic/control/private_instance_methods.rb +48 -0
  374. data/lib/new_relic/control/server_methods.rb +3 -4
  375. data/lib/new_relic/control.rb +1 -2
  376. data/lib/new_relic/delayed_job_injection.rb +1 -1
  377. data/lib/new_relic/dependency_detection.rb +29 -28
  378. data/lib/new_relic/environment_report.rb +40 -32
  379. data/lib/new_relic/helper.rb +48 -7
  380. data/lib/new_relic/language_support.rb +29 -5
  381. data/lib/new_relic/latest_changes.rb +7 -6
  382. data/lib/new_relic/local_environment.rb +22 -26
  383. data/lib/new_relic/metric_data.rb +31 -26
  384. data/lib/new_relic/metric_spec.rb +8 -6
  385. data/lib/new_relic/noticed_error.rb +21 -25
  386. data/lib/new_relic/rack/agent_hooks.rb +1 -1
  387. data/lib/new_relic/rack/agent_middleware.rb +5 -3
  388. data/lib/new_relic/rack/browser_monitoring.rb +133 -123
  389. data/lib/new_relic/rack.rb +1 -1
  390. data/lib/new_relic/recipes/capistrano3.rb +3 -61
  391. data/lib/new_relic/recipes/capistrano_legacy.rb +23 -26
  392. data/lib/new_relic/recipes/helpers/send_deployment.rb +70 -0
  393. data/lib/new_relic/recipes.rb +1 -1
  394. data/lib/new_relic/supportability_helper.rb +8 -9
  395. data/lib/new_relic/traced_thread.rb +39 -0
  396. data/lib/new_relic/version.rb +5 -16
  397. data/lib/newrelic_rpm.rb +19 -32
  398. data/lib/sequel/extensions/{newrelic_instrumentation.rb → new_relic_instrumentation.rb} +15 -18
  399. data/lib/sequel/plugins/{newrelic_instrumentation.rb → new_relic_instrumentation.rb} +8 -14
  400. data/lib/tasks/all.rb +3 -3
  401. data/lib/tasks/config.rake +22 -117
  402. data/lib/tasks/coverage_report.rake +28 -0
  403. data/lib/tasks/helpers/config.html.erb +21 -0
  404. data/lib/tasks/helpers/format.rb +123 -0
  405. data/lib/tasks/helpers/matches.rb +12 -0
  406. data/lib/tasks/helpers/prompt.rb +24 -0
  407. data/lib/tasks/helpers/removers.rb +33 -0
  408. data/lib/tasks/install.rake +4 -0
  409. data/lib/tasks/instrumentation_generator/README.md +63 -0
  410. data/lib/tasks/instrumentation_generator/TODO.md +33 -0
  411. data/lib/tasks/instrumentation_generator/instrumentation.thor +121 -0
  412. data/lib/tasks/instrumentation_generator/templates/Envfile.tt +9 -0
  413. data/lib/tasks/instrumentation_generator/templates/chain.tt +22 -0
  414. data/lib/tasks/instrumentation_generator/templates/chain_method.tt +8 -0
  415. data/lib/tasks/instrumentation_generator/templates/dependency_detection.tt +29 -0
  416. data/lib/tasks/instrumentation_generator/templates/instrumentation.tt +13 -0
  417. data/lib/tasks/instrumentation_generator/templates/instrumentation_method.tt +3 -0
  418. data/lib/tasks/instrumentation_generator/templates/newrelic.yml.tt +19 -0
  419. data/lib/tasks/instrumentation_generator/templates/prepend.tt +13 -0
  420. data/lib/tasks/instrumentation_generator/templates/prepend_method.tt +3 -0
  421. data/lib/tasks/instrumentation_generator/templates/test.tt +15 -0
  422. data/lib/tasks/multiverse.rake +4 -0
  423. data/lib/tasks/multiverse.rb +5 -32
  424. data/lib/tasks/newrelic.rb +1 -1
  425. data/lib/tasks/tests.rake +10 -15
  426. data/newrelic.yml +672 -3
  427. data/newrelic_rpm.gemspec +35 -31
  428. data/recipes/newrelic.rb +2 -2
  429. data/test/agent_helper.rb +221 -180
  430. metadata +141 -111
  431. data/ROADMAP.md +0 -24
  432. data/bin/mongrel_rpm +0 -33
  433. data/lib/new_relic/agent/datastores/mongo/obfuscator.rb +0 -44
  434. data/lib/new_relic/agent/datastores/mongo/statement_formatter.rb +0 -53
  435. data/lib/new_relic/agent/instrumentation/acts_as_solr.rb +0 -75
  436. data/lib/new_relic/agent/instrumentation/authlogic.rb +0 -25
  437. data/lib/new_relic/agent/instrumentation/data_mapper.rb +0 -204
  438. data/lib/new_relic/agent/instrumentation/excon/connection.rb +0 -49
  439. data/lib/new_relic/agent/instrumentation/merb/controller.rb +0 -44
  440. data/lib/new_relic/agent/instrumentation/merb/errors.rb +0 -33
  441. data/lib/new_relic/agent/instrumentation/rails/action_controller.rb +0 -125
  442. data/lib/new_relic/agent/instrumentation/rails/action_web_service.rb +0 -46
  443. data/lib/new_relic/agent/instrumentation/rainbows_instrumentation.rb +0 -26
  444. data/lib/new_relic/agent/instrumentation/sunspot.rb +0 -33
  445. data/lib/new_relic/agent/supported_versions.rb +0 -275
  446. data/lib/new_relic/control/frameworks/merb.rb +0 -29
  447. data/lib/tasks/config.html.erb +0 -32
  448. /data/lib/tasks/{config.text.erb → helpers/config.text.erb} +0 -0
@@ -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 'socket'
6
6
  require 'net/https'
@@ -9,6 +9,7 @@ require 'logger'
9
9
  require 'zlib'
10
10
  require 'stringio'
11
11
  require 'new_relic/constants'
12
+ require 'new_relic/traced_thread'
12
13
  require 'new_relic/coerce'
13
14
  require 'new_relic/agent/autostart'
14
15
  require 'new_relic/agent/harvester'
@@ -17,6 +18,7 @@ require 'new_relic/agent/new_relic_service'
17
18
  require 'new_relic/agent/pipe_service'
18
19
  require 'new_relic/agent/configuration/manager'
19
20
  require 'new_relic/agent/database'
21
+ require 'new_relic/agent/instrumentation/resque/helper'
20
22
  require 'new_relic/agent/commands/agent_command_router'
21
23
  require 'new_relic/agent/event_listener'
22
24
  require 'new_relic/agent/distributed_tracing'
@@ -24,6 +26,7 @@ require 'new_relic/agent/monitors'
24
26
  require 'new_relic/agent/transaction_event_recorder'
25
27
  require 'new_relic/agent/custom_event_aggregator'
26
28
  require 'new_relic/agent/span_event_aggregator'
29
+ require 'new_relic/agent/log_event_aggregator'
27
30
  require 'new_relic/agent/sampler_collection'
28
31
  require 'new_relic/agent/javascript_instrumentor'
29
32
  require 'new_relic/agent/vm/monotonic_gc_profiler'
@@ -34,9 +37,16 @@ require 'new_relic/agent/adaptive_sampler'
34
37
  require 'new_relic/agent/connect/request_builder'
35
38
  require 'new_relic/agent/connect/response_handler'
36
39
 
40
+ require 'new_relic/agent/agent_helpers/connect'
41
+ require 'new_relic/agent/agent_helpers/harvest'
42
+ require 'new_relic/agent/agent_helpers/start_worker_thread'
43
+ require 'new_relic/agent/agent_helpers/startup'
44
+ require 'new_relic/agent/agent_helpers/special_startup'
45
+ require 'new_relic/agent/agent_helpers/shutdown'
46
+ require 'new_relic/agent/agent_helpers/transmit'
47
+
37
48
  module NewRelic
38
49
  module Agent
39
-
40
50
  # The Agent is a singleton that is instantiated when the plugin is
41
51
  # activated. It collects performance data from ruby applications
42
52
  # in realtime as the application runs, and periodically sends that
@@ -46,43 +56,59 @@ module NewRelic
46
56
  ::NewRelic::Agent.config
47
57
  end
48
58
 
59
+ include NewRelic::Agent::AgentHelpers::Connect
60
+ include NewRelic::Agent::AgentHelpers::Harvest
61
+ include NewRelic::Agent::AgentHelpers::StartWorkerThread
62
+ include NewRelic::Agent::AgentHelpers::SpecialStartup
63
+ include NewRelic::Agent::AgentHelpers::Startup
64
+ include NewRelic::Agent::AgentHelpers::Shutdown
65
+ include NewRelic::Agent::AgentHelpers::Transmit
66
+
49
67
  def initialize
68
+ init_basics
69
+ init_components
70
+ init_event_handlers
71
+ setup_attribute_filter
72
+ end
73
+
74
+ private
75
+
76
+ def init_basics
50
77
  @started = false
51
78
  @event_loop = nil
52
79
  @worker_thread = nil
53
-
54
- @service = NewRelicService.new
55
-
56
- @events = EventListener.new
57
- @stats_engine = StatsEngine.new
58
- @transaction_sampler = TransactionSampler.new
59
- @sql_sampler = SqlSampler.new
60
- @agent_command_router = Commands::AgentCommandRouter.new @events
61
- @monitors = Monitors.new @events
62
- @error_collector = ErrorCollector.new @events
63
- @transaction_rules = RulesEngine.new
64
- @harvest_samplers = SamplerCollection.new @events
65
- @monotonic_gc_profiler = VM::MonotonicGCProfiler.new
66
- @javascript_instrumentor = JavascriptInstrumentor.new @events
67
- @adaptive_sampler = AdaptiveSampler.new(Agent.config[:sampling_target],
68
- Agent.config[:sampling_target_period_in_seconds])
69
-
70
- @harvester = Harvester.new @events
71
- @after_fork_lock = Mutex.new
72
-
73
- @transaction_event_recorder = TransactionEventRecorder.new @events
74
- @custom_event_aggregator = CustomEventAggregator.new @events
75
- @span_event_aggregator = SpanEventAggregator.new @events
76
-
77
- @connect_state = :pending
78
- @connect_attempts = 0
79
- @waited_on_connect = nil
80
- @connected_pid = nil
81
-
80
+ @connect_state = :pending
81
+ @connect_attempts = 0
82
+ @waited_on_connect = nil
83
+ @connected_pid = nil
82
84
  @wait_on_connect_mutex = Mutex.new
85
+ @after_fork_lock = Mutex.new
83
86
  @wait_on_connect_condition = ConditionVariable.new
87
+ end
84
88
 
85
- setup_attribute_filter
89
+ def init_components
90
+ @service = NewRelicService.new
91
+ @events = EventListener.new
92
+ @stats_engine = StatsEngine.new
93
+ @transaction_sampler = TransactionSampler.new
94
+ @sql_sampler = SqlSampler.new
95
+ @transaction_rules = RulesEngine.new
96
+ @monotonic_gc_profiler = VM::MonotonicGCProfiler.new
97
+ @adaptive_sampler = AdaptiveSampler.new(Agent.config[:sampling_target],
98
+ Agent.config[:sampling_target_period_in_seconds])
99
+ end
100
+
101
+ def init_event_handlers
102
+ @agent_command_router = Commands::AgentCommandRouter.new(@events)
103
+ @monitors = Monitors.new(@events)
104
+ @error_collector = ErrorCollector.new(@events)
105
+ @harvest_samplers = SamplerCollection.new(@events)
106
+ @javascript_instrumentor = JavaScriptInstrumentor.new(@events)
107
+ @harvester = Harvester.new(@events)
108
+ @transaction_event_recorder = TransactionEventRecorder.new(@events)
109
+ @custom_event_aggregator = CustomEventAggregator.new(@events)
110
+ @span_event_aggregator = SpanEventAggregator.new(@events)
111
+ @log_event_aggregator = LogEventAggregator.new(@events)
86
112
  end
87
113
 
88
114
  def setup_attribute_filter
@@ -93,6 +119,8 @@ module NewRelic
93
119
  end
94
120
  end
95
121
 
122
+ public
123
+
96
124
  def refresh_attribute_filter
97
125
  @attribute_filter = AttributeFilter.new(Agent.config)
98
126
  end
@@ -109,7 +137,6 @@ module NewRelic
109
137
  # Holds all the methods defined on NewRelic::Agent::Agent
110
138
  # instances
111
139
  module InstanceMethods
112
-
113
140
  # the statistics engine that holds all the timeslice data
114
141
  attr_reader :stats_engine
115
142
  # the transaction sampler that handles recording transactions
@@ -141,12 +168,13 @@ module NewRelic
141
168
  # collector on connect. The former are applied during txns,
142
169
  # the latter during harvest.
143
170
  attr_accessor :transaction_rules
144
- # Responsbile for restarting the harvest thread
171
+ # Responsible for restarting the harvest thread
145
172
  attr_reader :harvester
146
173
  # GC::Profiler.total_time is not monotonic so we wrap it.
147
174
  attr_reader :monotonic_gc_profiler
148
175
  attr_reader :custom_event_aggregator
149
176
  attr_reader :span_event_aggregator
177
+ attr_reader :log_event_aggregator
150
178
  attr_reader :transaction_event_recorder
151
179
  attr_reader :attribute_filter
152
180
  attr_reader :adaptive_sampler
@@ -168,7 +196,7 @@ module NewRelic
168
196
  # It assumes the parent process initialized the agent, but does
169
197
  # not assume the agent started.
170
198
  #
171
- # The call is idempotent, but not re-entrant.
199
+ # The call is idempotent, but not reentrant.
172
200
  #
173
201
  # * It clears any metrics carried over from the parent process
174
202
  # * Restarts the sampler thread if necessary
@@ -183,29 +211,35 @@ module NewRelic
183
211
  # * <tt>:keep_retrying => false</tt> if we try to initiate a new
184
212
  # connection, this tells me to only try it once so this method returns
185
213
  # quickly if there is some kind of latency with the server.
186
- def after_fork(options={})
214
+ def after_fork(options = {})
215
+ return unless needs_after_fork_work?
216
+
217
+ ::NewRelic::Agent.logger.debug("Starting the worker thread in #{Process.pid} (parent #{Process.ppid}) after forking.")
218
+
219
+ channel_id = options[:report_to_channel]
220
+ install_pipe_service(channel_id) if channel_id
221
+
222
+ # Clear out locks and stats left over from parent process
223
+ reset_objects_with_locks
224
+ drop_buffered_data
225
+
226
+ setup_and_start_agent(options)
227
+ end
228
+
229
+ def needs_after_fork_work?
187
230
  needs_restart = false
188
231
  @after_fork_lock.synchronize do
189
232
  needs_restart = @harvester.needs_restart?
190
233
  @harvester.mark_started
191
234
  end
192
235
 
193
- return if !needs_restart ||
236
+ return false if !needs_restart ||
194
237
  !Agent.config[:agent_enabled] ||
195
238
  !Agent.config[:monitor_mode] ||
196
239
  disconnected? ||
197
240
  !control.security_settings_valid?
198
241
 
199
- ::NewRelic::Agent.logger.debug "Starting the worker thread in #{Process.pid} (parent #{Process.ppid}) after forking."
200
-
201
- channel_id = options[:report_to_channel]
202
- install_pipe_service(channel_id) if channel_id
203
-
204
- # Clear out locks and stats left over from parent process
205
- reset_objects_with_locks
206
- drop_buffered_data
207
-
208
- setup_and_start_agent(options)
242
+ true
209
243
  end
210
244
 
211
245
  def install_pipe_service(channel_id)
@@ -214,53 +248,16 @@ module NewRelic
214
248
  @connected_pid = Process.pid
215
249
  else
216
250
  ::NewRelic::Agent.logger.debug("Child process #{Process.pid} not reporting to non-connected parent (process #{Process.ppid}).")
217
- @service.shutdown(Time.now)
251
+ @service.shutdown
218
252
  disconnect
219
253
  end
220
254
  end
221
255
 
222
- # True if we have initialized and completed 'start'
223
- def started?
224
- @started
225
- end
226
-
227
- # Attempt a graceful shutdown of the agent, flushing any remaining
228
- # data.
229
- def shutdown
230
- return unless started?
231
- ::NewRelic::Agent.logger.info "Starting Agent shutdown"
232
-
233
- stop_event_loop
234
- trap_signals_for_litespeed
235
- untraced_graceful_disconnect
236
- revert_to_default_configuration
237
-
238
- @started = nil
239
- Control.reset
240
- end
241
-
242
256
  def revert_to_default_configuration
243
257
  Agent.config.remove_config_type(:manual)
244
258
  Agent.config.remove_config_type(:server)
245
259
  end
246
260
 
247
- # If the @worker_thread encounters an error during the attempt to connect to the collector
248
- # then the connect attempts enter an exponential backoff retry loop. To avoid potential
249
- # race conditions with shutting down while also attempting to reconnect, we join the
250
- # @worker_thread with a timeout threshold. This allows potentially connecting and flushing
251
- # pending data to the server, but without waiting indefinitely for a reconnect to succeed.
252
- # The use-case where this typically arises is in cronjob scheduled rake tasks where there's
253
- # also some network stability/latency issues happening.
254
- def stop_event_loop
255
- @event_loop.stop if @event_loop
256
- # Wait the end of the event loop thread.
257
- if @worker_thread
258
- unless @worker_thread.join(3)
259
- ::NewRelic::Agent.logger.debug "Event loop thread did not stop within 3 seconds"
260
- end
261
- end
262
- end
263
-
264
261
  def trap_signals_for_litespeed
265
262
  # if litespeed, then ignore all future SIGUSR1 - it's
266
263
  # litespeed trying to shut us down
@@ -270,20 +267,10 @@ module NewRelic
270
267
  end
271
268
  end
272
269
 
273
- def untraced_graceful_disconnect
274
- begin
275
- NewRelic::Agent.disable_all_tracing do
276
- graceful_disconnect
277
- end
278
- rescue => e
279
- ::NewRelic::Agent.logger.error e
280
- end
281
- end
282
-
283
270
  # Sets a thread local variable as to whether we should or
284
271
  # should not record sql in the current thread. Returns the
285
272
  # previous value, if there is one
286
- def set_record_sql(should_record) #THREAD_LOCAL_ACCESS
273
+ def set_record_sql(should_record) # THREAD_LOCAL_ACCESS
287
274
  state = Tracer.state
288
275
  prev = state.record_sql
289
276
  state.record_sql = should_record
@@ -294,264 +281,16 @@ module NewRelic
294
281
  # thread. This uses a stack which allows us to disable tracing
295
282
  # children of a transaction without affecting the tracing of
296
283
  # the whole transaction
297
- def push_trace_execution_flag(should_trace=false) #THREAD_LOCAL_ACCESS
284
+ def push_trace_execution_flag(should_trace = false) # THREAD_LOCAL_ACCESS
298
285
  Tracer.state.push_traced(should_trace)
299
286
  end
300
287
 
301
288
  # Pop the current trace execution status. Restore trace execution status
302
289
  # to what it was before we pushed the current flag.
303
- def pop_trace_execution_flag #THREAD_LOCAL_ACCESS
290
+ def pop_trace_execution_flag # THREAD_LOCAL_ACCESS
304
291
  Tracer.state.pop_traced
305
292
  end
306
293
 
307
- # Herein lies the corpse of the former 'start' method. May
308
- # its unmatched flog score rest in pieces.
309
- module Start
310
- # Check whether we have already started, which is an error condition
311
- def already_started?
312
- if started?
313
- ::NewRelic::Agent.logger.error("Agent Started Already!")
314
- true
315
- end
316
- end
317
-
318
- # The agent is disabled when it is not force enabled by the
319
- # 'agent_enabled' option (e.g. in a manual start), or
320
- # enabled normally through the configuration file
321
- def disabled?
322
- !Agent.config[:agent_enabled]
323
- end
324
-
325
- # Log startup information that we almost always want to know
326
- def log_startup
327
- log_environment
328
- log_dispatcher
329
- log_app_name
330
- end
331
-
332
- # Log the environment the app thinks it's running in.
333
- # Useful in debugging, as this is the key for config YAML lookups.
334
- def log_environment
335
- ::NewRelic::Agent.logger.info "Environment: #{NewRelic::Control.instance.env}"
336
- end
337
-
338
- # Logs the dispatcher to the log file to assist with
339
- # debugging. When no debugger is present, logs this fact to
340
- # assist with proper dispatcher detection
341
- def log_dispatcher
342
- dispatcher_name = Agent.config[:dispatcher].to_s
343
-
344
- if dispatcher_name.empty?
345
- ::NewRelic::Agent.logger.info 'No known dispatcher detected.'
346
- else
347
- ::NewRelic::Agent.logger.info "Dispatcher: #{dispatcher_name}"
348
- end
349
- end
350
-
351
- def log_app_name
352
- ::NewRelic::Agent.logger.info "Application: #{Agent.config[:app_name].join(", ")}"
353
- end
354
-
355
- def log_ignore_url_regexes
356
- regexes = NewRelic::Agent.config[:'rules.ignore_url_regexes']
357
-
358
- unless regexes.empty?
359
- ::NewRelic::Agent.logger.info "Ignoring URLs that match the following regexes: #{regexes.map(&:inspect).join(", ")}."
360
- end
361
- end
362
-
363
- # Logs the configured application names
364
- def app_name_configured?
365
- names = Agent.config[:app_name]
366
- return names.respond_to?(:any?) && names.any?
367
- end
368
-
369
- # Connecting in the foreground blocks further startup of the
370
- # agent until we have a connection - useful in cases where
371
- # you're trying to log a very-short-running process and want
372
- # to get statistics from before a server connection
373
- # (typically 20 seconds) exists
374
- def connect_in_foreground
375
- NewRelic::Agent.disable_all_tracing { connect(:keep_retrying => false) }
376
- end
377
-
378
- # This matters when the following three criteria are met:
379
- #
380
- # 1. A Sinatra 'classic' application is being run
381
- # 2. The app is being run by executing the main file directly, rather
382
- # than via a config.ru file.
383
- # 3. newrelic_rpm is required *after* sinatra
384
- #
385
- # In this case, the entire application runs from an at_exit handler in
386
- # Sinatra, and if we were to install ours, it would be executed before
387
- # the one in Sinatra, meaning that we'd shutdown the agent too early
388
- # and never collect any data.
389
- def sinatra_classic_app?
390
- (
391
- defined?(Sinatra::Application) &&
392
- Sinatra::Application.respond_to?(:run) &&
393
- Sinatra::Application.run?
394
- )
395
- end
396
-
397
- def should_install_exit_handler?
398
- return false unless Agent.config[:send_data_on_exit]
399
- !sinatra_classic_app? || Agent.config[:force_install_exit_handler]
400
- end
401
-
402
- def install_exit_handler
403
- return unless should_install_exit_handler?
404
- NewRelic::Agent.logger.debug("Installing at_exit handler")
405
- at_exit { shutdown }
406
- end
407
-
408
- # Classy logging of the agent version and the current pid,
409
- # so we can disambiguate processes in the log file and make
410
- # sure they're running a reasonable version
411
- def log_version_and_pid
412
- ::NewRelic::Agent.logger.debug "New Relic Ruby Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
413
- end
414
-
415
- # Warn the user if they have configured their agent not to
416
- # send data, that way we can see this clearly in the log file
417
- def monitoring?
418
- if Agent.config[:monitor_mode]
419
- true
420
- else
421
- ::NewRelic::Agent.logger.warn('Agent configured not to send data in this environment.')
422
- false
423
- end
424
- end
425
-
426
- # Tell the user when the license key is missing so they can
427
- # fix it by adding it to the file
428
- def has_license_key?
429
- if Agent.config[:license_key] && Agent.config[:license_key].length > 0
430
- true
431
- else
432
- ::NewRelic::Agent.logger.warn("No license key found. " +
433
- "This often means your newrelic.yml file was not found, or it lacks a section for the running environment, '#{NewRelic::Control.instance.env}'. You may also want to try linting your newrelic.yml to ensure it is valid YML.")
434
- false
435
- end
436
- end
437
-
438
- # A correct license key exists and is of the proper length
439
- def has_correct_license_key?
440
- has_license_key? && correct_license_length
441
- end
442
-
443
- # A license key is an arbitrary 40 character string,
444
- # usually looks something like a SHA1 hash
445
- def correct_license_length
446
- key = Agent.config[:license_key]
447
-
448
- if key.length == 40
449
- true
450
- else
451
- ::NewRelic::Agent.logger.error("Invalid license key: #{key}")
452
- false
453
- end
454
- end
455
-
456
- # If we're using a dispatcher that forks before serving
457
- # requests, we need to wait until the children are forked
458
- # before connecting, otherwise the parent process sends useless data
459
- def using_forking_dispatcher?
460
- if [:puma, :passenger, :rainbows, :unicorn].include? Agent.config[:dispatcher]
461
- ::NewRelic::Agent.logger.info "Deferring startup of agent reporting thread because #{Agent.config[:dispatcher]} may fork."
462
- true
463
- else
464
- false
465
- end
466
- end
467
-
468
- # Return true if we're using resque and it hasn't had a chance to (potentially)
469
- # daemonize itself. This avoids hanging when there's a Thread started
470
- # before Resque calls Process.daemon (Jira RUBY-857)
471
- def defer_for_resque?
472
- NewRelic::Agent.config[:dispatcher] == :resque &&
473
- NewRelic::LanguageSupport.can_fork? &&
474
- !PipeChannelManager.listener.started?
475
- end
476
-
477
- def in_resque_child_process?
478
- defined?(@service) && @service.is_a?(PipeService)
479
- end
480
-
481
- # Sanity-check the agent configuration and start the agent,
482
- # setting up the worker thread and the exit handler to shut
483
- # down the agent
484
- def check_config_and_start_agent
485
- return unless monitoring? && has_correct_license_key?
486
- return if using_forking_dispatcher?
487
- setup_and_start_agent
488
- end
489
-
490
- # This is the shared method between the main agent startup and the
491
- # after_fork call restarting the thread in deferred dispatchers.
492
- #
493
- # Treatment of @started and env report is important to get right.
494
- def setup_and_start_agent(options={})
495
- @started = true
496
- @harvester.mark_started
497
-
498
- unless in_resque_child_process?
499
- install_exit_handler
500
- environment_for_connect
501
- @harvest_samplers.load_samplers unless Agent.config[:disable_samplers]
502
- end
503
-
504
- connect_in_foreground if Agent.config[:sync_startup]
505
- start_worker_thread(options)
506
- end
507
- end
508
-
509
- include Start
510
-
511
- def defer_for_delayed_job?
512
- NewRelic::Agent.config[:dispatcher] == :delayed_job &&
513
- !NewRelic::DelayedJobInjection.worker_name
514
- end
515
-
516
- # Check to see if the agent should start, returning +true+ if it should.
517
- def agent_should_start?
518
- return false if already_started? || disabled?
519
-
520
- if defer_for_delayed_job?
521
- ::NewRelic::Agent.logger.debug "Deferring startup for DelayedJob"
522
- return false
523
- end
524
-
525
- if defer_for_resque?
526
- ::NewRelic::Agent.logger.debug "Deferring startup for Resque in case it daemonizes"
527
- return false
528
- end
529
-
530
- unless app_name_configured?
531
- NewRelic::Agent.logger.error "No application name configured.",
532
- "The Agent cannot start without at least one. Please check your ",
533
- "newrelic.yml and ensure that it is valid and has at least one ",
534
- "value set for app_name in the #{NewRelic::Control.instance.env} ",
535
- "environment."
536
- return false
537
- end
538
-
539
- return true
540
- end
541
-
542
- # Logs a bunch of data and starts the agent, if needed
543
- def start
544
- return unless agent_should_start?
545
-
546
- log_startup
547
- check_config_and_start_agent
548
- log_version_and_pid
549
-
550
- events.subscribe(:initial_configuration_complete) do
551
- log_ignore_url_regexes
552
- end
553
- end
554
-
555
294
  # Clear out the metric data, errors, and transaction traces, etc.
556
295
  def drop_buffered_data
557
296
  @stats_engine.reset!
@@ -560,6 +299,7 @@ module NewRelic
560
299
  @transaction_event_recorder.drop_buffered_data
561
300
  @custom_event_aggregator.reset!
562
301
  @span_event_aggregator.reset!
302
+ @log_event_aggregator.reset!
563
303
  @sql_sampler.reset!
564
304
 
565
305
  if Agent.config[:clear_transaction_state_after_fork]
@@ -576,330 +316,34 @@ module NewRelic
576
316
 
577
317
  def flush_pipe_data
578
318
  if connected? && @service.is_a?(PipeService)
579
- transmit_data
580
- transmit_analytic_event_data
581
- transmit_custom_event_data
582
- transmit_error_event_data
583
- transmit_span_event_data
319
+ transmit_data_types
584
320
  end
585
321
  end
586
322
 
587
323
  private
588
324
 
589
- # All of this module used to be contained in the
590
- # start_worker_thread method - this is an artifact of
591
- # refactoring and can be moved, renamed, etc at will
592
- module StartWorkerThread
593
- def create_event_loop
594
- EventLoop.new
595
- end
596
-
597
- LOG_ONCE_KEYS_RESET_PERIOD = 60.0
598
-
599
- # Certain event types may sometimes need to be on the same interval as metrics,
600
- # so we will check config assigned in EventHarvestConfig to determine the interval
601
- # on which to report them
602
- def interval_for event_type
603
- interval = Agent.config[:"event_report_period.#{event_type}"]
604
- :"#{interval}_second_harvest"
605
- end
606
-
607
- ANALYTIC_EVENT_DATA = "analytic_event_data".freeze
608
- CUSTOM_EVENT_DATA = "custom_event_data".freeze
609
- ERROR_EVENT_DATA = "error_event_data".freeze
610
- SPAN_EVENT_DATA = "span_event_data".freeze
611
-
612
- def create_and_run_event_loop
613
- data_harvest = :"#{Agent.config[:data_report_period]}_second_harvest"
614
- event_harvest = :"#{Agent.config[:event_report_period]}_second_harvest"
615
-
616
- @event_loop = create_event_loop
617
- @event_loop.on(data_harvest) do
618
- transmit_data
619
- end
620
-
621
- @event_loop.on(interval_for ANALYTIC_EVENT_DATA) do
622
- transmit_analytic_event_data
623
- end
624
- @event_loop.on(interval_for CUSTOM_EVENT_DATA) do
625
- transmit_custom_event_data
626
- end
627
- @event_loop.on(interval_for ERROR_EVENT_DATA) do
628
- transmit_error_event_data
629
- end
630
- @event_loop.on(interval_for SPAN_EVENT_DATA) do
631
- transmit_span_event_data
632
- end
633
- @event_loop.on(:reset_log_once_keys) do
634
- ::NewRelic::Agent.logger.clear_already_logged
635
- end
636
- @event_loop.fire_every(Agent.config[:data_report_period], data_harvest)
637
- @event_loop.fire_every(Agent.config[:event_report_period], event_harvest)
638
- @event_loop.fire_every(LOG_ONCE_KEYS_RESET_PERIOD, :reset_log_once_keys)
639
-
640
- @event_loop.run
641
- end
642
-
643
- # Handles the case where the server tells us to restart -
644
- # this clears the data, clears connection attempts, and
645
- # waits a while to reconnect.
646
- def handle_force_restart(error)
647
- ::NewRelic::Agent.logger.debug error.message
648
- drop_buffered_data
649
- @service.force_restart if @service
650
- @connect_state = :pending
651
- sleep 30
652
- end
653
-
654
- # when a disconnect is requested, stop the current thread, which
655
- # is the worker thread that gathers data and talks to the
656
- # server.
657
- def handle_force_disconnect(error)
658
- ::NewRelic::Agent.logger.warn "Agent received a ForceDisconnectException from the server, disconnecting. (#{error.message})"
659
- disconnect
660
- end
661
-
662
- # Handles an unknown error in the worker thread by logging
663
- # it and disconnecting the agent, since we are now in an
664
- # unknown state.
665
- def handle_other_error(error)
666
- ::NewRelic::Agent.logger.error "Unhandled error in worker thread, disconnecting."
667
- # These errors are fatal (that is, they will prevent the agent from
668
- # reporting entirely), so we really want backtraces when they happen
669
- ::NewRelic::Agent.logger.log_exception(:error, error)
670
- disconnect
671
- end
672
-
673
- # a wrapper method to handle all the errors that can happen
674
- # in the connection and worker thread system. This
675
- # guarantees a no-throw from the background thread.
676
- def catch_errors
677
- yield
678
- rescue NewRelic::Agent::ForceRestartException => e
679
- handle_force_restart(e)
680
- retry
681
- rescue NewRelic::Agent::ForceDisconnectException => e
682
- handle_force_disconnect(e)
683
- rescue => e
684
- handle_other_error(e)
685
- end
686
-
687
- # This is the method that is run in a new thread in order to
688
- # background the harvesting and sending of data during the
689
- # normal operation of the agent.
690
- #
691
- # Takes connection options that determine how we should
692
- # connect to the server, and loops endlessly - typically we
693
- # never return from this method unless we're shutting down
694
- # the agent
695
- def deferred_work!(connection_options)
696
- catch_errors do
697
- NewRelic::Agent.disable_all_tracing do
698
- connect(connection_options)
699
- if connected?
700
- create_and_run_event_loop
701
- # never reaches here unless there is a problem or
702
- # the agent is exiting
703
- else
704
- ::NewRelic::Agent.logger.debug "No connection. Worker thread ending."
705
- end
706
- end
707
- end
708
- end
709
- end
710
- include StartWorkerThread
711
-
712
- # Try to launch the worker thread and connect to the server.
713
- #
714
- # See #connect for a description of connection_options.
715
- def start_worker_thread(connection_options = {})
716
- if disable = NewRelic::Agent.config[:disable_harvest_thread]
717
- NewRelic::Agent.logger.info "Not starting Ruby Agent worker thread because :disable_harvest_thread is #{disable}"
718
- return
719
- end
720
-
721
- ::NewRelic::Agent.logger.debug "Creating Ruby Agent worker thread."
722
- @worker_thread = Threading::AgentThread.create('Worker Loop') do
723
- deferred_work!(connection_options)
724
- end
725
- end
726
-
727
325
  # A shorthand for NewRelic::Control.instance
728
326
  def control
729
327
  NewRelic::Control.instance
730
328
  end
731
329
 
732
- # This module is an artifact of a refactoring of the connect
733
- # method - all of its methods are used in that context, so it
734
- # can be refactored at will. It should be fully tested
735
- module Connect
736
- # number of attempts we've made to contact the server
737
- attr_accessor :connect_attempts
738
-
739
- # Disconnect just sets the connect state to disconnected, preventing
740
- # further retries.
741
- def disconnect
742
- @connect_state = :disconnected
743
- true
744
- end
745
-
746
- def connected?
747
- @connect_state == :connected
748
- end
749
-
750
- def disconnected?
751
- @connect_state == :disconnected
752
- end
753
-
754
- # Don't connect if we're already connected, or if we tried to connect
755
- # and were rejected with prejudice because of a license issue, unless
756
- # we're forced to by force_reconnect.
757
- def should_connect?(force=false)
758
- force || (!connected? && !disconnected?)
759
- end
760
-
761
- # Per the spec at
762
- # /agents/agent-specs/Collector-Response-Handling.md, retry
763
- # connections after a specific backoff sequence to prevent
764
- # hammering the server.
765
- def connect_retry_period
766
- NewRelic::CONNECT_RETRY_PERIODS[connect_attempts] || NewRelic::MAX_RETRY_PERIOD
767
- end
768
-
769
- def note_connect_failure
770
- self.connect_attempts += 1
771
- end
772
-
773
- # When we have a problem connecting to the server, we need
774
- # to tell the user what happened, since this is not an error
775
- # we can handle gracefully.
776
- def log_error(error)
777
- ::NewRelic::Agent.logger.error "Error establishing connection with New Relic Service at #{control.server}:", error
778
- end
779
-
780
- # When the server sends us an error with the license key, we
781
- # want to tell the user that something went wrong, and let
782
- # them know where to go to get a valid license key
783
- #
784
- # After this runs, it disconnects the agent so that it will
785
- # no longer try to connect to the server, saving the
786
- # application and the server load
787
- def handle_license_error(error)
788
- ::NewRelic::Agent.logger.error( \
789
- error.message, \
790
- "Visit NewRelic.com to obtain a valid license key, or to upgrade your account.")
791
- disconnect
792
- end
793
-
794
- def handle_unrecoverable_agent_error(error)
795
- ::NewRelic::Agent.logger.error(error.message)
796
- disconnect
797
- shutdown
798
- end
799
-
800
- # Checks whether we should send environment info, and if so,
801
- # returns the snapshot from the local environment.
802
- # Generating the EnvironmentReport has the potential to trigger
803
- # require calls in Rails environments, so this method should only
804
- # be called synchronously from on the main thread.
805
- def environment_for_connect
806
- @environment_report ||= Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
807
- end
808
-
809
- # Constructs and memoizes an event_harvest_config hash to be used in
810
- # the payload sent during connect (and reconnect)
811
- def event_harvest_config
812
- @event_harvest_config ||= Configuration::EventHarvestConfig.from_config(Agent.config)
813
- end
814
-
815
- # Builds the payload to send to the connect service,
816
- # connects, then configures the agent using the response from
817
- # the connect service
818
- def connect_to_server
819
- request_builder = ::NewRelic::Agent::Connect::RequestBuilder.new \
820
- @service,
821
- Agent.config,
822
- event_harvest_config,
823
- environment_for_connect
824
- connect_response = @service.connect request_builder.connect_payload
825
-
826
- response_handler = ::NewRelic::Agent::Connect::ResponseHandler.new(self, Agent.config)
827
- response_handler.configure_agent(connect_response)
828
-
829
- log_connection connect_response if connect_response
830
- connect_response
831
- end
832
-
833
- # Logs when we connect to the server, for debugging purposes
834
- # - makes sure we know if an agent has not connected
835
- def log_connection(config_data)
836
- ::NewRelic::Agent.logger.debug "Connected to NewRelic Service at #{@service.collector.name}"
837
- ::NewRelic::Agent.logger.debug "Agent Run = #{@service.agent_id}."
838
- ::NewRelic::Agent.logger.debug "Connection data = #{config_data.inspect}"
839
- if config_data['messages'] && config_data['messages'].any?
840
- log_collector_messages(config_data['messages'])
841
- end
842
- end
843
-
844
- def log_collector_messages(messages)
845
- messages.each do |message|
846
- ::NewRelic::Agent.logger.send(message['level'].downcase, message['message'])
847
- end
848
- end
849
-
850
- # apdex_f is always 4 times the apdex_t
851
- def apdex_f
852
- (4 * Agent.config[:apdex_t]).to_f
853
- end
854
-
855
- class WaitOnConnectTimeout < StandardError
856
- end
857
-
858
- # Used for testing to let us know we've actually started to wait
859
- def waited_on_connect?
860
- @waited_on_connect
861
- end
862
-
863
- def signal_connected
864
- @wait_on_connect_mutex.synchronize do
865
- @wait_on_connect_condition.signal
866
- end
867
- end
868
-
869
- def wait_on_connect(timeout)
870
- return if connected?
871
-
872
- @waited_on_connect = true
873
- NewRelic::Agent.logger.debug("Waiting on connect to complete.")
874
-
875
- @wait_on_connect_mutex.synchronize do
876
- @wait_on_connect_condition.wait(@wait_on_connect_mutex, timeout)
877
- end
878
-
879
- unless connected?
880
- raise WaitOnConnectTimeout, "Agent was unable to connect in #{timeout} seconds."
881
- end
882
- end
883
-
884
- end
885
- include Connect
886
-
887
330
  def container_for_endpoint(endpoint)
888
331
  case endpoint
889
- when :metric_data then @stats_engine
332
+ when :metric_data then @stats_engine
890
333
  when :transaction_sample_data then @transaction_sampler
891
- when :error_data then @error_collector.error_trace_aggregator
892
- when :error_event_data then @error_collector.error_event_aggregator
893
- when :analytic_event_data then transaction_event_aggregator
894
- when :custom_event_data then @custom_event_aggregator
895
- when :span_event_data then span_event_aggregator
896
- when :sql_trace_data then @sql_sampler
334
+ when :error_data then @error_collector.error_trace_aggregator
335
+ when :error_event_data then @error_collector.error_event_aggregator
336
+ when :analytic_event_data then transaction_event_aggregator
337
+ when :custom_event_data then @custom_event_aggregator
338
+ when :span_event_data then span_event_aggregator
339
+ when :sql_trace_data then @sql_sampler
340
+ when :log_event_data then @log_event_aggregator
897
341
  end
898
342
  end
899
343
 
900
344
  def merge_data_for_endpoint(endpoint, data)
901
345
  if data && !data.empty?
902
- container = container_for_endpoint endpoint
346
+ container = container_for_endpoint(endpoint)
903
347
  if container.respond_to?(:has_metadata?) && container.has_metadata?
904
348
  container_for_endpoint(endpoint).merge!(data, false)
905
349
  else
@@ -912,284 +356,11 @@ module NewRelic
912
356
 
913
357
  public :merge_data_for_endpoint
914
358
 
915
- # Establish a connection to New Relic servers.
916
- #
917
- # By default, if a connection has already been established, this method
918
- # will be a no-op.
919
- #
920
- # @param [Hash] options
921
- # @option options [Boolean] :keep_retrying (true)
922
- # If true, this method will block until a connection is successfully
923
- # established, continuing to retry upon failure. If false, this method
924
- # will return after either successfully connecting, or after failing
925
- # once.
926
- #
927
- # @option options [Boolean] :force_reconnect (false)
928
- # If true, this method will force establishment of a new connection
929
- # with New Relic, even if there is already an existing connection.
930
- # This is useful primarily when re-establishing a new connection after
931
- # forking off from a parent process.
932
- #
933
- def connect(options={})
934
- defaults = {
935
- :keep_retrying => Agent.config[:keep_retrying],
936
- :force_reconnect => Agent.config[:force_reconnect]
937
- }
938
- opts = defaults.merge(options)
939
-
940
- return unless should_connect?(opts[:force_reconnect])
941
-
942
- ::NewRelic::Agent.logger.debug "Connecting Process to New Relic: #$0"
943
- connect_to_server
944
- @connected_pid = $$
945
- @connect_state = :connected
946
- signal_connected
947
- rescue NewRelic::Agent::ForceDisconnectException => e
948
- handle_force_disconnect(e)
949
- rescue NewRelic::Agent::LicenseException => e
950
- handle_license_error(e)
951
- rescue NewRelic::Agent::UnrecoverableAgentException => e
952
- handle_unrecoverable_agent_error(e)
953
- rescue StandardError, Timeout::Error, NewRelic::Agent::ServerConnectionException => e
954
- # Allow a killed (aborting) thread to continue exiting during shutdown.
955
- # See: https://github.com/newrelic/newrelic-ruby-agent/issues/340
956
- raise if Thread.current.status == 'aborting'
957
-
958
- log_error(e)
959
- if opts[:keep_retrying]
960
- note_connect_failure
961
- ::NewRelic::Agent.logger.info "Will re-attempt in #{connect_retry_period} seconds"
962
- sleep connect_retry_period
963
- retry
964
- end
965
- rescue Exception => e
966
- ::NewRelic::Agent.logger.error "Exception of unexpected type during Agent#connect():", e
967
-
968
- raise
969
- end
970
-
971
359
  # Delegates to the control class to determine the root
972
360
  # directory of this project
973
361
  def determine_home_directory
974
362
  control.root
975
363
  end
976
-
977
- # Harvests data from the given container, sends it to the named endpoint
978
- # on the service, and automatically merges back in upon a recoverable
979
- # failure.
980
- #
981
- # The given container should respond to:
982
- #
983
- # #harvest!
984
- # returns a payload that contains enumerable collection of data items and
985
- # optional metadata to be sent to the collector.
986
- #
987
- # #reset!
988
- # drop any stored data and reset to a clean state.
989
- #
990
- # #merge!(payload)
991
- # merge the given payload back into the internal buffer of the
992
- # container, so that it may be harvested again later.
993
- #
994
- def harvest_and_send_from_container(container, endpoint)
995
- payload = harvest_from_container(container, endpoint)
996
- sample_count = harvest_size container, payload
997
- if sample_count > 0
998
- NewRelic::Agent.logger.debug("Sending #{sample_count} items to #{endpoint}")
999
- send_data_to_endpoint(endpoint, payload, container)
1000
- end
1001
- end
1002
-
1003
- def harvest_size container, items
1004
- if container.respond_to?(:has_metadata?) && container.has_metadata? && !items.empty?
1005
- items.last.size
1006
- else
1007
- items.size
1008
- end
1009
- end
1010
-
1011
- def harvest_from_container(container, endpoint)
1012
- items = []
1013
- begin
1014
- items = container.harvest!
1015
- rescue => e
1016
- NewRelic::Agent.logger.error("Failed to harvest #{endpoint} data, resetting. Error: ", e)
1017
- container.reset!
1018
- end
1019
- items
1020
- end
1021
-
1022
- def send_data_to_endpoint(endpoint, payload, container)
1023
- begin
1024
- @service.send(endpoint, payload)
1025
- rescue ForceRestartException, ForceDisconnectException
1026
- raise
1027
- rescue SerializationError => e
1028
- NewRelic::Agent.logger.warn("Failed to serialize data for #{endpoint}, discarding. Error: ", e)
1029
- rescue UnrecoverableServerException => e
1030
- NewRelic::Agent.logger.warn("#{endpoint} data was rejected by remote service, discarding. Error: ", e)
1031
- rescue ServerConnectionException => e
1032
- log_remote_unavailable(endpoint, e)
1033
- container.merge!(payload)
1034
- rescue => e
1035
- NewRelic::Agent.logger.info("Unable to send #{endpoint} data, will try again later. Error: ", e)
1036
- container.merge!(payload)
1037
- end
1038
- end
1039
-
1040
- def harvest_and_send_timeslice_data
1041
- TransactionTimeAggregator.harvest!
1042
- harvest_and_send_from_container(@stats_engine, :metric_data)
1043
- end
1044
-
1045
- def harvest_and_send_slowest_sql
1046
- harvest_and_send_from_container(@sql_sampler, :sql_trace_data)
1047
- end
1048
-
1049
- # This handles getting the transaction traces and then sending
1050
- # them across the wire. This includes gathering SQL
1051
- # explanations, stripping out stack traces, and normalizing
1052
- # SQL. note that we explain only the sql statements whose
1053
- # nodes' execution times exceed our threshold (to avoid
1054
- # unnecessary overhead of running explains on fast queries.)
1055
- def harvest_and_send_transaction_traces
1056
- harvest_and_send_from_container(@transaction_sampler, :transaction_sample_data)
1057
- end
1058
-
1059
- def harvest_and_send_for_agent_commands
1060
- harvest_and_send_from_container(@agent_command_router, :profile_data)
1061
- end
1062
-
1063
- def harvest_and_send_errors
1064
- harvest_and_send_from_container(@error_collector.error_trace_aggregator, :error_data)
1065
- end
1066
-
1067
- def harvest_and_send_analytic_event_data
1068
- harvest_and_send_from_container(transaction_event_aggregator, :analytic_event_data)
1069
- harvest_and_send_from_container(synthetics_event_aggregator, :analytic_event_data)
1070
- end
1071
-
1072
- def harvest_and_send_custom_event_data
1073
- harvest_and_send_from_container(@custom_event_aggregator, :custom_event_data)
1074
- end
1075
-
1076
- def harvest_and_send_error_event_data
1077
- harvest_and_send_from_container @error_collector.error_event_aggregator, :error_event_data
1078
- end
1079
-
1080
- def harvest_and_send_span_event_data
1081
- harvest_and_send_from_container(span_event_aggregator, :span_event_data)
1082
- end
1083
-
1084
- def check_for_and_handle_agent_commands
1085
- begin
1086
- @agent_command_router.check_for_and_handle_agent_commands
1087
- rescue ForceRestartException, ForceDisconnectException
1088
- raise
1089
- rescue UnrecoverableServerException => e
1090
- NewRelic::Agent.logger.warn("get_agent_commands message was rejected by remote service, discarding. Error: ", e)
1091
- rescue ServerConnectionException => e
1092
- log_remote_unavailable(:get_agent_commands, e)
1093
- rescue => e
1094
- NewRelic::Agent.logger.info("Error during check_for_and_handle_agent_commands, will retry later: ", e)
1095
- end
1096
- end
1097
-
1098
- def log_remote_unavailable(endpoint, e)
1099
- NewRelic::Agent.logger.debug("Unable to send #{endpoint} data, will try again later. Error: ", e)
1100
- NewRelic::Agent.record_metric("Supportability/remote_unavailable", 0.0)
1101
- NewRelic::Agent.record_metric("Supportability/remote_unavailable/#{endpoint.to_s}", 0.0)
1102
- end
1103
-
1104
- TRANSACTION_EVENT = "TransactionEvent".freeze
1105
- def transmit_analytic_event_data
1106
- transmit_single_data_type(:harvest_and_send_analytic_event_data, TRANSACTION_EVENT)
1107
- end
1108
-
1109
- CUSTOM_EVENT = "CustomEvent".freeze
1110
- def transmit_custom_event_data
1111
- transmit_single_data_type(:harvest_and_send_custom_event_data, CUSTOM_EVENT)
1112
- end
1113
-
1114
- ERROR_EVENT = "ErrorEvent".freeze
1115
- def transmit_error_event_data
1116
- transmit_single_data_type(:harvest_and_send_error_event_data, ERROR_EVENT)
1117
- end
1118
-
1119
- SPAN_EVENT = "SpanEvent".freeze
1120
- def transmit_span_event_data
1121
- transmit_single_data_type(:harvest_and_send_span_event_data, SPAN_EVENT)
1122
- end
1123
-
1124
- def transmit_single_data_type(harvest_method, supportability_name)
1125
- now = Time.now
1126
-
1127
- msg = "Sending #{supportability_name} data to New Relic Service"
1128
- ::NewRelic::Agent.logger.debug msg
1129
-
1130
- @service.session do # use http keep-alive
1131
- self.send(harvest_method)
1132
- end
1133
- ensure
1134
- duration = (Time.now - now).to_f
1135
- NewRelic::Agent.record_metric("Supportability/#{supportability_name}Harvest", duration)
1136
- end
1137
-
1138
- def transmit_data
1139
- now = Time.now
1140
- ::NewRelic::Agent.logger.debug "Sending data to New Relic Service"
1141
-
1142
- @events.notify(:before_harvest)
1143
- @service.session do # use http keep-alive
1144
- harvest_and_send_errors
1145
- harvest_and_send_error_event_data
1146
- harvest_and_send_transaction_traces
1147
- harvest_and_send_slowest_sql
1148
- harvest_and_send_timeslice_data
1149
- harvest_and_send_span_event_data
1150
-
1151
- check_for_and_handle_agent_commands
1152
- harvest_and_send_for_agent_commands
1153
- end
1154
- ensure
1155
- NewRelic::Agent::Database.close_connections
1156
- duration = (Time.now - now).to_f
1157
- NewRelic::Agent.record_metric('Supportability/Harvest', duration)
1158
- end
1159
-
1160
- # This method contacts the server to send remaining data and
1161
- # let the server know that the agent is shutting down - this
1162
- # allows us to do things like accurately set the end of the
1163
- # lifetime of the process
1164
- #
1165
- # If this process comes from a parent process, it will not
1166
- # disconnect, so that the parent process can continue to send data
1167
- def graceful_disconnect
1168
- if connected?
1169
- begin
1170
- @service.request_timeout = 10
1171
-
1172
- @events.notify(:before_shutdown)
1173
- transmit_data
1174
- transmit_analytic_event_data
1175
- transmit_custom_event_data
1176
- transmit_error_event_data
1177
- transmit_span_event_data
1178
-
1179
- if @connected_pid == $$ && !@service.kind_of?(NewRelic::Agent::NewRelicService)
1180
- ::NewRelic::Agent.logger.debug "Sending New Relic service agent run shutdown message"
1181
- @service.shutdown(Time.now.to_f)
1182
- else
1183
- ::NewRelic::Agent.logger.debug "This agent connected from parent process #{@connected_pid}--not sending shutdown"
1184
- end
1185
- ::NewRelic::Agent.logger.debug "Graceful disconnect complete"
1186
- rescue Timeout::Error, StandardError => e
1187
- ::NewRelic::Agent.logger.debug "Error when disconnecting #{e.class.name}: #{e.message}"
1188
- end
1189
- else
1190
- ::NewRelic::Agent.logger.debug "Bypassing graceful disconnect - agent not connected"
1191
- end
1192
- end
1193
364
  end
1194
365
 
1195
366
  extend ClassMethods