1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module telemetry.core.tracing_controller</title>
4<meta charset="utf-8">
5</head><body bgcolor="#f0f0f8">
6
7<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
8<tr bgcolor="#7799ee">
9<td valign=bottom>&nbsp;<br>
10<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.tracing_controller</strong></big></big></font></td
11><td align=right valign=bottom
12><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/tracing_controller.py">telemetry/core/tracing_controller.py</a></font></td></tr></table>
13    <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
14#&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
15#&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#ee77aa">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
21
22<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
23<td width="100%"><dl>
24<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
25</font></dt><dd>
26<dl>
27<dt><font face="helvetica, arial"><a href="telemetry.core.tracing_controller.html#TracingController">TracingController</a>
28</font></dt></dl>
29</dd>
30</dl>
31 <p>
32<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
33<tr bgcolor="#ffc8d8">
34<td colspan=3 valign=bottom>&nbsp;<br>
35<font color="#000000" face="helvetica, arial"><a name="TracingController">class <strong>TracingController</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
36
37<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
38<td width="100%">Methods defined here:<br>
39<dl><dt><a name="TracingController-IsChromeTracingSupported"><strong>IsChromeTracingSupported</strong></a>(self)</dt><dd><tt>Returns&nbsp;whether&nbsp;chrome&nbsp;tracing&nbsp;is&nbsp;supported.</tt></dd></dl>
40
41<dl><dt><a name="TracingController-Start"><strong>Start</strong></a>(self, trace_options, category_filter, timeout<font color="#909090">=10</font>)</dt><dd><tt>Starts&nbsp;tracing.<br>
42&nbsp;<br>
43trace_options&nbsp;specifies&nbsp;which&nbsp;tracing&nbsp;systems&nbsp;to&nbsp;activate.&nbsp;Category&nbsp;filter<br>
44allows&nbsp;fine-tuning&nbsp;of&nbsp;the&nbsp;data&nbsp;that&nbsp;are&nbsp;collected&nbsp;by&nbsp;the&nbsp;selected&nbsp;tracing<br>
45systems.<br>
46&nbsp;<br>
47Some&nbsp;tracers&nbsp;are&nbsp;process-specific,&nbsp;e.g.&nbsp;chrome&nbsp;tracing,&nbsp;but&nbsp;are&nbsp;not<br>
48guaranteed&nbsp;to&nbsp;be&nbsp;supported.&nbsp;In&nbsp;order&nbsp;to&nbsp;support&nbsp;tracing&nbsp;of&nbsp;these&nbsp;kinds&nbsp;of<br>
49tracers,&nbsp;Start&nbsp;will&nbsp;succeed&nbsp;*always*,&nbsp;even&nbsp;if&nbsp;the&nbsp;tracing&nbsp;systems&nbsp;you&nbsp;have<br>
50requested&nbsp;are&nbsp;not&nbsp;supported.<br>
51&nbsp;<br>
52If&nbsp;you&nbsp;absolutely&nbsp;require&nbsp;a&nbsp;particular&nbsp;tracer&nbsp;to&nbsp;exist,&nbsp;then&nbsp;check<br>
53for&nbsp;its&nbsp;support&nbsp;after&nbsp;you&nbsp;have&nbsp;started&nbsp;the&nbsp;process&nbsp;in&nbsp;question.&nbsp;Or,&nbsp;have<br>
54your&nbsp;code&nbsp;fail&nbsp;gracefully&nbsp;when&nbsp;the&nbsp;data&nbsp;you&nbsp;require&nbsp;is&nbsp;not&nbsp;present&nbsp;in&nbsp;the<br>
55resulting&nbsp;trace.</tt></dd></dl>
56
57<dl><dt><a name="TracingController-Stop"><strong>Stop</strong></a>(self)</dt><dd><tt>Stops&nbsp;tracing&nbsp;and&nbsp;returns&nbsp;a&nbsp;TraceValue.</tt></dd></dl>
58
59<dl><dt><a name="TracingController-__init__"><strong>__init__</strong></a>(self, tracing_controller_backend)</dt><dd><tt>Provides&nbsp;control&nbsp;of&nbsp;the&nbsp;tracing&nbsp;systems&nbsp;supported&nbsp;by&nbsp;telemetry.</tt></dd></dl>
60
61<hr>
62Data descriptors defined here:<br>
63<dl><dt><strong>__dict__</strong></dt>
64<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
65</dl>
66<dl><dt><strong>__weakref__</strong></dt>
67<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
68</dl>
69<dl><dt><strong>is_tracing_running</strong></dt>
70</dl>
71</td></tr></table></td></tr></table>
72</body></html>