newrelic_rpm 6.7.0.359 → 6.12.0.367

Sign up to get free protection for your applications and to get access to all the features.
Files changed (297) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +4 -0
  3. data/.travis.yml +72 -7
  4. data/CHANGELOG.md +306 -4
  5. data/CODE_OF_CONDUCT.md +46 -0
  6. data/CONTRIBUTING.md +56 -12
  7. data/Gemfile +6 -2
  8. data/Guardfile +18 -1
  9. data/LICENSE +208 -38
  10. data/README.md +61 -89
  11. data/Rakefile +2 -0
  12. data/THIRD_PARTY_NOTICES.md +213 -0
  13. data/bin/nrdebug +1 -1
  14. data/init.rb +1 -1
  15. data/install.rb +1 -1
  16. data/lib/new_relic/agent.rb +49 -7
  17. data/lib/new_relic/agent/adaptive_sampler.rb +1 -1
  18. data/lib/new_relic/agent/agent.rb +57 -40
  19. data/lib/new_relic/agent/agent_logger.rb +5 -1
  20. data/lib/new_relic/agent/attribute_filter.rb +8 -8
  21. data/lib/new_relic/agent/attribute_processing.rb +1 -1
  22. data/lib/new_relic/agent/attributes.rb +152 -0
  23. data/lib/new_relic/agent/audit_logger.rb +1 -1
  24. data/lib/new_relic/agent/autostart.rb +20 -15
  25. data/lib/new_relic/agent/chained_call.rb +1 -1
  26. data/lib/new_relic/agent/commands/agent_command.rb +1 -1
  27. data/lib/new_relic/agent/commands/agent_command_router.rb +1 -1
  28. data/lib/new_relic/agent/commands/thread_profiler_session.rb +1 -1
  29. data/lib/new_relic/agent/configuration.rb +1 -1
  30. data/lib/new_relic/agent/configuration/default_source.rb +111 -16
  31. data/lib/new_relic/agent/configuration/dotted_hash.rb +1 -1
  32. data/lib/new_relic/agent/configuration/environment_source.rb +1 -1
  33. data/lib/new_relic/agent/configuration/event_harvest_config.rb +1 -1
  34. data/lib/new_relic/agent/configuration/high_security_source.rb +1 -1
  35. data/lib/new_relic/agent/configuration/manager.rb +1 -1
  36. data/lib/new_relic/agent/configuration/manual_source.rb +1 -1
  37. data/lib/new_relic/agent/configuration/mask_defaults.rb +1 -1
  38. data/lib/new_relic/agent/configuration/security_policy_source.rb +1 -1
  39. data/lib/new_relic/agent/configuration/server_source.rb +2 -2
  40. data/lib/new_relic/agent/configuration/yaml_source.rb +12 -7
  41. data/lib/new_relic/agent/connect/request_builder.rb +4 -12
  42. data/lib/new_relic/agent/connect/response_handler.rb +1 -1
  43. data/lib/new_relic/agent/custom_event_aggregator.rb +1 -1
  44. data/lib/new_relic/agent/database.rb +2 -3
  45. data/lib/new_relic/agent/database/explain_plan_helpers.rb +1 -1
  46. data/lib/new_relic/agent/database/obfuscation_helpers.rb +2 -2
  47. data/lib/new_relic/agent/database/obfuscator.rb +1 -1
  48. data/lib/new_relic/agent/database/postgres_explain_obfuscator.rb +1 -1
  49. data/lib/new_relic/agent/datastores.rb +1 -1
  50. data/lib/new_relic/agent/datastores/metric_helper.rb +1 -1
  51. data/lib/new_relic/agent/datastores/mongo.rb +2 -2
  52. data/lib/new_relic/agent/datastores/mongo/event_formatter.rb +3 -3
  53. data/lib/new_relic/agent/datastores/mongo/metric_translator.rb +1 -1
  54. data/lib/new_relic/agent/datastores/mongo/obfuscator.rb +9 -9
  55. data/lib/new_relic/agent/datastores/mongo/statement_formatter.rb +1 -1
  56. data/lib/new_relic/agent/datastores/redis.rb +1 -1
  57. data/lib/new_relic/agent/deprecator.rb +1 -1
  58. data/lib/new_relic/agent/distributed_tracing.rb +156 -7
  59. data/lib/new_relic/agent/{cross_app_payload.rb → distributed_tracing/cross_app_payload.rb} +3 -2
  60. data/lib/new_relic/agent/{cross_app_tracing.rb → distributed_tracing/cross_app_tracing.rb} +61 -46
  61. data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb +84 -0
  62. data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb +75 -0
  63. data/lib/new_relic/agent/{distributed_trace_payload.rb → distributed_tracing/distributed_trace_payload.rb} +25 -102
  64. data/lib/new_relic/agent/distributed_tracing/distributed_trace_transport_type.rb +39 -0
  65. data/lib/new_relic/agent/distributed_tracing/trace_context.rb +246 -0
  66. data/lib/new_relic/agent/distributed_tracing/trace_context_payload.rb +126 -0
  67. data/lib/new_relic/agent/encoding_normalizer.rb +1 -1
  68. data/lib/new_relic/agent/error_collector.rb +34 -17
  69. data/lib/new_relic/agent/error_event_aggregator.rb +8 -6
  70. data/lib/new_relic/agent/error_trace_aggregator.rb +1 -1
  71. data/lib/new_relic/agent/event_aggregator.rb +1 -1
  72. data/lib/new_relic/agent/event_buffer.rb +1 -1
  73. data/lib/new_relic/agent/event_listener.rb +1 -1
  74. data/lib/new_relic/agent/event_loop.rb +1 -1
  75. data/lib/new_relic/agent/external.rb +8 -8
  76. data/lib/new_relic/agent/guid_generator.rb +28 -0
  77. data/lib/new_relic/agent/harvester.rb +1 -1
  78. data/lib/new_relic/agent/heap.rb +1 -1
  79. data/lib/new_relic/agent/hostname.rb +8 -2
  80. data/lib/new_relic/agent/http_clients/abstract.rb +82 -0
  81. data/lib/new_relic/agent/http_clients/curb_wrappers.rb +25 -20
  82. data/lib/new_relic/agent/http_clients/excon_wrappers.rb +29 -14
  83. data/lib/new_relic/agent/http_clients/http_rb_wrappers.rb +18 -22
  84. data/lib/new_relic/agent/http_clients/httpclient_wrappers.rb +11 -12
  85. data/lib/new_relic/agent/http_clients/net_http_wrappers.rb +17 -5
  86. data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb +5 -7
  87. data/lib/new_relic/agent/http_clients/uri_util.rb +4 -3
  88. data/lib/new_relic/agent/instrumentation.rb +1 -1
  89. data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb +6 -8
  90. data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb +5 -1
  91. data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb +12 -3
  92. data/lib/new_relic/agent/instrumentation/active_job.rb +1 -1
  93. data/lib/new_relic/agent/instrumentation/active_merchant.rb +1 -1
  94. data/lib/new_relic/agent/instrumentation/active_record.rb +85 -38
  95. data/lib/new_relic/agent/instrumentation/active_record_helper.rb +82 -24
  96. data/lib/new_relic/agent/instrumentation/active_record_notifications.rb +1 -1
  97. data/lib/new_relic/agent/instrumentation/active_record_prepend.rb +92 -34
  98. data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb +8 -3
  99. data/lib/new_relic/agent/instrumentation/active_storage.rb +1 -1
  100. data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb +9 -5
  101. data/lib/new_relic/agent/instrumentation/acts_as_solr.rb +24 -8
  102. data/lib/new_relic/agent/instrumentation/authlogic.rb +1 -1
  103. data/lib/new_relic/agent/instrumentation/bunny.rb +115 -52
  104. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +1 -1
  105. data/lib/new_relic/agent/instrumentation/curb.rb +93 -28
  106. data/lib/new_relic/agent/instrumentation/data_mapper.rb +4 -2
  107. data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb +61 -25
  108. data/lib/new_relic/agent/instrumentation/excon.rb +2 -2
  109. data/lib/new_relic/agent/instrumentation/excon/connection.rb +7 -4
  110. data/lib/new_relic/agent/instrumentation/excon/middleware.rb +3 -2
  111. data/lib/new_relic/agent/instrumentation/grape.rb +6 -11
  112. data/lib/new_relic/agent/instrumentation/http.rb +7 -4
  113. data/lib/new_relic/agent/instrumentation/httpclient.rb +6 -4
  114. data/lib/new_relic/agent/instrumentation/ignore_actions.rb +1 -1
  115. data/lib/new_relic/agent/instrumentation/memcache.rb +4 -2
  116. data/lib/new_relic/agent/instrumentation/memcache/dalli.rb +7 -3
  117. data/lib/new_relic/agent/instrumentation/merb/controller.rb +1 -1
  118. data/lib/new_relic/agent/instrumentation/merb/errors.rb +1 -1
  119. data/lib/new_relic/agent/instrumentation/middleware_proxy.rb +12 -4
  120. data/lib/new_relic/agent/instrumentation/middleware_tracing.rb +9 -7
  121. data/lib/new_relic/agent/instrumentation/mongo.rb +10 -4
  122. data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb +36 -3
  123. data/lib/new_relic/agent/instrumentation/net.rb +60 -23
  124. data/lib/new_relic/agent/instrumentation/notifications_subscriber.rb +26 -2
  125. data/lib/new_relic/agent/instrumentation/padrino.rb +40 -16
  126. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +1 -1
  127. data/lib/new_relic/agent/instrumentation/queue_time.rb +1 -1
  128. data/lib/new_relic/agent/instrumentation/rack.rb +36 -13
  129. data/lib/new_relic/agent/instrumentation/rails/action_controller.rb +1 -1
  130. data/lib/new_relic/agent/instrumentation/rails/action_web_service.rb +1 -1
  131. data/lib/new_relic/agent/instrumentation/rails3/action_controller.rb +1 -1
  132. data/lib/new_relic/agent/instrumentation/rails_middleware.rb +1 -1
  133. data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb +1 -1
  134. data/lib/new_relic/agent/instrumentation/rails_notifications/action_controller.rb +1 -1
  135. data/lib/new_relic/agent/instrumentation/rails_notifications/action_view.rb +1 -1
  136. data/lib/new_relic/agent/instrumentation/rainbows_instrumentation.rb +1 -1
  137. data/lib/new_relic/agent/instrumentation/rake.rb +54 -20
  138. data/lib/new_relic/agent/instrumentation/redis.rb +141 -56
  139. data/lib/new_relic/agent/instrumentation/resque.rb +4 -1
  140. data/lib/new_relic/agent/instrumentation/sequel.rb +1 -1
  141. data/lib/new_relic/agent/instrumentation/sequel_helper.rb +1 -1
  142. data/lib/new_relic/agent/instrumentation/sidekiq.rb +48 -24
  143. data/lib/new_relic/agent/instrumentation/sinatra.rb +62 -23
  144. data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb +1 -1
  145. data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb +1 -1
  146. data/lib/new_relic/agent/instrumentation/sunspot.rb +1 -1
  147. data/lib/new_relic/agent/instrumentation/typhoeus.rb +24 -7
  148. data/lib/new_relic/agent/internal_agent_error.rb +1 -1
  149. data/lib/new_relic/agent/javascript_instrumentor.rb +1 -1
  150. data/lib/new_relic/agent/log_once.rb +1 -1
  151. data/lib/new_relic/agent/logging.rb +19 -5
  152. data/lib/new_relic/agent/memory_logger.rb +1 -1
  153. data/lib/new_relic/agent/messaging.rb +6 -74
  154. data/lib/new_relic/agent/method_tracer.rb +19 -7
  155. data/lib/new_relic/agent/method_tracer_helpers.rb +3 -3
  156. data/lib/new_relic/agent/monitors.rb +27 -0
  157. data/lib/new_relic/agent/monitors/cross_app_monitor.rb +110 -0
  158. data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb +27 -0
  159. data/lib/new_relic/agent/{inbound_request_monitor.rb → monitors/inbound_request_monitor.rb} +2 -2
  160. data/lib/new_relic/agent/{synthetics_monitor.rb → monitors/synthetics_monitor.rb} +3 -5
  161. data/lib/new_relic/agent/new_relic_service.rb +8 -7
  162. data/lib/new_relic/agent/new_relic_service/encoders.rb +1 -1
  163. data/lib/new_relic/agent/new_relic_service/json_marshaller.rb +1 -1
  164. data/lib/new_relic/agent/new_relic_service/marshaller.rb +1 -1
  165. data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb +1 -1
  166. data/lib/new_relic/agent/noticible_error.rb +22 -0
  167. data/lib/new_relic/agent/null_logger.rb +1 -1
  168. data/lib/new_relic/agent/obfuscator.rb +1 -1
  169. data/lib/new_relic/agent/parameter_filtering.rb +1 -1
  170. data/lib/new_relic/agent/payload_metric_mapping.rb +1 -1
  171. data/lib/new_relic/agent/pipe_channel_manager.rb +1 -1
  172. data/lib/new_relic/agent/pipe_service.rb +1 -1
  173. data/lib/new_relic/agent/prepend_supportability.rb +1 -1
  174. data/lib/new_relic/agent/priority_sampled_buffer.rb +8 -5
  175. data/lib/new_relic/agent/range_extensions.rb +1 -1
  176. data/lib/new_relic/agent/rules_engine.rb +1 -1
  177. data/lib/new_relic/agent/rules_engine/replacement_rule.rb +1 -1
  178. data/lib/new_relic/agent/rules_engine/segment_terms_rule.rb +1 -1
  179. data/lib/new_relic/agent/sampler.rb +1 -1
  180. data/lib/new_relic/agent/sampler_collection.rb +1 -1
  181. data/lib/new_relic/agent/samplers/cpu_sampler.rb +1 -1
  182. data/lib/new_relic/agent/samplers/delayed_job_sampler.rb +1 -1
  183. data/lib/new_relic/agent/samplers/memory_sampler.rb +1 -1
  184. data/lib/new_relic/agent/samplers/object_sampler.rb +1 -1
  185. data/lib/new_relic/agent/samplers/vm_sampler.rb +1 -1
  186. data/lib/new_relic/agent/span_event_aggregator.rb +2 -1
  187. data/lib/new_relic/agent/span_event_primitive.rb +106 -54
  188. data/lib/new_relic/agent/sql_sampler.rb +6 -6
  189. data/lib/new_relic/agent/stats.rb +1 -1
  190. data/lib/new_relic/agent/stats_engine.rb +1 -1
  191. data/lib/new_relic/agent/stats_engine/gc_profiler.rb +1 -1
  192. data/lib/new_relic/agent/stats_engine/stats_hash.rb +1 -1
  193. data/lib/new_relic/agent/supported_versions.rb +3 -3
  194. data/lib/new_relic/agent/synthetics_event_aggregator.rb +1 -1
  195. data/lib/new_relic/agent/system_info.rb +13 -4
  196. data/lib/new_relic/agent/threading/agent_thread.rb +1 -1
  197. data/lib/new_relic/agent/threading/backtrace_node.rb +1 -1
  198. data/lib/new_relic/agent/threading/backtrace_service.rb +1 -1
  199. data/lib/new_relic/agent/threading/thread_profile.rb +1 -1
  200. data/lib/new_relic/agent/timestamp_sampled_buffer.rb +1 -1
  201. data/lib/new_relic/agent/tracer.rb +34 -19
  202. data/lib/new_relic/agent/transaction.rb +104 -82
  203. data/lib/new_relic/agent/transaction/abstract_segment.rb +31 -4
  204. data/lib/new_relic/agent/transaction/datastore_segment.rb +1 -1
  205. data/lib/new_relic/agent/transaction/distributed_tracer.rb +171 -0
  206. data/lib/new_relic/agent/transaction/distributed_tracing.rb +58 -147
  207. data/lib/new_relic/agent/transaction/external_request_segment.rb +30 -37
  208. data/lib/new_relic/agent/transaction/message_broker_segment.rb +4 -12
  209. data/lib/new_relic/agent/transaction/request_attributes.rb +1 -1
  210. data/lib/new_relic/agent/transaction/segment.rb +24 -2
  211. data/lib/new_relic/agent/transaction/slowest_sample_buffer.rb +1 -1
  212. data/lib/new_relic/agent/transaction/synthetics_sample_buffer.rb +1 -1
  213. data/lib/new_relic/agent/transaction/trace.rb +3 -5
  214. data/lib/new_relic/agent/transaction/trace_builder.rb +1 -1
  215. data/lib/new_relic/agent/transaction/trace_context.rb +168 -0
  216. data/lib/new_relic/agent/transaction/trace_node.rb +11 -9
  217. data/lib/new_relic/agent/transaction/tracing.rb +1 -1
  218. data/lib/new_relic/agent/transaction/transaction_sample_buffer.rb +1 -1
  219. data/lib/new_relic/agent/transaction_error_primitive.rb +11 -16
  220. data/lib/new_relic/agent/transaction_event_aggregator.rb +1 -1
  221. data/lib/new_relic/agent/transaction_event_primitive.rb +29 -40
  222. data/lib/new_relic/agent/transaction_event_recorder.rb +1 -1
  223. data/lib/new_relic/agent/transaction_metrics.rb +1 -1
  224. data/lib/new_relic/agent/transaction_sampler.rb +1 -1
  225. data/lib/new_relic/agent/transaction_time_aggregator.rb +1 -1
  226. data/lib/new_relic/agent/utilization/aws.rb +1 -1
  227. data/lib/new_relic/agent/utilization/azure.rb +1 -1
  228. data/lib/new_relic/agent/utilization/gcp.rb +1 -1
  229. data/lib/new_relic/agent/utilization/pcf.rb +1 -1
  230. data/lib/new_relic/agent/utilization/vendor.rb +1 -1
  231. data/lib/new_relic/agent/utilization_data.rb +1 -1
  232. data/lib/new_relic/agent/vm.rb +1 -1
  233. data/lib/new_relic/agent/vm/jruby_vm.rb +1 -1
  234. data/lib/new_relic/agent/vm/monotonic_gc_profiler.rb +1 -1
  235. data/lib/new_relic/agent/vm/mri_vm.rb +1 -1
  236. data/lib/new_relic/agent/vm/snapshot.rb +1 -1
  237. data/lib/new_relic/agent/worker_loop.rb +1 -1
  238. data/lib/new_relic/cli/command.rb +1 -1
  239. data/lib/new_relic/cli/commands/deployments.rb +1 -1
  240. data/lib/new_relic/cli/commands/install.rb +4 -3
  241. data/lib/new_relic/coerce.rb +32 -7
  242. data/lib/new_relic/collection_helper.rb +1 -1
  243. data/lib/new_relic/constants.rb +38 -0
  244. data/lib/new_relic/control.rb +1 -1
  245. data/lib/new_relic/control/class_methods.rb +1 -1
  246. data/lib/new_relic/control/frameworks.rb +1 -1
  247. data/lib/new_relic/control/frameworks/external.rb +1 -1
  248. data/lib/new_relic/control/frameworks/merb.rb +1 -1
  249. data/lib/new_relic/control/frameworks/rails.rb +1 -1
  250. data/lib/new_relic/control/frameworks/rails3.rb +1 -1
  251. data/lib/new_relic/control/frameworks/rails4.rb +1 -1
  252. data/lib/new_relic/control/frameworks/rails_notifications.rb +1 -1
  253. data/lib/new_relic/control/frameworks/ruby.rb +1 -1
  254. data/lib/new_relic/control/frameworks/sinatra.rb +1 -1
  255. data/lib/new_relic/control/instance_methods.rb +11 -2
  256. data/lib/new_relic/control/instrumentation.rb +1 -1
  257. data/lib/new_relic/control/server_methods.rb +1 -1
  258. data/lib/new_relic/delayed_job_injection.rb +1 -1
  259. data/lib/new_relic/dependency_detection.rb +5 -5
  260. data/lib/new_relic/environment_report.rb +6 -2
  261. data/lib/new_relic/helper.rb +1 -1
  262. data/lib/new_relic/language_support.rb +1 -1
  263. data/lib/new_relic/latest_changes.rb +2 -2
  264. data/lib/new_relic/local_environment.rb +1 -1
  265. data/lib/new_relic/metric_data.rb +1 -1
  266. data/lib/new_relic/metric_spec.rb +1 -1
  267. data/lib/new_relic/metrics.rb +1 -1
  268. data/lib/new_relic/noticed_error.rb +39 -18
  269. data/lib/new_relic/rack.rb +1 -1
  270. data/lib/new_relic/rack/agent_hooks.rb +1 -1
  271. data/lib/new_relic/rack/agent_middleware.rb +1 -1
  272. data/lib/new_relic/rack/browser_monitoring.rb +6 -1
  273. data/lib/new_relic/recipes.rb +1 -1
  274. data/lib/new_relic/recipes/capistrano3.rb +1 -1
  275. data/lib/new_relic/recipes/capistrano_legacy.rb +1 -1
  276. data/lib/new_relic/supportability_helper.rb +15 -1
  277. data/lib/new_relic/version.rb +2 -2
  278. data/lib/newrelic_rpm.rb +1 -1
  279. data/lib/sequel/extensions/newrelic_instrumentation.rb +1 -1
  280. data/lib/sequel/plugins/newrelic_instrumentation.rb +1 -1
  281. data/lib/tasks/all.rb +1 -1
  282. data/lib/tasks/multiverse.rb +26 -1
  283. data/lib/tasks/newrelic.rb +1 -1
  284. data/lib/tasks/tests.rake +6 -1
  285. data/newrelic_rpm.gemspec +19 -13
  286. data/recipes/newrelic.rb +1 -1
  287. data/test/agent_helper.rb +332 -72
  288. metadata +103 -38
  289. data/lib/new_relic/agent/cross_app_monitor.rb +0 -110
  290. data/lib/new_relic/agent/distributed_trace_monitor.rb +0 -40
  291. data/lib/new_relic/agent/http_clients/abstract_request.rb +0 -31
  292. data/lib/new_relic/agent/transaction/attributes.rb +0 -154
  293. data/lib/tasks/versions.html.erb +0 -28
  294. data/lib/tasks/versions.postface.html +0 -8
  295. data/lib/tasks/versions.preface.html +0 -9
  296. data/lib/tasks/versions.rake +0 -65
  297. data/lib/tasks/versions.txt.erb +0 -14
@@ -0,0 +1,46 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ * Using welcoming and inclusive language
12
+ * Being respectful of differing viewpoints and experiences
13
+ * Gracefully accepting constructive criticism
14
+ * Focusing on what is best for the community
15
+ * Showing empathy towards other community members
16
+
17
+ Examples of unacceptable behavior by participants include:
18
+
19
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+ * Trolling, insulting/derogatory comments, and personal or political attacks
21
+ * Public or private harassment
22
+ * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+ ## Our Responsibilities
26
+
27
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ ## Scope
32
+
33
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+ ## Enforcement
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource@newrelic.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+ ## Attribution
42
+
43
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
+
45
+ [homepage]: http://contributor-covenant.org
46
+ [version]: http://contributor-covenant.org/version/1/4/
@@ -1,8 +1,8 @@
1
1
  # Guidelines for Contributing Code
2
2
 
3
- At New Relic we welcome community code contributions to the Ruby agent, and have
4
- taken effort to make this process easy for both contributors and our development
5
- team.
3
+ New Relic welcomes code contributions by the Ruby community, and
4
+ have taken effort to make this process easy for both contributors and our
5
+ development team.
6
6
 
7
7
  When contributing, keep in mind that the agent runs in a wide variety of Ruby
8
8
  language implementations (e.g. 2.x.x, jruby, etc.) as well as a wide variety of
@@ -15,10 +15,32 @@ projects. Syntax must be compatible with all supported Ruby implementations and
15
15
  we can't assume the presence of any specific libraries, including `ActiveSupport`,
16
16
  `ActiveRecord`, etc.
17
17
 
18
+ ## Process
19
+
20
+ ### Feature Requests
21
+
22
+ Feature requests should be submitted in the [Issue tracker](../../issues), with
23
+ a description of the expected behavior & use case. Before submitting an Issue,
24
+ please search for similar ones in the [closed
25
+ issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
26
+
27
+ ### Pull Requests
28
+
29
+ We can only accept PRs for version v6.12.0 or greater due to open source
30
+ licensing restrictions.
31
+
32
+ ### Code of Conduct
33
+
34
+ Before contributing please read the [code of conduct](./CODE_OF_CONDUCT.md)
35
+
36
+ Note that our [code of conduct](./CODE_OF_CONDUCT.md) applies to all platforms
37
+ and venues related to this project; please follow it in all your interactions
38
+ with the project and its participants.
39
+
18
40
  ## Branches
19
41
 
20
- The head of master will generally have New Relic's latest release. However,
21
- New Relic reserves the ability to push an edge to the master. If you download a
42
+ The head of `main` will generally have New Relic's latest release. However,
43
+ New Relic reserves the ability to push an edge to the `main`. If you download a
22
44
  release from this repo, use the appropriate tag. New Relic usually pushes beta
23
45
  versions of a release to a working branch before tagging them for General
24
46
  Availability.
@@ -74,15 +96,37 @@ These tests can be run by invoking:
74
96
  bundle exec rake test:multiverse
75
97
 
76
98
  More details are available in
77
- [test/multiverse/README.md](https://github.com/newrelic/rpm/blob/master/test/multiverse/README.md).
99
+ [test/multiverse/README.md](https://github.com/newrelic/newrelic-ruby-agent/blob/main/test/multiverse/README.md).
100
+
101
+ ## Contributor License Agreement
102
+
103
+ Keep in mind that when you submit your Pull Request, you'll need to sign the CLA
104
+ via the click-through using CLA-Assistant. If you'd like to execute our
105
+ corporate CLA, or if you have any questions, please drop us an email at
106
+ opensource@newrelic.com.
107
+
108
+ For more information about CLAs, please check out Alex Russell’s excellent post,
109
+ [“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
110
+
111
+ ## Slack
112
+
113
+ We host a public Slack with a dedicated channel for contributors and maintainers
114
+ of open source projects hosted by New Relic. If you are contributing to this
115
+ project, you're welcome to request access to the #oss-contributors channel in
116
+ the newrelicusers.slack.com workspace. To request access, see
117
+ https://newrelicusers-signup.herokuapp.com/.
118
+
119
+ ## Explorer's Hub
120
+
121
+ New Relic hosts and moderates an online forum where customers can interact with
122
+ New Relic employees as well as other customers to get help and share best
123
+ practices. Like all official New Relic open source projects, there's a related
124
+ Community topic in the New Relic Explorers Hub. You can find this project's
125
+ topic/threads here:
78
126
 
79
- ### And Finally...
127
+ [Explorer's Hub](https://discuss.newrelic.com/c/support-products-agents/ruby-agent)
80
128
 
81
- You are welcome to send pull requests to us - however, by doing so you agree
82
- that you are granting New Relic a non-exclusive, non-revokable, no-cost license
83
- to use the code, algorithms, patents, and ideas in that code in our products if
84
- we so choose. Fortunately, you also agree the code is provided as-is and you provide no
85
- warranties as to its fitness or correctness for any purpose.
129
+ ## And Finally...
86
130
 
87
131
  If you have any feedback on how we can make contributing easier, please get in
88
132
  touch at [support.newrelic.com](http://support.newrelic.com) and let us know!
data/Gemfile CHANGED
@@ -1,3 +1,7 @@
1
- source 'https://rubygems.org'
1
+ # encoding: utf-8
2
+ # This file is distributed under New Relic's license terms.
3
+ # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
4
+ # frozen_string_literal: true
2
5
 
3
- gemspec
6
+ source 'https://rubygems.org'
7
+ gemspec name: "newrelic_rpm"
data/Guardfile CHANGED
@@ -1,8 +1,25 @@
1
- guard :minitest, :test_folders => ['test/new_relic'], :all_after_pass => false do
1
+ require './test/multiverse/lib/multiverse/bundler_patch'
2
+
3
+ test_folders = Dir.glob("test/new_relic/*").select{|f| File.directory?(f)}
4
+ test_folders += Dir.glob("test/new_relic/**/*").select{|f| File.directory?(f)}
5
+
6
+ rake_lib_path = Bundler.with_unbundled_env{ `bundle exec gem which rake`.chomp.gsub("lib/rake.rb", "lib") }
7
+ ruby_options = %{-w -I"#{rake_lib_path}" "#{rake_lib_path}/rake/rake_test_loader.rb"}
8
+
9
+ guard_options = {
10
+ spring: "bundle exec ruby #{ruby_options} ",
11
+ test_folders: ['test/new_relic'] + test_folders,
12
+ all_after_pass: false,
13
+ all_on_start: false
14
+ }
15
+
16
+ guard :minitest, guard_options do
2
17
  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
3
18
  watch(%r{^test/.+_test\.rb$})
4
19
  watch(%r{^test/rum/.*}) { "test/new_relic/rack/browser_monitoring_test.rb" }
20
+ watch(%r{^test/fixtures/cross_agent_tests/distributed_tracing/(.+).json}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
5
21
  watch('test/test_helper.rb') { "test/new_relic" }
6
22
  watch('test/agent_helper.rb') { "test/new_relic" }
7
23
  watch('lib/new_relic/agent/configuration/default_source.rb') { "test/new_relic/agent/configuration/orphan_configuration_test.rb" }
24
+ watch(%r{^lib/new_relic/agent/transaction/(.+).rb}) { |m| "test/new_relic/agent/distributed_tracing/#{m[1]}_cross_agent_test.rb" }
8
25
  end
data/LICENSE CHANGED
@@ -1,38 +1,208 @@
1
- All components of this product are
2
- Copyright (c) 2008-2017 New Relic, Inc. All rights reserved.
3
-
4
- Certain inventions disclosed in this file may be claimed within
5
- patents owned or patent applications filed by New Relic, Inc. or third
6
- parties.
7
-
8
- Subject to the terms of this notice, New Relic grants you a
9
- nonexclusive, nontransferable license, without the right to
10
- sublicense, to (a) install and execute one copy of these files on any
11
- number of workstations owned or controlled by you and (b) distribute
12
- verbatim copies of these files to third parties. As a condition to the
13
- foregoing grant, you must provide this notice along with each copy you
14
- distribute and you must not remove, alter, or obscure this notice. All
15
- other use, reproduction, modification, distribution, or other
16
- exploitation of these files is strictly prohibited, except as may be set
17
- forth in a separate written license agreement between you and New
18
- Relic. The terms of any such license agreement will control over this
19
- notice. The license stated above will be automatically terminated and
20
- revoked if you exceed its scope or violate any of the terms of this
21
- notice.
22
-
23
- This License does not grant permission to use the trade names,
24
- trademarks, service marks, or product names of New Relic, except as
25
- required for reasonable and customary use in describing the origin of
26
- this file and reproducing the content of this notice. You may not
27
- mark or brand this file with any trade name, trademarks, service
28
- marks, or product names other than the original brand (if any)
29
- provided by New Relic.
30
-
31
- Unless otherwise expressly agreed by New Relic in a separate written
32
- license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
33
- ANY KIND, including without any implied warranties of MERCHANTABILITY,
34
- FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT. As a
35
- condition to your use of these files, you are solely responsible for
36
- such use. New Relic will have no liability to you for direct,
37
- indirect, consequential, incidental, special, or punitive damages or
38
- for lost profits or data.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Versions 6.12.0 and above for this project are licensed under
179
+ Apache 2.0. For prior versions of this project, please see the
180
+ LICENSE file in the root directory of that version for more information.
181
+
182
+ APPENDIX: How to apply the Apache License to your work.
183
+
184
+ To apply the Apache License to your work, attach the following
185
+ boilerplate notice, with the fields enclosed by brackets "[]"
186
+ replaced with your own identifying information. (Don't include
187
+ the brackets!) The text should be enclosed in the appropriate
188
+ comment syntax for the file format. We also recommend that a
189
+ file or class name and description of purpose be included on the
190
+ same "printed page" as the copyright notice for easier
191
+ identification within third-party archives.
192
+
193
+ Copyright [yyyy] [name of copyright owner]
194
+
195
+ Licensed under the Apache License, Version 2.0 (the "License");
196
+ you may not use this file except in compliance with the License.
197
+ You may obtain a copy of the License at
198
+
199
+ http://www.apache.org/licenses/LICENSE-2.0
200
+
201
+ Unless required by applicable law or agreed to in writing, software
202
+ distributed under the License is distributed on an "AS IS" BASIS,
203
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
204
+ See the License for the specific language governing permissions and
205
+ limitations under the License.
206
+
207
+
208
+
data/README.md CHANGED
@@ -1,12 +1,15 @@
1
+ [![Community Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Project.png)](https://opensource.newrelic.com/oss-category/#community-project)
2
+
1
3
  # New Relic Ruby Agent
2
4
 
3
- New Relic is a performance management system, developed by
4
- New Relic, Inc (http://www.newrelic.com). It provides you with deep
5
- information about the performance of your Rails or Ruby
6
- application as it runs in production and transmits them to
7
- newrelic.com where you can monitor them in real time. The New Relic
8
- Ruby Agent is dual-purposed as a either a Gem or a Rails plugin,
9
- hosted on [github](https://github.com/newrelic/rpm/tree/master).
5
+ The New Relic Ruby agent monitors your applications to help you
6
+ [identify and solve performance issues](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#monitor-performance).
7
+ You can also extend the agent's performance monitoring to
8
+ [collect and analyze business data](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#business-data)
9
+ to help you improve the customer experience and make data-driven business decisions.
10
+
11
+ The New Relic Ruby Agent is dual-purposed as a either a Gem or a Rails plugin,
12
+ hosted on [github](https://github.com/newrelic/newrelic-ruby-agent).
10
13
 
11
14
  ## Supported Environments
12
15
 
@@ -14,124 +17,93 @@ An up-to-date list of Ruby versions and frameworks for the latest agent
14
17
  can be found on [our docs site](http://docs.newrelic.com/docs/ruby/supported-frameworks).
15
18
 
16
19
  You can also monitor non-web applications. Refer to the "Other
17
- Environments" section under "Getting Started".
18
-
19
- ## Contributing Code
20
-
21
- We welcome code contributions (in the form of pull requests) from our user
22
- community. Before submitting a pull request please review
23
- [these guidelines](https://github.com/newrelic/rpm/blob/master/CONTRIBUTING.md).
24
-
25
- Following these helps us efficiently review and incorporate your contribution
26
- and avoid breaking your code with future changes to the agent.
27
-
28
-
29
- ## Getting Started
30
-
31
- Add the Ruby Agent to your project's Gemfile.
32
-
33
- gem 'newrelic_rpm'
20
+ Environments" section below.
34
21
 
35
- To monitor your applications in production, create an account at
36
- http://newrelic.com/ . There you can
37
- sign up for a free Lite account or one of our paid subscriptions.
22
+ ## Installing and Using
38
23
 
39
- Once you receive the welcome email with a license key and
40
- `newrelic.yml` file, you can copy the `newrelic.yml` file into your app config
41
- directory OR can generate the file manually with command:
24
+ ### Quick Start
42
25
 
43
- newrelic install --license_key="YOUR_KEY" "My application"
26
+ #### With Bundler
44
27
 
45
- The initial configuration is done in the `newrelic.yml` file. This file
46
- is by default read from the `config` directory of the application root
47
- and is subsequently searched for in the application root directory,
48
- and then in a `~/.newrelic` directory. Once you're up and running you can
49
- enable Server Side Config and manage your newrelic configuration from the web
50
- UI.
28
+ For using with Bundler, add the Ruby Agent to your project's Gemfile.
51
29
 
52
- #### Rails Installation
53
-
54
- You can install the agent as a Gem:
30
+ ```ruby
31
+ gem 'newrelic_rpm'
32
+ ```
55
33
 
56
- For Bundler:
34
+ and run `bundle install` to activate the new gem.
57
35
 
58
- Add the following line to your Gemfile:
36
+ #### Without Bundler
59
37
 
60
- gem 'newrelic_rpm'
38
+ If you are not using Bundler, install the gem with:
61
39
 
62
- For Rails 2.x without Bundler:
40
+ ```bash
41
+ gem install newrelic_rpm
42
+ ```
63
43
 
64
- edit `environment.rb` and add to the initalizer block:
44
+ and then require the New Relic Ruby agent in your Ruby start-up sequence:
65
45
 
66
- config.gem "newrelic_rpm"
46
+ ```ruby
47
+ require 'newrelic_rpm'
48
+ ```
67
49
 
68
- #### Sinatra Installation
50
+ #### Oher Environments
69
51
 
70
- To use the Ruby Agent with a Sinatra app, add:
52
+ Assuming you have installed the agent per above, you may also need to tell the Ruby agent to start for some frameworks and non-framework environments. To do so, add the following to your Ruby start-up sequence start the agent:
71
53
 
72
54
  ```ruby
73
- require 'newrelic_rpm'
55
+ NewRelic::Agent.manual_start
74
56
  ```
75
57
 
76
- in your Sinatra app, below the Sinatra require directive.
58
+ ### Complete Install Instructions
77
59
 
78
- Then make sure you set `RACK_ENV` to the environment corresponding to the
79
- configuration definitions in the newrelic.yml file; e.g., development,
80
- staging, production, etc.
60
+ For complete documentation on installing the New Relic Ruby agent, see the following links:
81
61
 
82
- #### Other Environments
62
+ * [Introduction](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby)
63
+ * [Install the New Relic Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent)
64
+ * [Configure the agent](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration)
65
+ * [Update the agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/update-ruby-agent)
66
+ * [Rails plugin installation](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-installation-rails-plugin)
67
+ * [GAE Flexible Environment](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent-gae-flexible-environment)
68
+ * [Pure Rack Apps](http://docs.newrelic.com/docs/ruby/rack-middlewares)
69
+ * [Ruby agent and Heroku](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-heroku)
70
+ * [Background Jobs](https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs)
71
+ * [Uninstall the Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/uninstall-ruby-agent)
83
72
 
84
- You can use the Ruby Agent to monitor any Ruby application. Add:
73
+ ### Recording Deploys
85
74
 
86
- ```ruby
87
- require 'newrelic_rpm'
88
- ```
89
-
90
- to your startup sequence and then manually start the agent using:
75
+ The Ruby Agent supports recording deployments in New Relic via a command line
76
+ tool or Capistrano recipes. For more information on these features see
77
+ [our deployment documentation](http://docs.newrelic.com/docs/ruby/recording-deployments-with-the-ruby-agent)
78
+ for more information.
91
79
 
92
- ```ruby
93
- NewRelic::Agent.manual_start
94
- ```
80
+ ## Support
95
81
 
96
- For information about instrumenting pure Rack applications, see our
97
- [Rack middlewares documentation](http://docs.newrelic.com/docs/ruby/rack-middlewares).
82
+ New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
98
83
 
99
- Refer to the [New Relic's Docs](http://newrelic.com/docs) for details on how to
100
- monitor other web frameworks, background jobs, and daemons.
84
+ https://discuss.newrelic.com/c/support-products-agents/ruby-agent
101
85
 
102
- The Ruby Agent provides an API that allows custom instrumentation of additional
103
- frameworks. You can find a list of community created intrumentation plugins
104
- (e.g. [newrelic-redis](https://github.com/evanphx/newrelic-redis)) in the
105
- [extends_newrelic_rpm project](https://github.com/newrelic/extends_newrelic_rpm).
86
+ ## Contributing
106
87
 
107
- ## Production Mode
88
+ We encourage contributions to improve the New Relic Ruby agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
89
+ If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
108
90
 
109
- When your application runs in the production environment, the New
110
- Relic agent runs in production mode. It connects to the New Relic
111
- service and sends deep performance data to the UI for your
112
- analysis. To view this data, log in to http://rpm.newrelic.com.
91
+ If you would like to contribute to this project, please review [these guidelines](./CONTRIBUTING.md).
113
92
 
114
- NOTE: You must have a valid account and license key to view this data
115
- online. Refer to instructions in *Getting Started*.
93
+ To [all contributors](https://github.com/newrelic/newrelic-ruby-agent/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to
94
+ the [New Relic Ruby agent](https://opensource.newrelic.com/projects/newrelic/newrelic-ruby-agent).
116
95
 
117
- ## Recording Deploys
96
+ ## License
118
97
 
119
- The Ruby Agent supports recording deployments in New Relic via a command line
120
- tool or Capistrano recipes. For more information on these features see
121
- [our deployment documentation](http://docs.newrelic.com/docs/ruby/recording-deployments-with-the-ruby-agent)
122
- for more information.
98
+ The New Relic Ruby agent is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
99
+ The New Relic Ruby agent also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the [THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md).
123
100
 
124
101
  ## Support
125
102
 
126
103
  You can find more detailed documentation [on our website](http://newrelic.com/docs),
127
104
  and specifically in the [Ruby category](http://newrelic.com/docs/ruby).
128
105
 
129
- If you can't find what you're looking for there, reach out to us on our [support
130
- site](http://support.newrelic.com/) or our [community forum](https://discuss.newrelic.com/)
131
- and we'll be happy to help you.
132
-
133
- Find a bug? Contact us via [support.newrelic.com](http://support.newrelic.com/),
134
- or email support@newrelic.com.
106
+ ## Thank You
135
107
 
136
108
  Thank you, and may your application scale to infinity plus one.
137
109