newrelic_rpm 8.10.0 → 8.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (391) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +32 -190
  4. data/.rubocop_todo.yml +52 -0
  5. data/.simplecov +11 -2
  6. data/CHANGELOG.md +91 -26
  7. data/Gemfile +0 -1
  8. data/README.md +1 -1
  9. data/Rakefile +3 -20
  10. data/Thorfile +5 -0
  11. data/bin/nrdebug +63 -43
  12. data/config.dot +5 -5
  13. data/init.rb +1 -2
  14. data/install.rb +1 -2
  15. data/lib/new_relic/agent/adaptive_sampler.rb +0 -1
  16. data/lib/new_relic/agent/agent/shutdown.rb +0 -1
  17. data/lib/new_relic/agent/agent/special_startup.rb +0 -1
  18. data/lib/new_relic/agent/agent/start_worker_thread.rb +0 -1
  19. data/lib/new_relic/agent/agent/startup.rb +0 -1
  20. data/lib/new_relic/agent/agent.rb +100 -73
  21. data/lib/new_relic/agent/agent_logger.rb +4 -5
  22. data/lib/new_relic/agent/attribute_filter.rb +39 -21
  23. data/lib/new_relic/agent/attribute_processing.rb +3 -4
  24. data/lib/new_relic/agent/attributes.rb +0 -1
  25. data/lib/new_relic/agent/audit_logger.rb +2 -3
  26. data/lib/new_relic/agent/autostart.rb +0 -1
  27. data/lib/new_relic/agent/chained_call.rb +0 -1
  28. data/lib/new_relic/agent/commands/agent_command.rb +0 -1
  29. data/lib/new_relic/agent/commands/agent_command_router.rb +3 -4
  30. data/lib/new_relic/agent/commands/thread_profiler_session.rb +0 -1
  31. data/lib/new_relic/agent/configuration/default_source.rb +56 -27
  32. data/lib/new_relic/agent/configuration/dotted_hash.rb +1 -2
  33. data/lib/new_relic/agent/configuration/environment_source.rb +3 -4
  34. data/lib/new_relic/agent/configuration/event_harvest_config.rb +0 -1
  35. data/lib/new_relic/agent/configuration/high_security_source.rb +0 -1
  36. data/lib/new_relic/agent/configuration/manager.rb +1 -2
  37. data/lib/new_relic/agent/configuration/manual_source.rb +0 -1
  38. data/lib/new_relic/agent/configuration/mask_defaults.rb +2 -3
  39. data/lib/new_relic/agent/configuration/security_policy_source.rb +0 -1
  40. data/lib/new_relic/agent/configuration/server_source.rb +0 -1
  41. data/lib/new_relic/agent/configuration/yaml_source.rb +2 -3
  42. data/lib/new_relic/agent/configuration.rb +0 -1
  43. data/lib/new_relic/agent/connect/request_builder.rb +1 -2
  44. data/lib/new_relic/agent/connect/response_handler.rb +1 -2
  45. data/lib/new_relic/agent/custom_event_aggregator.rb +0 -1
  46. data/lib/new_relic/agent/database/explain_plan_helpers.rb +0 -1
  47. data/lib/new_relic/agent/database/obfuscation_helpers.rb +0 -1
  48. data/lib/new_relic/agent/database/obfuscator.rb +0 -1
  49. data/lib/new_relic/agent/database/postgres_explain_obfuscator.rb +0 -1
  50. data/lib/new_relic/agent/database.rb +13 -14
  51. data/lib/new_relic/agent/database_adapter.rb +0 -1
  52. data/lib/new_relic/agent/datastores/metric_helper.rb +0 -4
  53. data/lib/new_relic/agent/datastores/mongo/event_formatter.rb +2 -3
  54. data/lib/new_relic/agent/datastores/mongo/metric_translator.rb +1 -4
  55. data/lib/new_relic/agent/datastores/mongo/obfuscator.rb +0 -1
  56. data/lib/new_relic/agent/datastores/mongo.rb +0 -1
  57. data/lib/new_relic/agent/datastores/redis.rb +0 -1
  58. data/lib/new_relic/agent/datastores.rb +0 -1
  59. data/lib/new_relic/agent/deprecator.rb +0 -1
  60. data/lib/new_relic/agent/distributed_tracing/cross_app_payload.rb +0 -1
  61. data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb +0 -1
  62. data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +0 -1
  63. data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb +0 -1
  64. data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb +0 -2
  65. data/lib/new_relic/agent/distributed_tracing/distributed_trace_transport_type.rb +0 -1
  66. data/lib/new_relic/agent/distributed_tracing/trace_context.rb +0 -1
  67. data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +0 -1
  68. data/lib/new_relic/agent/distributed_tracing.rb +0 -1
  69. data/lib/new_relic/agent/encoding_normalizer.rb +0 -1
  70. data/lib/new_relic/agent/error_collector.rb +0 -1
  71. data/lib/new_relic/agent/error_event_aggregator.rb +0 -1
  72. data/lib/new_relic/agent/error_filter.rb +4 -5
  73. data/lib/new_relic/agent/error_trace_aggregator.rb +1 -2
  74. data/lib/new_relic/agent/event_aggregator.rb +0 -1
  75. data/lib/new_relic/agent/event_buffer.rb +0 -1
  76. data/lib/new_relic/agent/event_listener.rb +0 -1
  77. data/lib/new_relic/agent/event_loop.rb +2 -3
  78. data/lib/new_relic/agent/external.rb +1 -2
  79. data/lib/new_relic/agent/guid_generator.rb +0 -1
  80. data/lib/new_relic/agent/harvester.rb +0 -1
  81. data/lib/new_relic/agent/heap.rb +2 -3
  82. data/lib/new_relic/agent/hostname.rb +0 -1
  83. data/lib/new_relic/agent/http_clients/abstract.rb +0 -1
  84. data/lib/new_relic/agent/http_clients/curb_wrappers.rb +0 -1
  85. data/lib/new_relic/agent/http_clients/excon_wrappers.rb +0 -1
  86. data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb +1 -2
  87. data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb +1 -2
  88. data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +0 -1
  89. data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb +1 -2
  90. data/lib/new_relic/agent/http_clients/uri_util.rb +0 -1
  91. data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb +0 -1
  92. data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +8 -5
  93. data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb +1 -2
  94. data/lib/new_relic/agent/instrumentation/active_job.rb +0 -1
  95. data/lib/new_relic/agent/instrumentation/active_merchant.rb +2 -2
  96. data/lib/new_relic/agent/instrumentation/active_record.rb +0 -1
  97. data/lib/new_relic/agent/instrumentation/active_record_helper.rb +0 -1
  98. data/lib/new_relic/agent/instrumentation/active_record_notifications.rb +0 -1
  99. data/lib/new_relic/agent/instrumentation/active_record_prepend.rb +0 -1
  100. data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +0 -1
  101. data/lib/new_relic/agent/instrumentation/active_storage.rb +0 -1
  102. data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb +0 -1
  103. data/lib/new_relic/agent/instrumentation/active_support_logger/chain.rb +0 -1
  104. data/lib/new_relic/agent/instrumentation/active_support_logger/instrumentation.rb +0 -1
  105. data/lib/new_relic/agent/instrumentation/active_support_logger/prepend.rb +0 -1
  106. data/lib/new_relic/agent/instrumentation/active_support_logger.rb +0 -1
  107. data/lib/new_relic/agent/instrumentation/acts_as_solr.rb +0 -1
  108. data/lib/new_relic/agent/instrumentation/authlogic.rb +0 -1
  109. data/lib/new_relic/agent/instrumentation/bunny/chain.rb +0 -1
  110. data/lib/new_relic/agent/instrumentation/bunny/instrumentation.rb +0 -1
  111. data/lib/new_relic/agent/instrumentation/bunny/prepend.rb +0 -1
  112. data/lib/new_relic/agent/instrumentation/bunny.rb +0 -1
  113. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +2 -3
  114. data/lib/new_relic/agent/instrumentation/curb/chain.rb +0 -1
  115. data/lib/new_relic/agent/instrumentation/curb/instrumentation.rb +14 -11
  116. data/lib/new_relic/agent/instrumentation/curb/prepend.rb +0 -1
  117. data/lib/new_relic/agent/instrumentation/curb.rb +0 -1
  118. data/lib/new_relic/agent/instrumentation/data_mapper.rb +1 -2
  119. data/lib/new_relic/agent/instrumentation/delayed_job/chain.rb +0 -1
  120. data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb +0 -1
  121. data/lib/new_relic/agent/instrumentation/delayed_job/prepend.rb +0 -1
  122. data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb +0 -1
  123. data/lib/new_relic/agent/instrumentation/excon/middleware.rb +0 -1
  124. data/lib/new_relic/agent/instrumentation/excon.rb +0 -1
  125. data/lib/new_relic/agent/instrumentation/grape/chain.rb +0 -1
  126. data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb +0 -1
  127. data/lib/new_relic/agent/instrumentation/grape/prepend.rb +0 -1
  128. data/lib/new_relic/agent/instrumentation/grape.rb +0 -1
  129. data/lib/new_relic/agent/instrumentation/grpc/client/chain.rb +0 -9
  130. data/lib/new_relic/agent/instrumentation/grpc/client/instrumentation.rb +10 -9
  131. data/lib/new_relic/agent/instrumentation/grpc/client/prepend.rb +0 -6
  132. data/lib/new_relic/agent/instrumentation/grpc/client/request_wrapper.rb +0 -1
  133. data/lib/new_relic/agent/instrumentation/grpc/helper.rb +2 -1
  134. data/lib/new_relic/agent/instrumentation/grpc/server/chain.rb +0 -1
  135. data/lib/new_relic/agent/instrumentation/grpc/server/instrumentation.rb +0 -1
  136. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_desc_prepend.rb +0 -1
  137. data/lib/new_relic/agent/instrumentation/grpc/server/rpc_server_prepend.rb +0 -1
  138. data/lib/new_relic/agent/instrumentation/grpc_client.rb +0 -1
  139. data/lib/new_relic/agent/instrumentation/grpc_server.rb +0 -1
  140. data/lib/new_relic/agent/instrumentation/httpclient/chain.rb +0 -1
  141. data/lib/new_relic/agent/instrumentation/httpclient/instrumentation.rb +0 -1
  142. data/lib/new_relic/agent/instrumentation/httpclient/prepend.rb +0 -1
  143. data/lib/new_relic/agent/instrumentation/httpclient.rb +0 -1
  144. data/lib/new_relic/agent/instrumentation/httprb/chain.rb +0 -1
  145. data/lib/new_relic/agent/instrumentation/httprb/instrumentation.rb +0 -1
  146. data/lib/new_relic/agent/instrumentation/httprb/prepend.rb +0 -1
  147. data/lib/new_relic/agent/instrumentation/httprb.rb +0 -1
  148. data/lib/new_relic/agent/instrumentation/ignore_actions.rb +0 -1
  149. data/lib/new_relic/agent/instrumentation/logger/chain.rb +0 -1
  150. data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb +0 -1
  151. data/lib/new_relic/agent/instrumentation/logger/prepend.rb +0 -1
  152. data/lib/new_relic/agent/instrumentation/logger.rb +0 -1
  153. data/lib/new_relic/agent/instrumentation/memcache/chain.rb +0 -1
  154. data/lib/new_relic/agent/instrumentation/memcache/dalli.rb +1 -2
  155. data/lib/new_relic/agent/instrumentation/memcache/helper.rb +0 -1
  156. data/lib/new_relic/agent/instrumentation/memcache/instrumentation.rb +0 -1
  157. data/lib/new_relic/agent/instrumentation/memcache/prepend.rb +1 -2
  158. data/lib/new_relic/agent/instrumentation/memcache.rb +4 -5
  159. data/lib/new_relic/agent/instrumentation/middleware_proxy.rb +1 -2
  160. data/lib/new_relic/agent/instrumentation/middleware_tracing.rb +0 -1
  161. data/lib/new_relic/agent/instrumentation/mongo.rb +0 -1
  162. data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb +1 -2
  163. data/lib/new_relic/agent/instrumentation/net_http/chain.rb +0 -1
  164. data/lib/new_relic/agent/instrumentation/net_http/instrumentation.rb +0 -1
  165. data/lib/new_relic/agent/instrumentation/net_http/prepend.rb +0 -1
  166. data/lib/new_relic/agent/instrumentation/net_http.rb +0 -1
  167. data/lib/new_relic/agent/instrumentation/notifications_subscriber.rb +2 -3
  168. data/lib/new_relic/agent/instrumentation/padrino/chain.rb +0 -1
  169. data/lib/new_relic/agent/instrumentation/padrino/instrumentation.rb +0 -1
  170. data/lib/new_relic/agent/instrumentation/padrino/prepend.rb +0 -1
  171. data/lib/new_relic/agent/instrumentation/padrino.rb +0 -1
  172. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +0 -1
  173. data/lib/new_relic/agent/instrumentation/queue_time.rb +0 -2
  174. data/lib/new_relic/agent/instrumentation/rack/chain.rb +0 -1
  175. data/lib/new_relic/agent/instrumentation/rack/helpers.rb +0 -1
  176. data/lib/new_relic/agent/instrumentation/rack/instrumentation.rb +0 -1
  177. data/lib/new_relic/agent/instrumentation/rack/prepend.rb +0 -1
  178. data/lib/new_relic/agent/instrumentation/rack.rb +0 -1
  179. data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +0 -1
  180. data/lib/new_relic/agent/instrumentation/rails_middleware.rb +0 -1
  181. data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb +0 -1
  182. data/lib/new_relic/agent/instrumentation/rails_notifications/action_controller.rb +0 -1
  183. data/lib/new_relic/agent/instrumentation/rails_notifications/action_view.rb +0 -1
  184. data/lib/new_relic/agent/instrumentation/rainbows_instrumentation.rb +0 -1
  185. data/lib/new_relic/agent/instrumentation/rake/chain.rb +0 -1
  186. data/lib/new_relic/agent/instrumentation/rake/instrumentation.rb +5 -1
  187. data/lib/new_relic/agent/instrumentation/rake/prepend.rb +0 -1
  188. data/lib/new_relic/agent/instrumentation/rake.rb +0 -1
  189. data/lib/new_relic/agent/instrumentation/redis/chain.rb +0 -1
  190. data/lib/new_relic/agent/instrumentation/redis/instrumentation.rb +0 -1
  191. data/lib/new_relic/agent/instrumentation/redis/prepend.rb +0 -1
  192. data/lib/new_relic/agent/instrumentation/redis.rb +0 -1
  193. data/lib/new_relic/agent/instrumentation/resque/chain.rb +0 -1
  194. data/lib/new_relic/agent/instrumentation/resque/helper.rb +0 -1
  195. data/lib/new_relic/agent/instrumentation/resque/instrumentation.rb +0 -1
  196. data/lib/new_relic/agent/instrumentation/resque/prepend.rb +0 -1
  197. data/lib/new_relic/agent/instrumentation/resque.rb +0 -1
  198. data/lib/new_relic/agent/instrumentation/sequel.rb +0 -1
  199. data/lib/new_relic/agent/instrumentation/sequel_helper.rb +0 -1
  200. data/lib/new_relic/agent/instrumentation/sidekiq.rb +1 -2
  201. data/lib/new_relic/agent/instrumentation/sinatra/chain.rb +0 -1
  202. data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb +0 -1
  203. data/lib/new_relic/agent/instrumentation/sinatra/instrumentation.rb +0 -1
  204. data/lib/new_relic/agent/instrumentation/sinatra/prepend.rb +0 -1
  205. data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb +0 -1
  206. data/lib/new_relic/agent/instrumentation/sinatra.rb +0 -1
  207. data/lib/new_relic/agent/instrumentation/sunspot.rb +0 -1
  208. data/lib/new_relic/agent/instrumentation/thread/chain.rb +0 -1
  209. data/lib/new_relic/agent/instrumentation/thread/instrumentation.rb +0 -1
  210. data/lib/new_relic/agent/instrumentation/thread/prepend.rb +0 -1
  211. data/lib/new_relic/agent/instrumentation/thread.rb +0 -1
  212. data/lib/new_relic/agent/instrumentation/tilt/chain.rb +0 -1
  213. data/lib/new_relic/agent/instrumentation/tilt/instrumentation.rb +0 -1
  214. data/lib/new_relic/agent/instrumentation/tilt/prepend.rb +0 -1
  215. data/lib/new_relic/agent/instrumentation/tilt.rb +0 -1
  216. data/lib/new_relic/agent/instrumentation/typhoeus/chain.rb +0 -1
  217. data/lib/new_relic/agent/instrumentation/typhoeus/instrumentation.rb +3 -4
  218. data/lib/new_relic/agent/instrumentation/typhoeus/prepend.rb +0 -1
  219. data/lib/new_relic/agent/instrumentation/typhoeus.rb +0 -1
  220. data/lib/new_relic/agent/instrumentation.rb +0 -1
  221. data/lib/new_relic/agent/internal_agent_error.rb +0 -1
  222. data/lib/new_relic/agent/javascript_instrumentor.rb +1 -2
  223. data/lib/new_relic/agent/linking_metadata.rb +0 -1
  224. data/lib/new_relic/agent/local_log_decorator.rb +0 -1
  225. data/lib/new_relic/agent/log_event_aggregator.rb +0 -1
  226. data/lib/new_relic/agent/log_once.rb +0 -1
  227. data/lib/new_relic/agent/log_priority.rb +0 -1
  228. data/lib/new_relic/agent/logging.rb +0 -1
  229. data/lib/new_relic/agent/memory_logger.rb +0 -1
  230. data/lib/new_relic/agent/messaging.rb +1 -2
  231. data/lib/new_relic/agent/method_tracer.rb +0 -1
  232. data/lib/new_relic/agent/method_tracer_helpers.rb +1 -2
  233. data/lib/new_relic/agent/monitors/cross_app_monitor.rb +0 -1
  234. data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb +0 -1
  235. data/lib/new_relic/agent/monitors/inbound_request_monitor.rb +0 -1
  236. data/lib/new_relic/agent/monitors/synthetics_monitor.rb +0 -1
  237. data/lib/new_relic/agent/monitors.rb +0 -1
  238. data/lib/new_relic/agent/new_relic_service/encoders.rb +0 -1
  239. data/lib/new_relic/agent/new_relic_service/json_marshaller.rb +0 -1
  240. data/lib/new_relic/agent/new_relic_service/marshaller.rb +0 -1
  241. data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb +0 -1
  242. data/lib/new_relic/agent/new_relic_service.rb +193 -142
  243. data/lib/new_relic/agent/{noticible_error.rb → noticeable_error.rb} +1 -2
  244. data/lib/new_relic/agent/null_logger.rb +0 -1
  245. data/lib/new_relic/agent/obfuscator.rb +1 -2
  246. data/lib/new_relic/agent/parameter_filtering.rb +0 -1
  247. data/lib/new_relic/agent/payload_metric_mapping.rb +0 -1
  248. data/lib/new_relic/agent/pipe_channel_manager.rb +0 -1
  249. data/lib/new_relic/agent/pipe_service.rb +0 -1
  250. data/lib/new_relic/agent/prepend_supportability.rb +0 -1
  251. data/lib/new_relic/agent/priority_sampled_buffer.rb +2 -3
  252. data/lib/new_relic/agent/range_extensions.rb +0 -1
  253. data/lib/new_relic/agent/rules_engine/replacement_rule.rb +0 -1
  254. data/lib/new_relic/agent/rules_engine/segment_terms_rule.rb +0 -1
  255. data/lib/new_relic/agent/rules_engine.rb +0 -1
  256. data/lib/new_relic/agent/sampler.rb +0 -1
  257. data/lib/new_relic/agent/sampler_collection.rb +0 -1
  258. data/lib/new_relic/agent/samplers/cpu_sampler.rb +0 -1
  259. data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +0 -1
  260. data/lib/new_relic/agent/samplers/memory_sampler.rb +5 -6
  261. data/lib/new_relic/agent/samplers/object_sampler.rb +0 -1
  262. data/lib/new_relic/agent/samplers/vm_sampler.rb +2 -1
  263. data/lib/new_relic/agent/span_event_aggregator.rb +0 -1
  264. data/lib/new_relic/agent/span_event_primitive.rb +0 -2
  265. data/lib/new_relic/agent/sql_sampler.rb +0 -1
  266. data/lib/new_relic/agent/stats.rb +12 -3
  267. data/lib/new_relic/agent/stats_engine/gc_profiler.rb +0 -2
  268. data/lib/new_relic/agent/stats_engine/stats_hash.rb +1 -2
  269. data/lib/new_relic/agent/stats_engine.rb +0 -1
  270. data/lib/new_relic/agent/synthetics_event_aggregator.rb +0 -1
  271. data/lib/new_relic/agent/system_info.rb +1 -2
  272. data/lib/new_relic/agent/threading/agent_thread.rb +12 -9
  273. data/lib/new_relic/agent/threading/backtrace_node.rb +0 -1
  274. data/lib/new_relic/agent/threading/backtrace_service.rb +0 -1
  275. data/lib/new_relic/agent/threading/thread_profile.rb +1 -2
  276. data/lib/new_relic/agent/timestamp_sampled_buffer.rb +0 -1
  277. data/lib/new_relic/agent/tracer.rb +7 -6
  278. data/lib/new_relic/agent/transaction/abstract_segment.rb +2 -3
  279. data/lib/new_relic/agent/transaction/datastore_segment.rb +0 -1
  280. data/lib/new_relic/agent/transaction/distributed_tracer.rb +0 -1
  281. data/lib/new_relic/agent/transaction/distributed_tracing.rb +0 -1
  282. data/lib/new_relic/agent/transaction/external_request_segment.rb +1 -2
  283. data/lib/new_relic/agent/transaction/message_broker_segment.rb +0 -1
  284. data/lib/new_relic/agent/transaction/request_attributes.rb +0 -1
  285. data/lib/new_relic/agent/transaction/segment.rb +0 -1
  286. data/lib/new_relic/agent/transaction/slowest_sample_buffer.rb +0 -1
  287. data/lib/new_relic/agent/transaction/synthetics_sample_buffer.rb +0 -1
  288. data/lib/new_relic/agent/transaction/trace.rb +0 -1
  289. data/lib/new_relic/agent/transaction/trace_builder.rb +0 -1
  290. data/lib/new_relic/agent/transaction/trace_context.rb +0 -1
  291. data/lib/new_relic/agent/transaction/trace_node.rb +2 -3
  292. data/lib/new_relic/agent/transaction/tracing.rb +0 -1
  293. data/lib/new_relic/agent/transaction/transaction_sample_buffer.rb +0 -2
  294. data/lib/new_relic/agent/transaction.rb +3 -5
  295. data/lib/new_relic/agent/transaction_error_primitive.rb +0 -1
  296. data/lib/new_relic/agent/transaction_event_aggregator.rb +0 -1
  297. data/lib/new_relic/agent/transaction_event_primitive.rb +0 -1
  298. data/lib/new_relic/agent/transaction_event_recorder.rb +1 -2
  299. data/lib/new_relic/agent/transaction_metrics.rb +1 -2
  300. data/lib/new_relic/agent/transaction_sampler.rb +0 -1
  301. data/lib/new_relic/agent/transaction_time_aggregator.rb +1 -2
  302. data/lib/new_relic/agent/utilization/aws.rb +0 -1
  303. data/lib/new_relic/agent/utilization/azure.rb +1 -2
  304. data/lib/new_relic/agent/utilization/gcp.rb +1 -2
  305. data/lib/new_relic/agent/utilization/pcf.rb +1 -2
  306. data/lib/new_relic/agent/utilization/vendor.rb +1 -2
  307. data/lib/new_relic/agent/utilization_data.rb +0 -1
  308. data/lib/new_relic/agent/vm/jruby_vm.rb +0 -1
  309. data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb +0 -1
  310. data/lib/new_relic/agent/vm/mri_vm.rb +35 -23
  311. data/lib/new_relic/agent/vm/snapshot.rb +1 -2
  312. data/lib/new_relic/agent/vm.rb +0 -1
  313. data/lib/new_relic/agent/worker_loop.rb +0 -1
  314. data/lib/new_relic/agent.rb +13 -16
  315. data/lib/new_relic/cli/command.rb +1 -2
  316. data/lib/new_relic/cli/commands/deployments.rb +72 -21
  317. data/lib/new_relic/cli/commands/install.rb +0 -1
  318. data/lib/new_relic/coerce.rb +0 -1
  319. data/lib/new_relic/collection_helper.rb +1 -2
  320. data/lib/new_relic/constants.rb +0 -1
  321. data/lib/new_relic/control/class_methods.rb +0 -1
  322. data/lib/new_relic/control/frameworks/external.rb +0 -1
  323. data/lib/new_relic/control/frameworks/rails.rb +0 -1
  324. data/lib/new_relic/control/frameworks/rails3.rb +0 -1
  325. data/lib/new_relic/control/frameworks/rails4.rb +0 -1
  326. data/lib/new_relic/control/frameworks/rails_notifications.rb +0 -1
  327. data/lib/new_relic/control/frameworks/ruby.rb +0 -1
  328. data/lib/new_relic/control/frameworks/sinatra.rb +0 -1
  329. data/lib/new_relic/control/frameworks.rb +0 -1
  330. data/lib/new_relic/control/instance_methods.rb +17 -40
  331. data/lib/new_relic/control/instrumentation.rb +0 -1
  332. data/lib/new_relic/control/private_instance_methods.rb +48 -0
  333. data/lib/new_relic/control/server_methods.rb +0 -1
  334. data/lib/new_relic/control.rb +0 -1
  335. data/lib/new_relic/delayed_job_injection.rb +0 -1
  336. data/lib/new_relic/dependency_detection.rb +3 -4
  337. data/lib/new_relic/environment_report.rb +23 -14
  338. data/lib/new_relic/helper.rb +1 -2
  339. data/lib/new_relic/language_support.rb +7 -3
  340. data/lib/new_relic/latest_changes.rb +3 -4
  341. data/lib/new_relic/local_environment.rb +3 -4
  342. data/lib/new_relic/metric_data.rb +27 -22
  343. data/lib/new_relic/metric_spec.rb +0 -1
  344. data/lib/new_relic/noticed_error.rb +3 -6
  345. data/lib/new_relic/rack/agent_hooks.rb +0 -1
  346. data/lib/new_relic/rack/agent_middleware.rb +0 -1
  347. data/lib/new_relic/rack/browser_monitoring.rb +131 -123
  348. data/lib/new_relic/rack.rb +0 -1
  349. data/lib/new_relic/recipes/capistrano3.rb +2 -59
  350. data/lib/new_relic/recipes/capistrano_legacy.rb +1 -2
  351. data/lib/new_relic/recipes/helpers/send_deployment.rb +69 -0
  352. data/lib/new_relic/recipes.rb +0 -1
  353. data/lib/new_relic/supportability_helper.rb +1 -2
  354. data/lib/new_relic/traced_thread.rb +0 -1
  355. data/lib/new_relic/version.rb +1 -2
  356. data/lib/newrelic_rpm.rb +0 -1
  357. data/lib/sequel/extensions/newrelic_instrumentation.rb +2 -3
  358. data/lib/sequel/plugins/newrelic_instrumentation.rb +0 -1
  359. data/lib/tasks/all.rb +0 -1
  360. data/lib/tasks/config.rake +4 -113
  361. data/lib/tasks/coverage_report.rake +20 -15
  362. data/lib/tasks/{config.html.erb → helpers/config.html.erb} +0 -0
  363. data/lib/tasks/{config.text.erb → helpers/config.text.erb} +0 -0
  364. data/lib/tasks/helpers/format.rb +120 -0
  365. data/lib/tasks/helpers/matches.rb +12 -0
  366. data/lib/tasks/helpers/prompt.rb +24 -0
  367. data/lib/tasks/helpers/removers.rb +33 -0
  368. data/lib/tasks/install.rake +0 -1
  369. data/lib/tasks/instrumentation_generator/README.md +63 -0
  370. data/lib/tasks/instrumentation_generator/TODO.md +33 -0
  371. data/lib/tasks/instrumentation_generator/instrumentation.thor +102 -0
  372. data/lib/tasks/instrumentation_generator/templates/Envfile.tt +9 -0
  373. data/lib/tasks/instrumentation_generator/templates/chain.tt +21 -0
  374. data/lib/tasks/instrumentation_generator/templates/chain_method.tt +7 -0
  375. data/lib/tasks/instrumentation_generator/templates/dependency_detection.tt +29 -0
  376. data/lib/tasks/instrumentation_generator/templates/instrumentation.tt +12 -0
  377. data/lib/tasks/instrumentation_generator/templates/instrumentation_method.tt +3 -0
  378. data/lib/tasks/instrumentation_generator/templates/newrelic.yml.tt +19 -0
  379. data/lib/tasks/instrumentation_generator/templates/prepend.tt +13 -0
  380. data/lib/tasks/instrumentation_generator/templates/prepend_method.tt +3 -0
  381. data/lib/tasks/instrumentation_generator/templates/test.tt +15 -0
  382. data/lib/tasks/multiverse.rake +0 -1
  383. data/lib/tasks/multiverse.rb +3 -29
  384. data/lib/tasks/newrelic.rb +0 -1
  385. data/lib/tasks/tests.rake +3 -8
  386. data/newrelic.yml +10 -1
  387. data/newrelic_rpm.gemspec +14 -19
  388. data/recipes/newrelic.rb +0 -1
  389. data/test/agent_helper.rb +22 -54
  390. metadata +50 -101
  391. data/bin/mongrel_rpm +0 -33
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -72,7 +71,7 @@ module NewRelic
72
71
  def valid_api_argument_class?(arg, name, klass)
73
72
  return true if arg.is_a?(klass)
74
73
 
75
- caller_location = caller_locations.first.label
74
+ caller_location = caller_locations(1..1).first.label
76
75
 
77
76
  message = "Bad argument passed to ##{caller_location}. " \
78
77
  "Expected #{klass} for `#{name}` but got #{arg.class}"
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -1,5 +1,4 @@
1
1
  #!/usr/bin/ruby
2
- # encoding: utf-8
3
2
  # This file is distributed under New Relic's license terms.
4
3
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
5
4
  # frozen_string_literal: true
@@ -7,7 +6,7 @@
7
6
  module NewRelic
8
7
  module VERSION # :nodoc:
9
8
  MAJOR = 8
10
- MINOR = 10
9
+ MINOR = 11
11
10
  TINY = 0
12
11
 
13
12
  STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
data/lib/newrelic_rpm.rb CHANGED
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -1,5 +1,4 @@
1
1
  # -*- ruby -*-
2
- # encoding: utf-8
3
2
  # This file is distributed under New Relic's license terms.
4
3
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
5
4
  # frozen_string_literal: true
@@ -63,7 +62,7 @@ module Sequel
63
62
  # block in the sequel Plugin instrumentation. A simple ORM operation from the Plugin
64
63
  # instrumentation may trigger a number of calls to this method. We want to append
65
64
  # the statements that come from the disable_all_tracing block into this node's
66
- # statement, otherwise we would end up ovewriting the sql statement with the
65
+ # statement, otherwise we would end up overwriting the sql statement with the
67
66
  # last one executed.
68
67
  def notice_sql(sql)
69
68
  return unless txn = NewRelic::Agent::Tracer.current_transaction
@@ -83,7 +82,7 @@ module Sequel
83
82
  ].freeze
84
83
 
85
84
  def explainer_for(sql)
86
- Proc.new do |*|
85
+ proc do |*|
87
86
  if THREAD_SAFE_CONNECTION_POOL_CLASSES.include?(self.pool.class)
88
87
  self[sql].explain
89
88
  else
@@ -1,5 +1,4 @@
1
1
  # -*- ruby -*-
2
- # encoding: utf-8
3
2
  # This file is distributed under New Relic's license terms.
4
3
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
5
4
  # frozen_string_literal: true
data/lib/tasks/all.rb CHANGED
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -1,12 +1,12 @@
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.
4
3
  # frozen_string_literal: true
5
4
 
5
+ require_relative 'helpers/format'
6
+ include Format
7
+
6
8
  namespace :newrelic do
7
9
  namespace :config do
8
- desc "Describe available New Relic configuration settings."
9
-
10
10
  GENERAL = "general"
11
11
  DISABLING = "disabling"
12
12
  ATTRIBUTES = "attributes"
@@ -29,116 +29,7 @@ namespace :newrelic do
29
29
  "custom_insights_events" => "Custom Events"
30
30
  }
31
31
 
32
- def output(format)
33
- config_hash = build_config_hash
34
- sections = flatten_config_hash(config_hash)
35
-
36
- puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('. ', '. ')
37
- sections # silences unused warning to return this
38
- end
39
-
40
- def build_config_hash
41
- sections = Hash.new { |hash, key| hash[key] = [] }
42
- NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
43
- next unless value[:public]
44
-
45
- section_key = GENERAL
46
- key = key.to_s
47
- components = key.split(".")
48
-
49
- if key.match(/^disable_/) # "disable_httpclient"
50
- section_key = DISABLING
51
- elsif components.length >= 2 && !(components[1] == "attributes") # "analytics_events.enabled"
52
- section_key = components.first
53
- elsif components[1] == "attributes" # "transaction_tracer.attributes.enabled"
54
- section_key = ATTRIBUTES
55
- end
56
-
57
- sections[section_key] << {
58
- :key => key,
59
- :type => format_type(value[:type]),
60
- :description => format_description(value),
61
- :default => format_default_value(value),
62
- :env_var => format_env_var(key)
63
- }
64
- end
65
- sections
66
- end
67
-
68
- def flatten_config_hash(config_hash)
69
- sections = []
70
- sections << pluck(GENERAL, config_hash)
71
- sections << pluck("transaction_tracer", config_hash)
72
- sections << pluck("error_collector", config_hash)
73
- sections << pluck("browser_monitoring", config_hash)
74
- sections << pluck("analytics_events", config_hash)
75
- sections << pluck("transaction_events", config_hash)
76
- sections << pluck("application_logging", config_hash)
77
- sections.concat(config_hash.to_a.sort_by { |a| a.first })
78
-
79
- add_data_to_sections(sections)
80
-
81
- sections
82
- end
83
-
84
- def add_data_to_sections(sections)
85
- sections.each do |section|
86
- section_key = section[0]
87
- section.insert(1, format_name(section_key))
88
- section.insert(2, SECTION_DESCRIPTIONS[section_key])
89
- end
90
- end
91
-
92
- def format_name(key)
93
- name = NAME_OVERRIDES[key]
94
- return name if name
95
-
96
- key.split("_")
97
- .each { |fragment| fragment[0] = fragment[0].upcase }
98
- .join(" ")
99
- end
100
-
101
- def format_type(type)
102
- if type == NewRelic::Agent::Configuration::Boolean
103
- "Boolean"
104
- else
105
- type
106
- end
107
- end
108
-
109
- def format_description(value)
110
- description = ''
111
- description += "<b>DEPRECATED</b> " if value[:deprecated]
112
- description += value[:description]
113
- description
114
- end
115
-
116
- def format_default_value(spec)
117
- return spec[:documentation_default] if !spec[:documentation_default].nil?
118
- if spec[:default].is_a?(Proc)
119
- '(Dynamic)'
120
- else
121
- "#{spec[:default].inspect}"
122
- end
123
- end
124
-
125
- def format_env_var(key)
126
- return "None" if NON_ENV_CONFIGS.include?(key)
127
- "NEW_RELIC_#{key.gsub(".", "_").upcase}"
128
- end
129
-
130
- def pluck(key, config_hash)
131
- value = config_hash.delete(key)
132
- [key, value]
133
- end
134
-
135
- def build_erb(format)
136
- require 'erb'
137
- path = File.join(File.dirname(__FILE__), "config.#{format}.erb")
138
- template = File.read(File.expand_path(path))
139
- ERB.new(template)
140
- end
141
-
32
+ desc "Describe available New Relic configuration settings"
142
33
  task :docs, [:format] => [] do |t, args|
143
34
  require File.expand_path(File.join(File.dirname(__FILE__), "..", "new_relic", "agent", "configuration", "default_source.rb"))
144
35
  format = args[:format] || "text"
@@ -1,23 +1,28 @@
1
- # encoding: utf-8
2
1
  # frozen_string_literal: true
3
2
  # This file is distributed under New Relic's license terms.
4
3
  # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
5
4
 
6
- namespace :coverage do
7
- desc "Collates all result sets generated by the different test runners"
8
- task :report do
9
- require 'simplecov'
10
- require 'simplecov_json_formatter'
11
- unless ENV['CI']
12
- puts 'This task is intended to be run only on the CI.'
13
- return
5
+ if ENV['CI']
6
+ namespace :coverage do
7
+ desc "Collates all result sets generated by the different test runners"
8
+ task :report do
9
+ require 'simplecov'
10
+ require 'fileutils'
11
+
12
+ SimpleCov.coverage_dir('coverage_results')
13
+
14
+ SimpleCov.collate(Dir['*/coverage_*/.resultset.json']) do
15
+ formatter SimpleCov::Formatter::HTMLFormatter
16
+ refuse_coverage_drop
17
+ end
18
+
19
+ Dir['lib/coverage_{[!r][!e][!s][!u][!l][!t][!s]}*'].each { |dir| FileUtils.rm_rf(dir) }
14
20
  end
15
- SimpleCov.collate(Dir["coverage*/.resultset.json"]) do
16
- formatter SimpleCov::Formatter::MultiFormatter.new([
17
- SimpleCov::Formatter::JSONFormatter,
18
- SimpleCov::Formatter::HTMLFormatter
19
- ])
20
- refuse_coverage_drop
21
+
22
+ desc "Removes all coverage_* directories"
23
+ task :clear do
24
+ require 'fileutils'
25
+ Dir["lib/coverage_*"].each { |dir| FileUtils.rm_rf(dir) }
21
26
  end
22
27
  end
23
28
  end
@@ -0,0 +1,120 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ module Format
6
+ def output(format)
7
+ config_hash = build_config_hash
8
+ sections = flatten_config_hash(config_hash)
9
+
10
+ puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('. ', '. ')
11
+ sections # silences unused warning to return this
12
+ end
13
+
14
+ private
15
+
16
+ def add_data_to_sections(sections)
17
+ sections.each do |section|
18
+ section_key = section[0]
19
+ section.insert(1, format_name(section_key))
20
+ section.insert(2, SECTION_DESCRIPTIONS[section_key])
21
+ end
22
+ end
23
+
24
+ def build_config_hash
25
+ sections = Hash.new { |hash, key| hash[key] = [] }
26
+ NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
27
+ next unless value[:public]
28
+ key = key.to_s
29
+ section_key = section_key(key, key.split('.'))
30
+ sections[section_key] << format_sections(key, value)
31
+ end
32
+ sections
33
+ end
34
+
35
+ def build_erb(format)
36
+ require 'erb'
37
+ path = File.join(File.dirname(__FILE__), "config.#{format}.erb")
38
+ template = File.read(File.expand_path(path))
39
+ ERB.new(template)
40
+ end
41
+
42
+ def flatten_config_hash(config_hash)
43
+ sections = []
44
+ config = [GENERAL, 'transaction_tracer', 'error_collector',
45
+ 'browser_monitoring', 'analytics_events', 'transaction_events',
46
+ 'application_logging']
47
+
48
+ config.each { |config| sections << pluck(config, config_hash) }
49
+
50
+ sections.concat(config_hash.to_a.sort_by { |a| a.first })
51
+ add_data_to_sections(sections)
52
+
53
+ sections
54
+ end
55
+
56
+ def format_default_value(spec)
57
+ return spec[:documentation_default] if !spec[:documentation_default].nil?
58
+ if spec[:default].is_a?(Proc)
59
+ '(Dynamic)'
60
+ else
61
+ "#{spec[:default].inspect}"
62
+ end
63
+ end
64
+
65
+ def format_description(value)
66
+ description = ''
67
+ description += "<b>DEPRECATED</b> " if value[:deprecated]
68
+ description += value[:description]
69
+ description
70
+ end
71
+
72
+ def format_env_var(key)
73
+ return "None" if NON_ENV_CONFIGS.include?(key)
74
+ "NEW_RELIC_#{key.tr(".", "_").upcase}"
75
+ end
76
+
77
+ def format_name(key)
78
+ name = NAME_OVERRIDES[key]
79
+ return name if name
80
+
81
+ key.split("_")
82
+ .each { |fragment| fragment[0] = fragment[0].upcase }
83
+ .join(" ")
84
+ end
85
+
86
+ def format_sections(key, value)
87
+ {
88
+ :key => key,
89
+ :type => format_type(value[:type]),
90
+ :description => format_description(value),
91
+ :default => format_default_value(value),
92
+ :env_var => format_env_var(key)
93
+ }
94
+ end
95
+
96
+ def format_type(type)
97
+ if type == NewRelic::Agent::Configuration::Boolean
98
+ "Boolean"
99
+ else
100
+ type
101
+ end
102
+ end
103
+
104
+ def pluck(key, config_hash)
105
+ value = config_hash.delete(key)
106
+ [key, value]
107
+ end
108
+
109
+ def section_key(key, components)
110
+ if key =~ /^disable_/ # "disable_httpclient"
111
+ DISABLING
112
+ elsif components.length >= 2 && !(components[1] == "attributes") # "analytics_events.enabled"
113
+ components.first
114
+ elsif components[1] == "attributes" # "transaction_tracer.attributes.enabled"
115
+ ATTRIBUTES
116
+ else
117
+ GENERAL
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,12 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ module Matches
6
+ def look_for_seed(tasks)
7
+ matches = tasks.map { |t| /(seed=.*?)[,\]]/.match(t) }.compact
8
+ if matches.any?
9
+ matches.first[1]
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,24 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ module Prompt
6
+ def prompt_to_continue(command, destination = 'local')
7
+ puts "The following rsync command will be executed to update the #{destination} copy of the specs:"
8
+ puts
9
+ puts command
10
+ puts
11
+ puts "CAUTION: Any unsaved changes that exist within the #{destination} content will be OVERWRITTEN!"
12
+ if destination.eql?('local')
13
+ puts 'CAUTION 2: Before continuing, make sure your local repo is on the correct, synced branch!'
14
+ end
15
+ puts
16
+ print "Do you wish to continue? ('y' to continue, return to cancel) [n] "
17
+ continue = STDIN.gets.chomp
18
+ if continue.casecmp('y').zero?
19
+ system(command)
20
+ else
21
+ puts 'Cancelled'
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,33 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ module Removers
6
+ def remove_local_multiverse_databases
7
+ list_databases_command = %(echo "show databases" | mysql -u root)
8
+ databases = `#{list_databases_command}`.chomp!.split("\n").select { |s| s.include?('multiverse') }
9
+ databases.each do |database|
10
+ puts "Dropping #{database}"
11
+ `echo "drop database #{database}" | mysql -u root`
12
+ end
13
+ rescue => error
14
+ puts "ERROR: Cannot get MySQL databases..."
15
+ puts error.message
16
+ end
17
+
18
+ def remove_generated_gemfiles
19
+ file_path = File.expand_path("test/multiverse/suites")
20
+ Dir.glob(File.join(file_path, "**", "Gemfile*")).each do |fn|
21
+ puts "Removing #{fn.gsub(file_path, '.../suites')}"
22
+ FileUtils.rm(fn)
23
+ end
24
+ end
25
+
26
+ def remove_generated_gemfile_lockfiles
27
+ file_path = File.expand_path("test/environments")
28
+ Dir.glob(File.join(file_path, "**", "Gemfile.lock")).each do |fn|
29
+ puts "Removing #{fn.gsub(file_path, '.../environments')}"
30
+ FileUtils.rm(fn)
31
+ end
32
+ end
33
+ end
@@ -1,4 +1,3 @@
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.
4
3
  # frozen_string_literal: true
@@ -0,0 +1,63 @@
1
+ # Instrumentation Generator
2
+
3
+ ## Usage
4
+
5
+ `thor list` can be passed to get a list of all available thor commands
6
+
7
+ ### instrumentation:scaffold
8
+
9
+ This task requires one parameter by default: the name of the library or class you are instrumenting. This task generates the basic file structure needed to add new instrumentation to the Ruby agent.
10
+
11
+ Run it using:
12
+
13
+ `thor instrumentation:scaffold gem_name`
14
+
15
+ It accepts two optional parameters:
16
+
17
+ - `--method`: the name of a method to instrument. Only one method can be accepted at this time. Defaults to `method_to_instrument`
18
+ - `--args`: the arguments for the instrumented method. A comma-separated list can be given if there are multiple arguments. Defaults to `*args`.
19
+
20
+ With the optional parameters, the task can be run like so:
21
+
22
+ `thor instrumentation:scaffold gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
23
+
24
+ ### WIP: instrumentation:add_new_method
25
+
26
+ Are you trying add instrumentation for a method within library we already instrument? This task is for you! Instead of building the entire scaffold, this task inserts only the changes needed within the `instrumentation.rb` and test files to instrument the new method. It requires one argument, the name of the existing instrumentation to add the method to. If the instrumented library does not already exist, it will create a new scaffold for that library.
27
+
28
+ Run it using:
29
+
30
+ `thor instrumentation:scaffold gem_name`
31
+
32
+ It accepts two optional parameters:
33
+
34
+ - `--method`: the name of a method to instrument. Only one method can be accepted at this time. Defaults to `method_to_instrument`
35
+ - `--args`: the arguments for the instrumented method. A comma-separated list can be given if there are multiple arguments. Defaults to `*args`.
36
+
37
+ With the optional parameters, the task can be run like so:
38
+
39
+ `thor instrumentation:add_new_method gem_name --method=method_to_instrument --args=arg1,arg2,arg3`
40
+
41
+ ## Idea
42
+
43
+ Create a CLI, similar to Rails’ generators and scaffold scripts, to create the required files and basic classes for instrumenting new libraries. The hope is that the parts of adding new instrumentation that is repetitive can be eliminated and/or reduced so that it takes less time to add new instrumentation and we can spend development time considering the best attributes to collect and interactions to measure. I also hope this project will reduce the overall toil related to adding new instrumentation.
44
+
45
+ The files we create with little variation besides library and method names are:
46
+
47
+ - Lib
48
+ - Dependency detection
49
+ - Chain
50
+ - Prepend
51
+ - Instrumentation
52
+ - Tests
53
+ - configuration/newrelic.yml
54
+ - Envfile
55
+ - Test file
56
+
57
+ Furthermore, we also create very similar snippets inside the default source configuration file that could be generated by this project as well.
58
+
59
+ ## Outcome
60
+
61
+ A prototype outside the agent has been created that generates the required files to create new instrumentation. This prototype accepts three arguments: name (name of the library), method (method to instrument), args (arguments for the method).
62
+
63
+ The Ruby gem Thor, a toolkit for building powerful command-line interfaces used in Bundler, Vagrant, Rails and others powers this CLI.
@@ -0,0 +1,33 @@
1
+ # TODO
2
+
3
+ # - [X] Create instrumentation file
4
+
5
+ # - [X] Create chain file
6
+
7
+ # - [X] Create prepend file
8
+
9
+ # - [X] Create dependency detection file
10
+
11
+ # - [X] Add config to default source
12
+
13
+ # - [X] Create multiverse suite
14
+
15
+ # - [X] Create Envfile
16
+
17
+ # - [X] Create test file with examples
18
+
19
+ # - [X] Create option for method names to instrument
20
+
21
+ # - [X] Add entry to newrelic.yml
22
+
23
+ # - [ ] Append a new method to instrument to an existing instrumentation class (with tests?)
24
+
25
+ # - [ ] Documentation: examples of what to add in each gap
26
+
27
+ # - [ ] Good examples of tests, instrumentation, etc. as comments
28
+
29
+ # - [ ] Handle multi-word gem names (camel case for classes, handle hyphens, concurrent-ruby as example)
30
+
31
+ # - [ ] Make sure multiple arguments can be passed to the command line
32
+
33
+ # - [ ] Add tests
@@ -0,0 +1,102 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ require_relative '../../new_relic/language_support'
6
+ require 'thor'
7
+
8
+ class Instrumentation < Thor
9
+ include Thor::Actions
10
+
11
+ INSTRUMENTATION_ROOT = 'lib/new_relic/agent/instrumentation/'
12
+ MULTIVERSE_SUITE_ROOT = 'test/multiverse/suites/'
13
+ DEFAULT_SOURCE_LOCATION = 'lib/new_relic/agent/configuration/default_source.rb'
14
+
15
+ desc('scaffold NAME', 'Scaffold the required files for adding new instrumentation')
16
+ long_desc <<-LONGDESC
17
+ `instrumentation scaffold` requires one parameter by default: the name of the
18
+ library or class you are instrumenting. This task generates the basic
19
+ file structure needed to add new instrumentation to the Ruby agent.
20
+ LONGDESC
21
+
22
+ source_root(File.dirname(__FILE__))
23
+
24
+ option :method,
25
+ default: 'method_to_instrument',
26
+ desc: 'The method you would like to prepend or chain instrumentation onto'
27
+ option :args,
28
+ default: '*args',
29
+ desc: 'The arguments associated with the original method'
30
+
31
+ def scaffold(name)
32
+ @name = name
33
+ @method = options[:method] if options[:method]
34
+ @args = options[:args] if options[:args]
35
+ @class_name = ::NewRelic::LanguageSupport.camelize(name)
36
+ base_path = "#{INSTRUMENTATION_ROOT}#{name.downcase}"
37
+
38
+ empty_directory(base_path)
39
+ create_instrumentation_files(base_path)
40
+ create_configuration(name)
41
+ create_tests(name)
42
+ end
43
+
44
+ desc 'add_new_method NAME', 'Inserts a new method into an existing piece of instrumentation'
45
+
46
+ option :method, required: true, desc: 'The name of the method to instrument'
47
+ option :args, default: '*args', desc: 'The arguments associated with the instrumented method'
48
+
49
+ def add_new_method(name, method_name)
50
+ # Verify that existing instrumentation exists
51
+ # if it doesn't, should we just call the #scaffold method instead since we have all the stuff
52
+ # otherwise, inject the new method into the instrumentation matching the first arg
53
+ # add to only chain, instrumentation, prepend
54
+ # move the method content to a partial
55
+ end
56
+
57
+ private
58
+
59
+ def create_instrumentation_files(base_path)
60
+ %w[chain instrumentation prepend].each do |file|
61
+ template("templates/#{file}.tt", "#{base_path}/#{file}.rb")
62
+ end
63
+
64
+ template('templates/dependency_detection.tt', "#{base_path}.rb")
65
+ end
66
+
67
+ def create_tests(name)
68
+ @name = name
69
+ @instrumentation_method_global_erb_snippet = '<%= $instrumentation_method %>'
70
+ base_path = "#{MULTIVERSE_SUITE_ROOT}#{@name.downcase}"
71
+ empty_directory(base_path)
72
+ template('templates/Envfile.tt', "#{base_path}/Envfile")
73
+ template('templates/test.tt', "#{base_path}/#{@name.downcase}_instrumentation_test.rb")
74
+
75
+ empty_directory("#{base_path}/config")
76
+ template('templates/newrelic.yml.tt', "#{base_path}/config/newrelic.yml")
77
+ end
78
+
79
+ def create_configuration(name)
80
+ insert_into_file(
81
+ DEFAULT_SOURCE_LOCATION,
82
+ config_block(name.downcase),
83
+ after: ":description => 'Controls auto-instrumentation of bunny at start up. May be one of [auto|prepend|chain|disabled].'
84
+ },\n"
85
+ )
86
+ end
87
+
88
+ def config_block(library)
89
+ <<-CONFIG
90
+ :'instrumentation.#{library}' => {
91
+ :default => 'auto',
92
+ :public => true,
93
+ :type => String,
94
+ :dynamic_name => true,
95
+ :allowed_from_server => false,
96
+ :description => 'Controls auto-instrumentation of the #{library} library at start up. May be one of [auto|prepend|chain|disabled].'
97
+ },
98
+ CONFIG
99
+ end
100
+ end
101
+
102
+ Instrumentation.start(ARGV)
@@ -0,0 +1,9 @@
1
+ # This file is distributed under New Relic's license terms.
2
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
3
+ # frozen_string_literal: true
4
+
5
+ instrumentation_methods :chain, :prepend
6
+
7
+ gemfile <<-RB
8
+ gem '<%= @name.downcase %>'
9
+ RB