newrelic_rpm 2.10.8 → 2.11.0.beta

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of newrelic_rpm might be problematic. Click here for more details.

Files changed (212) hide show
  1. data/CHANGELOG +15 -3
  2. data/lib/new_relic/agent.rb +17 -6
  3. data/lib/new_relic/agent/agent.rb +98 -77
  4. data/lib/new_relic/agent/busy_calculator.rb +1 -1
  5. data/lib/new_relic/agent/error_collector.rb +6 -3
  6. data/lib/new_relic/agent/instrumentation/active_record_instrumentation.rb +1 -0
  7. data/lib/new_relic/agent/instrumentation/controller_instrumentation.rb +0 -2
  8. data/lib/new_relic/agent/instrumentation/memcache.rb +0 -1
  9. data/lib/new_relic/agent/instrumentation/metric_frame.rb +8 -2
  10. data/lib/new_relic/agent/instrumentation/passenger_instrumentation.rb +3 -3
  11. data/lib/new_relic/agent/instrumentation/unicorn_instrumentation.rb +10 -0
  12. data/lib/new_relic/agent/method_tracer.rb +1 -1
  13. data/lib/new_relic/agent/shim_agent.rb +1 -1
  14. data/lib/new_relic/agent/stats_engine.rb +1 -1
  15. data/lib/new_relic/agent/stats_engine/samplers.rb +2 -2
  16. data/lib/new_relic/control.rb +6 -3
  17. data/lib/new_relic/rack/metric_app.rb +4 -4
  18. data/lib/new_relic/version.rb +3 -3
  19. data/newrelic.yml +3 -3
  20. data/newrelic_rpm.gemspec +4 -192
  21. data/test/new_relic/agent/rpm_agent_test.rb +15 -2
  22. data/test/new_relic/agent/task_instrumentation_test.rb +3 -2
  23. metadata +12 -197
  24. data/rdoc/classes/NewRelic.html +0 -293
  25. data/rdoc/classes/NewRelic/Agent.html +0 -810
  26. data/rdoc/classes/NewRelic/Agent/Agent.html +0 -742
  27. data/rdoc/classes/NewRelic/Agent/BackgroundLoadingError.html +0 -111
  28. data/rdoc/classes/NewRelic/Agent/BusyCalculator.html +0 -309
  29. data/rdoc/classes/NewRelic/Agent/CollectionHelper.html +0 -196
  30. data/rdoc/classes/NewRelic/Agent/ErrorCollector.html +0 -378
  31. data/rdoc/classes/NewRelic/Agent/ForceDisconnectException.html +0 -118
  32. data/rdoc/classes/NewRelic/Agent/ForceRestartException.html +0 -117
  33. data/rdoc/classes/NewRelic/Agent/IgnoreSilentlyException.html +0 -118
  34. data/rdoc/classes/NewRelic/Agent/Instrumentation.html +0 -174
  35. data/rdoc/classes/NewRelic/Agent/Instrumentation/ActiveRecordInstrumentation.html +0 -221
  36. data/rdoc/classes/NewRelic/Agent/Instrumentation/ControllerInstrumentation.html +0 -349
  37. data/rdoc/classes/NewRelic/Agent/Instrumentation/ControllerInstrumentation/ClassMethods.html +0 -277
  38. data/rdoc/classes/NewRelic/Agent/Instrumentation/DelayedJobInstrumentation.html +0 -112
  39. data/rdoc/classes/NewRelic/Agent/Instrumentation/MetricFrame.html +0 -1007
  40. data/rdoc/classes/NewRelic/Agent/Instrumentation/Rack.html +0 -321
  41. data/rdoc/classes/NewRelic/Agent/Instrumentation/Sinatra.html +0 -176
  42. data/rdoc/classes/NewRelic/Agent/LicenseException.html +0 -117
  43. data/rdoc/classes/NewRelic/Agent/MethodTracer.html +0 -150
  44. data/rdoc/classes/NewRelic/Agent/MethodTracer/ClassMethods.html +0 -295
  45. data/rdoc/classes/NewRelic/Agent/MethodTracer/InstanceMethods.html +0 -284
  46. data/rdoc/classes/NewRelic/Agent/PostTooBigException.html +0 -120
  47. data/rdoc/classes/NewRelic/Agent/Sampler.html +0 -314
  48. data/rdoc/classes/NewRelic/Agent/Sampler/Unsupported.html +0 -117
  49. data/rdoc/classes/NewRelic/Agent/Samplers.html +0 -126
  50. data/rdoc/classes/NewRelic/Agent/Samplers/CpuSampler.html +0 -327
  51. data/rdoc/classes/NewRelic/Agent/Samplers/DelayedJobLockSampler.html +0 -296
  52. data/rdoc/classes/NewRelic/Agent/Samplers/MemorySampler.html +0 -321
  53. data/rdoc/classes/NewRelic/Agent/Samplers/MemorySampler/Base.html +0 -186
  54. data/rdoc/classes/NewRelic/Agent/Samplers/MemorySampler/JavaHeapSampler.html +0 -173
  55. data/rdoc/classes/NewRelic/Agent/Samplers/MemorySampler/ProcStatus.html +0 -216
  56. data/rdoc/classes/NewRelic/Agent/Samplers/MemorySampler/ShellPS.html +0 -207
  57. data/rdoc/classes/NewRelic/Agent/Samplers/ObjectSampler.html +0 -222
  58. data/rdoc/classes/NewRelic/Agent/ServerError.html +0 -117
  59. data/rdoc/classes/NewRelic/Agent/ShimAgent.html +0 -297
  60. data/rdoc/classes/NewRelic/Agent/StatsEngine.html +0 -204
  61. data/rdoc/classes/NewRelic/Agent/StatsEngine/MetricStats.html +0 -441
  62. data/rdoc/classes/NewRelic/Agent/StatsEngine/Samplers.html +0 -237
  63. data/rdoc/classes/NewRelic/Agent/StatsEngine/ScopeStackElement.html +0 -178
  64. data/rdoc/classes/NewRelic/Agent/StatsEngine/Transactions.html +0 -385
  65. data/rdoc/classes/NewRelic/Agent/TransactionSampleBuilder.html +0 -505
  66. data/rdoc/classes/NewRelic/Agent/TransactionSampler.html +0 -690
  67. data/rdoc/classes/NewRelic/Agent/WorkerLoop.html +0 -305
  68. data/rdoc/classes/NewRelic/Agent/WorkerLoop/LoopTask.html +0 -224
  69. data/rdoc/classes/NewRelic/ApdexStats.html +0 -196
  70. data/rdoc/classes/NewRelic/BasicStats.html +0 -113
  71. data/rdoc/classes/NewRelic/ChainedCall.html +0 -180
  72. data/rdoc/classes/NewRelic/Commands.html +0 -112
  73. data/rdoc/classes/NewRelic/Commands/CommandFailure.html +0 -167
  74. data/rdoc/classes/NewRelic/Commands/Deployments.html +0 -285
  75. data/rdoc/classes/NewRelic/Control.html +0 -1760
  76. data/rdoc/classes/NewRelic/Control/External.html +0 -148
  77. data/rdoc/classes/NewRelic/Control/Merb.html +0 -227
  78. data/rdoc/classes/NewRelic/Control/Rails.html +0 -542
  79. data/rdoc/classes/NewRelic/Control/Ruby.html +0 -266
  80. data/rdoc/classes/NewRelic/Control/Sinatra.html +0 -178
  81. data/rdoc/classes/NewRelic/DelayedJobInjection.html +0 -118
  82. data/rdoc/classes/NewRelic/Histogram.html +0 -226
  83. data/rdoc/classes/NewRelic/Histogram/Bucket.html +0 -319
  84. data/rdoc/classes/NewRelic/Histogram/Shim.html +0 -144
  85. data/rdoc/classes/NewRelic/LocalEnvironment.html +0 -572
  86. data/rdoc/classes/NewRelic/MerbBootLoader.html +0 -146
  87. data/rdoc/classes/NewRelic/MethodTraceStats.html +0 -250
  88. data/rdoc/classes/NewRelic/MetricData.html +0 -347
  89. data/rdoc/classes/NewRelic/MetricParser.html +0 -747
  90. data/rdoc/classes/NewRelic/MetricParser/ActionMailer.html +0 -170
  91. data/rdoc/classes/NewRelic/MetricParser/ActiveMerchant.html +0 -267
  92. data/rdoc/classes/NewRelic/MetricParser/ActiveRecord.html +0 -250
  93. data/rdoc/classes/NewRelic/MetricParser/Controller.html +0 -363
  94. data/rdoc/classes/NewRelic/MetricParser/ControllerCPU.html +0 -319
  95. data/rdoc/classes/NewRelic/MetricParser/Errors.html +0 -170
  96. data/rdoc/classes/NewRelic/MetricParser/External.html +0 -339
  97. data/rdoc/classes/NewRelic/MetricParser/MemCache.html +0 -340
  98. data/rdoc/classes/NewRelic/MetricParser/OtherTransaction.html +0 -205
  99. data/rdoc/classes/NewRelic/MetricParser/View.html +0 -381
  100. data/rdoc/classes/NewRelic/MetricParser/WebFrontend.html +0 -182
  101. data/rdoc/classes/NewRelic/MetricParser/WebService.html +0 -172
  102. data/rdoc/classes/NewRelic/MetricSpec.html +0 -406
  103. data/rdoc/classes/NewRelic/Metrics.html +0 -138
  104. data/rdoc/classes/NewRelic/NoticedError.html +0 -200
  105. data/rdoc/classes/NewRelic/Rack.html +0 -112
  106. data/rdoc/classes/NewRelic/Rack/MetricApp.html +0 -193
  107. data/rdoc/classes/NewRelic/Rack/Status.html +0 -165
  108. data/rdoc/classes/NewRelic/ScopedMethodTraceStats.html +0 -225
  109. data/rdoc/classes/NewRelic/Stats.html +0 -917
  110. data/rdoc/classes/NewRelic/StatsBase.html +0 -346
  111. data/rdoc/classes/NewRelic/TransactionAnalysis.html +0 -269
  112. data/rdoc/classes/NewRelic/TransactionAnalysis/SegmentSummary.html +0 -338
  113. data/rdoc/classes/NewRelic/TransactionSample.html +0 -766
  114. data/rdoc/classes/NewRelic/TransactionSample/CompositeSegment.html +0 -195
  115. data/rdoc/classes/NewRelic/TransactionSample/FakeSegment.html +0 -113
  116. data/rdoc/classes/NewRelic/TransactionSample/IDGenerator.html +0 -178
  117. data/rdoc/classes/NewRelic/TransactionSample/Segment.html +0 -920
  118. data/rdoc/classes/NewRelic/TransactionSample/SummarySegment.html +0 -180
  119. data/rdoc/classes/NewRelic/VersionNumber.html +0 -338
  120. data/rdoc/classes/NewRelicApi.html +0 -270
  121. data/rdoc/classes/NewRelicApi/Account.html +0 -178
  122. data/rdoc/classes/NewRelicApi/Account/AccountUsage.html +0 -111
  123. data/rdoc/classes/NewRelicApi/Account/AccountView.html +0 -146
  124. data/rdoc/classes/NewRelicApi/Application.html +0 -139
  125. data/rdoc/classes/NewRelicApi/Application/Agent.html +0 -119
  126. data/rdoc/classes/NewRelicApi/Deployment.html +0 -123
  127. data/rdoc/classes/NewRelicApi/Subscription.html +0 -111
  128. data/rdoc/classes/NewRelicApi/ThresholdValue.html +0 -174
  129. data/rdoc/classes/NewRelicApi/User.html +0 -111
  130. data/rdoc/created.rid +0 -1
  131. data/rdoc/files/CHANGELOG.html +0 -649
  132. data/rdoc/files/LICENSE.html +0 -143
  133. data/rdoc/files/lib/new_relic/agent/agent_rb.html +0 -113
  134. data/rdoc/files/lib/new_relic/agent/busy_calculator_rb.html +0 -115
  135. data/rdoc/files/lib/new_relic/agent/chained_call_rb.html +0 -107
  136. data/rdoc/files/lib/new_relic/agent/collection_helper_rb.html +0 -101
  137. data/rdoc/files/lib/new_relic/agent/error_collector_rb.html +0 -101
  138. data/rdoc/files/lib/new_relic/agent/instrumentation/active_merchant_rb.html +0 -107
  139. data/rdoc/files/lib/new_relic/agent/instrumentation/active_record_instrumentation_rb.html +0 -108
  140. data/rdoc/files/lib/new_relic/agent/instrumentation/authlogic_rb.html +0 -101
  141. data/rdoc/files/lib/new_relic/agent/instrumentation/controller_instrumentation_rb.html +0 -108
  142. data/rdoc/files/lib/new_relic/agent/instrumentation/data_mapper_rb.html +0 -191
  143. data/rdoc/files/lib/new_relic/agent/instrumentation/delayed_job_instrumentation_rb.html +0 -109
  144. data/rdoc/files/lib/new_relic/agent/instrumentation/memcache_rb.html +0 -152
  145. data/rdoc/files/lib/new_relic/agent/instrumentation/merb/controller_rb.html +0 -155
  146. data/rdoc/files/lib/new_relic/agent/instrumentation/merb/errors_rb.html +0 -107
  147. data/rdoc/files/lib/new_relic/agent/instrumentation/metric_frame_rb.html +0 -113
  148. data/rdoc/files/lib/new_relic/agent/instrumentation/net_rb.html +0 -172
  149. data/rdoc/files/lib/new_relic/agent/instrumentation/passenger_instrumentation_rb.html +0 -101
  150. data/rdoc/files/lib/new_relic/agent/instrumentation/rack_rb.html +0 -108
  151. data/rdoc/files/lib/new_relic/agent/instrumentation/rails/action_controller_rb.html +0 -152
  152. data/rdoc/files/lib/new_relic/agent/instrumentation/rails/action_web_service_rb.html +0 -108
  153. data/rdoc/files/lib/new_relic/agent/instrumentation/rails/errors_rb.html +0 -167
  154. data/rdoc/files/lib/new_relic/agent/instrumentation/sinatra_rb.html +0 -108
  155. data/rdoc/files/lib/new_relic/agent/method_tracer_rb.html +0 -108
  156. data/rdoc/files/lib/new_relic/agent/sampler_rb.html +0 -116
  157. data/rdoc/files/lib/new_relic/agent/samplers/cpu_sampler_rb.html +0 -101
  158. data/rdoc/files/lib/new_relic/agent/samplers/delayed_job_lock_sampler_rb.html +0 -101
  159. data/rdoc/files/lib/new_relic/agent/samplers/memory_sampler_rb.html +0 -101
  160. data/rdoc/files/lib/new_relic/agent/samplers/object_sampler_rb.html +0 -101
  161. data/rdoc/files/lib/new_relic/agent/shim_agent_rb.html +0 -108
  162. data/rdoc/files/lib/new_relic/agent/stats_engine/metric_stats_rb.html +0 -101
  163. data/rdoc/files/lib/new_relic/agent/stats_engine/samplers_rb.html +0 -101
  164. data/rdoc/files/lib/new_relic/agent/stats_engine/transactions_rb.html +0 -101
  165. data/rdoc/files/lib/new_relic/agent/stats_engine_rb.html +0 -110
  166. data/rdoc/files/lib/new_relic/agent/transaction_sampler_rb.html +0 -101
  167. data/rdoc/files/lib/new_relic/agent/worker_loop_rb.html +0 -101
  168. data/rdoc/files/lib/new_relic/agent_rb.html +0 -204
  169. data/rdoc/files/lib/new_relic/commands/deployments_rb.html +0 -119
  170. data/rdoc/files/lib/new_relic/commands/new_relic_commands_rb.html +0 -108
  171. data/rdoc/files/lib/new_relic/control/external_rb.html +0 -117
  172. data/rdoc/files/lib/new_relic/control/merb_rb.html +0 -101
  173. data/rdoc/files/lib/new_relic/control/rails_rb.html +0 -108
  174. data/rdoc/files/lib/new_relic/control/ruby_rb.html +0 -110
  175. data/rdoc/files/lib/new_relic/control/sinatra_rb.html +0 -108
  176. data/rdoc/files/lib/new_relic/control_rb.html +0 -116
  177. data/rdoc/files/lib/new_relic/delayed_job_injection_rb.html +0 -180
  178. data/rdoc/files/lib/new_relic/histogram_rb.html +0 -114
  179. data/rdoc/files/lib/new_relic/local_environment_rb.html +0 -111
  180. data/rdoc/files/lib/new_relic/merbtasks_rb.html +0 -101
  181. data/rdoc/files/lib/new_relic/metric_data_rb.html +0 -101
  182. data/rdoc/files/lib/new_relic/metric_parser/action_mailer_rb.html +0 -101
  183. data/rdoc/files/lib/new_relic/metric_parser/active_merchant_rb.html +0 -101
  184. data/rdoc/files/lib/new_relic/metric_parser/active_record_rb.html +0 -101
  185. data/rdoc/files/lib/new_relic/metric_parser/controller_cpu_rb.html +0 -101
  186. data/rdoc/files/lib/new_relic/metric_parser/controller_rb.html +0 -101
  187. data/rdoc/files/lib/new_relic/metric_parser/errors_rb.html +0 -101
  188. data/rdoc/files/lib/new_relic/metric_parser/external_rb.html +0 -101
  189. data/rdoc/files/lib/new_relic/metric_parser/mem_cache_rb.html +0 -101
  190. data/rdoc/files/lib/new_relic/metric_parser/other_transaction_rb.html +0 -108
  191. data/rdoc/files/lib/new_relic/metric_parser/view_rb.html +0 -101
  192. data/rdoc/files/lib/new_relic/metric_parser/web_frontend_rb.html +0 -107
  193. data/rdoc/files/lib/new_relic/metric_parser/web_service_rb.html +0 -101
  194. data/rdoc/files/lib/new_relic/metric_parser_rb.html +0 -101
  195. data/rdoc/files/lib/new_relic/metric_spec_rb.html +0 -108
  196. data/rdoc/files/lib/new_relic/metrics_rb.html +0 -101
  197. data/rdoc/files/lib/new_relic/noticed_error_rb.html +0 -107
  198. data/rdoc/files/lib/new_relic/rack/metric_app_rb.html +0 -108
  199. data/rdoc/files/lib/new_relic/rack_app_rb.html +0 -110
  200. data/rdoc/files/lib/new_relic/recipes_rb.html +0 -128
  201. data/rdoc/files/lib/new_relic/stats_rb.html +0 -101
  202. data/rdoc/files/lib/new_relic/transaction_analysis_rb.html +0 -108
  203. data/rdoc/files/lib/new_relic/transaction_sample_rb.html +0 -101
  204. data/rdoc/files/lib/new_relic/version_rb.html +0 -101
  205. data/rdoc/files/lib/new_relic_api_rb.html +0 -145
  206. data/rdoc/files/lib/newrelic_rpm_rb.html +0 -147
  207. data/rdoc/files/lib/tasks/all_rb.html +0 -107
  208. data/rdoc/fr_class_index.html +0 -134
  209. data/rdoc/fr_file_index.html +0 -103
  210. data/rdoc/fr_method_index.html +0 -568
  211. data/rdoc/index.html +0 -24
  212. data/rdoc/rdoc-style.css +0 -208
@@ -1,349 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Module: NewRelic::Agent::Instrumentation::ControllerInstrumentation</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Module</strong></td>
53
- <td class="class-name-in-header">NewRelic::Agent::Instrumentation::ControllerInstrumentation</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../../../files/lib/new_relic/agent/instrumentation/controller_instrumentation_rb.html">
59
- lib/new_relic/agent/instrumentation/controller_instrumentation.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- </table>
66
- </div>
67
- <!-- banner header -->
68
-
69
- <div id="bodyContent">
70
-
71
-
72
-
73
- <div id="contextContent">
74
-
75
- <div id="description">
76
- <h2><a href="../../../NewRelic.html">NewRelic</a> instrumentation for controller actions and tasks</h2>
77
- <p>
78
- This instrumentation is applied to the action controller to collect metrics
79
- for every web request.
80
- </p>
81
- <p>
82
- It can also be used to capture performance information for background tasks
83
- and other non-web transactions, including detailed transaction traces and
84
- traced errors.
85
- </p>
86
- <p>
87
- For details on how to instrument background tasks see <a
88
- href="ControllerInstrumentation/ClassMethods.html#M000173">ClassMethods#add_transaction_tracer</a>
89
- and <a
90
- href="ControllerInstrumentation.html#M000168">perform_action_with_newrelic_trace</a>
91
- </p>
92
-
93
- </div>
94
-
95
-
96
- </div>
97
-
98
- <div id="method-list">
99
- <h3 class="section-bar">Methods</h3>
100
-
101
- <div class="name-list">
102
- <a href="#M000170">newrelic_request_headers</a>&nbsp;&nbsp;
103
- <a href="#M000169">newrelic_response_code</a>&nbsp;&nbsp;
104
- <a href="#M000168">perform_action_with_newrelic_trace</a>&nbsp;&nbsp;
105
- </div>
106
- </div>
107
-
108
- </div>
109
-
110
-
111
- <!-- if includes -->
112
-
113
- <div id="section">
114
-
115
- <div id="class-list">
116
- <h3 class="section-bar">Classes and Modules</h3>
117
-
118
- Module <a href="ControllerInstrumentation/ClassMethods.html" class="link">NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods</a><br />
119
-
120
- </div>
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
- <!-- if method_list -->
129
- <div id="methods">
130
- <h3 class="section-bar">Public Instance methods</h3>
131
-
132
- <div id="method-M000168" class="method-detail">
133
- <a name="M000168"></a>
134
-
135
- <div class="method-heading">
136
- <a href="#M000168" class="method-signature">
137
- <span class="method-name">perform_action_with_newrelic_trace</span><span class="method-args">(*args) {|| ...}</span>
138
- </a>
139
- </div>
140
-
141
- <div class="method-description">
142
- <p>
143
- Yield to the given block with <a href="../../../NewRelic.html">NewRelic</a>
144
- tracing. Used by default instrumentation on controller actions in Rails and
145
- Merb. But it can also be used in custom instrumentation of controller
146
- methods and background tasks.
147
- </p>
148
- <p>
149
- This is the method invoked by instrumentation added by the <tt><a
150
- href="ControllerInstrumentation/ClassMethods.html#M000173">ClassMethods#add_transaction_tracer</a></tt>.
151
- </p>
152
- <p>
153
- Here&#8216;s a more verbose version of the example shown in <tt><a
154
- href="ControllerInstrumentation/ClassMethods.html#M000173">ClassMethods#add_transaction_tracer</a></tt>
155
- using this method instead of add_transaction_tracer.
156
- </p>
157
- <p>
158
- Below is a controller with an <tt>invoke_operation</tt> action which
159
- dispatches to more specific operation methods based on a parameter (very
160
- dangerous, btw!). With this instrumentation, the <tt>invoke_operation</tt>
161
- action is ignored but the operation methods show up in RPM as if they were
162
- first class controller actions
163
- </p>
164
- <pre>
165
- MyController &lt; ActionController::Base
166
- include NewRelic::Agent::Instrumentation::ControllerInstrumentation
167
- # dispatch the given op to the method given by the service parameter.
168
- def invoke_operation
169
- op = params['operation']
170
- perform_action_with_newrelic_trace(:name =&gt; op) do
171
- send op, params['message']
172
- end
173
- end
174
- # Ignore the invoker to avoid double counting
175
- newrelic_ignore :only =&gt; 'invoke_operation'
176
- end
177
- </pre>
178
- <p>
179
- When invoking this method explicitly as in the example above, pass in a
180
- block to measure with some combination of options:
181
- </p>
182
- <ul>
183
- <li><tt>:category =&gt; :controller</tt> indicates that this is a controller
184
- action and will appear with all the other actions. This is the default.
185
-
186
- </li>
187
- <li><tt>:category =&gt; :task</tt> indicates that this is a background task and
188
- will show up in RPM with other background tasks instead of in the
189
- controllers list
190
-
191
- </li>
192
- <li><tt>:category =&gt; :rack</tt> if you are instrumenting a rack middleware
193
- call. The <tt>:name</tt> is optional, useful if you have more than one
194
- potential transaction in the call.
195
-
196
- </li>
197
- <li><tt>:category =&gt; :uri</tt> indicates that this is a web transaction
198
- whose name is a normalized URI, where &#8216;normalized&#8217; means the
199
- URI does not have any elements with data in them such as in many REST URIs.
200
-
201
- </li>
202
- <li><tt>:name =&gt; action_name</tt> is used to specify the action name used as
203
- part of the metric name
204
-
205
- </li>
206
- <li><tt>:params =&gt; {&#8230;}</tt> to provide information about the context
207
- of the call, used in transaction trace display, for example: <tt>:params
208
- =&gt; { :account =&gt; @account.name, :file =&gt; file.name }</tt> These
209
- are treated similarly to request parameters in web transactions.
210
-
211
- </li>
212
- </ul>
213
- <p>
214
- Seldomly used options:
215
- </p>
216
- <ul>
217
- <li><tt>:force =&gt; true</tt> indicates you should capture all metrics even if
218
- the newrelic_ignore directive was specified
219
-
220
- </li>
221
- <li><tt>:class_name =&gt; aClass.name</tt> is used to override the name of the
222
- class when used inside the metric name. Default is the current class.
223
-
224
- </li>
225
- <li><tt>:path =&gt; metric_path</tt> is <b>deprecated</b> in the public API. It
226
- allows you to set the entire metric after the category part. Overrides all
227
- the other options.
228
-
229
- </li>
230
- <li><tt>:request =&gt; Rack::Request#new(env)</tt> is used to pass in a request
231
- object that may respond to uri and referer.
232
-
233
- </li>
234
- </ul>
235
- <p>
236
- If a single argument is passed in, it is treated as a metric path. This
237
- form is deprecated.
238
- </p>
239
- <p><a class="source-toggle" href="#"
240
- onclick="toggleCode('M000168-source');return false;">[Source]</a></p>
241
- <div class="method-source-code" id="M000168-source">
242
- <pre>
243
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 232</span>
244
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">perform_action_with_newrelic_trace</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
245
-
246
- <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">ensure_worker_thread_started</span>
247
-
248
- <span class="ruby-comment cmt"># Skip instrumentation based on the value of 'do_not_trace' and if </span>
249
- <span class="ruby-comment cmt"># we aren't calling directly with a block.</span>
250
- <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">block_given?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">_is_filtered?</span>(<span class="ruby-value str">'do_not_trace'</span>)
251
- <span class="ruby-comment cmt"># Also ignore all instrumentation in the call sequence</span>
252
- <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span>.<span class="ruby-identifier">disable_all_tracing</span> <span class="ruby-keyword kw">do</span>
253
- <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">perform_action_without_newrelic_trace</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
254
- <span class="ruby-keyword kw">end</span>
255
- <span class="ruby-keyword kw">end</span>
256
-
257
- <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">perform_action_with_newrelic_profile</span>(<span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Control</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">profiling?</span>
258
-
259
- <span class="ruby-identifier">frame_data</span> = <span class="ruby-identifier">_push_metric_frame</span>(<span class="ruby-identifier">block_given?</span> <span class="ruby-value">? </span><span class="ruby-identifier">args</span> <span class="ruby-operator">:</span> [])
260
- <span class="ruby-keyword kw">begin</span>
261
- <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span>.<span class="ruby-identifier">trace_execution_scoped</span> <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">recorded_metrics</span>, <span class="ruby-identifier">:force</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">force_flag</span> <span class="ruby-keyword kw">do</span>
262
- <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">start_transaction</span>
263
- <span class="ruby-keyword kw">begin</span>
264
- <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span><span class="ruby-operator">::</span><span class="ruby-constant">BusyCalculator</span>.<span class="ruby-identifier">dispatcher_start</span> <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">start</span>
265
- <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
266
- <span class="ruby-keyword kw">yield</span>
267
- <span class="ruby-keyword kw">else</span>
268
- <span class="ruby-identifier">perform_action_without_newrelic_trace</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
269
- <span class="ruby-keyword kw">end</span>
270
- <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
271
- <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">notice_error</span>(<span class="ruby-identifier">e</span>)
272
- <span class="ruby-identifier">raise</span>
273
- <span class="ruby-keyword kw">end</span>
274
- <span class="ruby-keyword kw">end</span>
275
- <span class="ruby-keyword kw">ensure</span>
276
- <span class="ruby-constant">NewRelic</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span><span class="ruby-operator">::</span><span class="ruby-constant">BusyCalculator</span>.<span class="ruby-identifier">dispatcher_finish</span>
277
- <span class="ruby-comment cmt"># Look for a metric frame in the thread local and process it.</span>
278
- <span class="ruby-comment cmt"># Clear the thread local when finished to ensure it only gets called once.</span>
279
- <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">record_apdex</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">_is_filtered?</span>(<span class="ruby-value str">'ignore_apdex'</span>)
280
- <span class="ruby-identifier">frame_data</span>.<span class="ruby-identifier">pop</span>
281
- <span class="ruby-keyword kw">end</span>
282
- <span class="ruby-keyword kw">end</span>
283
- </pre>
284
- </div>
285
- </div>
286
- </div>
287
-
288
- <h3 class="section-bar">Protected Instance methods</h3>
289
-
290
- <div id="method-M000170" class="method-detail">
291
- <a name="M000170"></a>
292
-
293
- <div class="method-heading">
294
- <a href="#M000170" class="method-signature">
295
- <span class="method-name">newrelic_request_headers</span><span class="method-args">()</span>
296
- </a>
297
- </div>
298
-
299
- <div class="method-description">
300
- <p><a class="source-toggle" href="#"
301
- onclick="toggleCode('M000170-source');return false;">[Source]</a></p>
302
- <div class="method-source-code" id="M000170-source">
303
- <pre>
304
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 276</span>
305
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newrelic_request_headers</span>
306
- <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:request</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:headers</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">headers</span>
307
- <span class="ruby-keyword kw">end</span>
308
- </pre>
309
- </div>
310
- </div>
311
- </div>
312
-
313
- <div id="method-M000169" class="method-detail">
314
- <a name="M000169"></a>
315
-
316
- <div class="method-heading">
317
- <a href="#M000169" class="method-signature">
318
- <span class="method-name">newrelic_response_code</span><span class="method-args">()</span>
319
- </a>
320
- </div>
321
-
322
- <div class="method-description">
323
- <p>
324
- Should be implemented in the dispatcher class
325
- </p>
326
- <p><a class="source-toggle" href="#"
327
- onclick="toggleCode('M000169-source');return false;">[Source]</a></p>
328
- <div class="method-source-code" id="M000169-source">
329
- <pre>
330
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 274</span>
331
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newrelic_response_code</span>; <span class="ruby-keyword kw">end</span>
332
- </pre>
333
- </div>
334
- </div>
335
- </div>
336
-
337
-
338
- </div>
339
-
340
-
341
- </div>
342
-
343
-
344
- <div id="validator-badges">
345
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
346
- </div>
347
-
348
- </body>
349
- </html>
@@ -1,277 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Module: NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Module</strong></td>
53
- <td class="class-name-in-header">NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../../../../files/lib/new_relic/agent/instrumentation/controller_instrumentation_rb.html">
59
- lib/new_relic/agent/instrumentation/controller_instrumentation.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- </table>
66
- </div>
67
- <!-- banner header -->
68
-
69
- <div id="bodyContent">
70
-
71
-
72
-
73
- <div id="contextContent">
74
-
75
-
76
-
77
- </div>
78
-
79
- <div id="method-list">
80
- <h3 class="section-bar">Methods</h3>
81
-
82
- <div class="name-list">
83
- <a href="#M000173">add_transaction_tracer</a>&nbsp;&nbsp;
84
- <a href="#M000171">newrelic_ignore</a>&nbsp;&nbsp;
85
- <a href="#M000172">newrelic_ignore_apdex</a>&nbsp;&nbsp;
86
- </div>
87
- </div>
88
-
89
- </div>
90
-
91
-
92
- <!-- if includes -->
93
-
94
- <div id="section">
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
- <!-- if method_list -->
104
- <div id="methods">
105
- <h3 class="section-bar">Public Instance methods</h3>
106
-
107
- <div id="method-M000173" class="method-detail">
108
- <a name="M000173"></a>
109
-
110
- <div class="method-heading">
111
- <a href="#M000173" class="method-signature">
112
- <span class="method-name">add_transaction_tracer</span><span class="method-args">(method, options={})</span>
113
- </a>
114
- </div>
115
-
116
- <div class="method-description">
117
- <p>
118
- Add transaction tracing to the given method. This will treat the given
119
- method as a main entrypoint for instrumentation, just like controller
120
- actions are treated by default. Useful especially for background tasks.
121
- </p>
122
- <p>
123
- Example for background job:
124
- </p>
125
- <pre>
126
- class Job
127
- include NewRelic::Agent::Instrumentation::ControllerInstrumentation
128
- def run(task)
129
- ...
130
- end
131
- # Instrument run so tasks show up under task.name. Note single
132
- # quoting to defer eval to runtime.
133
- add_transaction_tracer :run, :name =&gt; '#{args[0].name}'
134
- end
135
- </pre>
136
- <p>
137
- Here&#8216;s an example of a controller that uses a dispatcher action to
138
- invoke operations which you want treated as top level actions, so they
139
- aren&#8216;t all lumped into the invoker action.
140
- </p>
141
- <pre>
142
- MyController &lt; ActionController::Base
143
- include NewRelic::Agent::Instrumentation::ControllerInstrumentation
144
- # dispatch the given op to the method given by the service parameter.
145
- def invoke_operation
146
- op = params['operation']
147
- send op
148
- end
149
- # Ignore the invoker to avoid double counting
150
- newrelic_ignore :only =&gt; 'invoke_operation'
151
- # Instrument the operations:
152
- add_transaction_tracer :print
153
- add_transaction_tracer :show
154
- add_transaction_tracer :forward
155
- end
156
- </pre>
157
- <p>
158
- Here&#8216;s an example of how to pass contextual information into the
159
- transaction so it will appear in transaction traces:
160
- </p>
161
- <pre>
162
- class Job
163
- include NewRelic::Agent::Instrumentation::ControllerInstrumentation
164
- def process(account)
165
- ...
166
- end
167
- # Include the account name in the transaction details. Note the single
168
- # quotes to defer eval until call time.
169
- add_transaction_tracer :process, :params =&gt; '{ :account_name =&gt; args[0].name }'
170
- end
171
- </pre>
172
- <p>
173
- See <a
174
- href="../ControllerInstrumentation.html#M000168">NewRelic::Agent::Instrumentation::ControllerInstrumentation#perform_action_with_newrelic_trace</a>
175
- for the full list of available options.
176
- </p>
177
- <p><a class="source-toggle" href="#"
178
- onclick="toggleCode('M000173-source');return false;">[Source]</a></p>
179
- <div class="method-source-code" id="M000173-source">
180
- <pre>
181
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 124</span>
182
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_transaction_tracer</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">options</span>={})
183
- <span class="ruby-comment cmt"># The metric path:</span>
184
- <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>
185
- <span class="ruby-comment cmt"># create the argument list:</span>
186
- <span class="ruby-identifier">options_arg</span> = []
187
- <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
188
- <span class="ruby-identifier">valuestr</span> = <span class="ruby-keyword kw">case</span>
189
- <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
190
- <span class="ruby-identifier">value</span>.<span class="ruby-identifier">inspect</span>
191
- <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:params</span>
192
- <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
193
- <span class="ruby-keyword kw">else</span>
194
- <span class="ruby-node">%Q[&quot;#{value.to_s}&quot;]</span>
195
- <span class="ruby-keyword kw">end</span>
196
- <span class="ruby-identifier">options_arg</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">%Q[:#{key} =&gt; #{valuestr}]</span>
197
- <span class="ruby-keyword kw">end</span>
198
- <span class="ruby-identifier">class_eval</span> <span class="ruby-value str">&quot;def \#{method.to_s}_with_newrelic_transaction_trace(*args, &amp;block)\nperform_action_with_newrelic_trace(\#{options_arg.join(',')}) do\n\#{method.to_s}_without_newrelic_transaction_trace(*args, &amp;block)\nend\nend\n&quot;</span>
199
- <span class="ruby-identifier">alias_method</span> <span class="ruby-node">&quot;#{method.to_s}_without_newrelic_transaction_trace&quot;</span>, <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>
200
- <span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-node">&quot;#{method.to_s}_with_newrelic_transaction_trace&quot;</span>
201
- <span class="ruby-keyword kw">end</span>
202
- </pre>
203
- </div>
204
- </div>
205
- </div>
206
-
207
- <div id="method-M000171" class="method-detail">
208
- <a name="M000171"></a>
209
-
210
- <div class="method-heading">
211
- <a href="#M000171" class="method-signature">
212
- <span class="method-name">newrelic_ignore</span><span class="method-args">(specifiers={})</span>
213
- </a>
214
- </div>
215
-
216
- <div class="method-description">
217
- <p>
218
- Have <a href="../../../../NewRelic.html">NewRelic</a> ignore actions in
219
- this controller. Specify the actions as hash options using :except and
220
- :only. If no actions are specified, all actions are ignored.
221
- </p>
222
- <p><a class="source-toggle" href="#"
223
- onclick="toggleCode('M000171-source');return false;">[Source]</a></p>
224
- <div class="method-source-code" id="M000171-source">
225
- <pre>
226
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 43</span>
227
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newrelic_ignore</span>(<span class="ruby-identifier">specifiers</span>={})
228
- <span class="ruby-identifier">newrelic_ignore_aspect</span>(<span class="ruby-value str">'do_not_trace'</span>, <span class="ruby-identifier">specifiers</span>)
229
- <span class="ruby-keyword kw">end</span>
230
- </pre>
231
- </div>
232
- </div>
233
- </div>
234
-
235
- <div id="method-M000172" class="method-detail">
236
- <a name="M000172"></a>
237
-
238
- <div class="method-heading">
239
- <a href="#M000172" class="method-signature">
240
- <span class="method-name">newrelic_ignore_apdex</span><span class="method-args">(specifiers={})</span>
241
- </a>
242
- </div>
243
-
244
- <div class="method-description">
245
- <p>
246
- Have <a href="../../../../NewRelic.html">NewRelic</a> omit apdex
247
- measurements on the given actions. Typically used for actions that are not
248
- user facing or that skew your overall apdex measurement. Accepts :except
249
- and :only options, as with <a
250
- href="ClassMethods.html#M000171">newrelic_ignore</a>.
251
- </p>
252
- <p><a class="source-toggle" href="#"
253
- onclick="toggleCode('M000172-source');return false;">[Source]</a></p>
254
- <div class="method-source-code" id="M000172-source">
255
- <pre>
256
- <span class="ruby-comment cmt"># File lib/new_relic/agent/instrumentation/controller_instrumentation.rb, line 49</span>
257
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newrelic_ignore_apdex</span>(<span class="ruby-identifier">specifiers</span>={})
258
- <span class="ruby-identifier">newrelic_ignore_aspect</span>(<span class="ruby-value str">'ignore_apdex'</span>, <span class="ruby-identifier">specifiers</span>)
259
- <span class="ruby-keyword kw">end</span>
260
- </pre>
261
- </div>
262
- </div>
263
- </div>
264
-
265
-
266
- </div>
267
-
268
-
269
- </div>
270
-
271
-
272
- <div id="validator-badges">
273
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
274
- </div>
275
-
276
- </body>
277
- </html>