Chromium Code Reviews Chromium Code Reviews
Issue 2922603002:
Add an analytics domain to the analysis server. (Closed)
| OLD | NEW |
|---|---|
| 1 <!doctype html> | 1 <!doctype html> |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
| 10 <version>1.18.1</version> | 10 <version>1.18.1</version> |
| (...skipping 2194 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2205 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>. | 2205 this call will return an error of <tt>DEBUG_PORT_COULD_NOT_BE_OPENED</tt>. |
| 2206 </p> | 2206 </p> |
| 2207 <result> | 2207 <result> |
| 2208 <field name="port"> | 2208 <field name="port"> |
| 2209 <ref>int</ref> | 2209 <ref>int</ref> |
| 2210 <p>The diagnostic server port.</p> | 2210 <p>The diagnostic server port.</p> |
| 2211 </field> | 2211 </field> |
| 2212 </result> | 2212 </result> |
| 2213 </request> | 2213 </request> |
| 2214 </domain> | 2214 </domain> |
| 2215 <domain name="analytics" experimental="true"> | |
| 2216 <p> | |
| 2217 The analytics domain contains APIs related to reporting analytics. | |
| 2218 </p> | |
| 2219 <p> | |
| 2220 This API allows clients to expose a UI option to enable and disable the | |
| 2221 analysis server's reporting of analytics. This value is shared with other | |
| 2222 tools and can change outside of this API; because of this, clients should | |
| 2223 use the analysis server's flag as the system of record. Clients can choose | |
| 2224 to send in additional analytics (see <tt>sendEvent</tt> and | |
| 2225 <tt>sendTiming</tt>) if they so choose. Dart command-line tools provide a | |
| 2226 disclaimer similar to: | |
| 2227 <tt> | |
| 2228 Dart SDK tools anonymously report feature usage statistics and basic crash | |
| 2229 reports to help improve Dart tools over time. See Google's privacy policy: | |
| 2230 https://www.google.com/intl/en/policies/privacy/. | |
| 2231 </tt> | |
| 2232 </p> | |
| 2233 <p> | |
| 2234 The analysis server will send it's own analytics data (for example, operatio ns | |
| 2235 performed, operating system type, SDK version). No data (from the analysis | |
| 2236 server or from clients) will be sent if analytics is disabled. | |
| 2237 </p> | |
| 2238 <request method="isEnabled"> | |
| 2239 <p>Query whether analytics is enabled.</p> | |
| 2240 <p> | |
| 2241 This flag controls whether the analysis server sends any analytics data to | |
| 2242 the cloud. If disabled, the analysis server doesn not send any analytics | |
|
Brian Wilkerson
2017/06/02 20:38:57
"doesn" --> "does"
devoncarew
2017/06/02 20:45:35
Done.
| |
| 2243 data, and any data sent to it by clients (from <tt>sendEvent</tt> and | |
| 2244 <tt>sendTiming</tt>) will be ignored. | |
| 2245 </p> | |
| 2246 <p> | |
| 2247 The value of this flag can be changed by other tools outside of the | |
| 2248 analysis server's process. When you query the flag, you get the value of | |
| 2249 the flag at a given moment. Clients should not use the value returned to | |
| 2250 decide whether or not to send the <tt>sendEvent</tt> and <tt>sendTiming</t t> | |
| 2251 requests. Those requests should be used unconditionally and server will | |
| 2252 determine whether or not it is appropriate to forward the information to | |
| 2253 the cloud at the time each request is received. | |
| 2254 </p> | |
| 2255 <result> | |
| 2256 <field name="enabled"> | |
| 2257 <ref>bool</ref> | |
| 2258 <p>Whether sending analytics is enabled or not.</p> | |
| 2259 </field> | |
| 2260 </result> | |
| 2261 </request> | |
| 2262 <request method="enable"> | |
| 2263 <p> | |
| 2264 Enable or disable the sending of analytics data. Note that there are other | |
| 2265 ways for users to change this setting, so clients cannot assume that they | |
| 2266 have complete control over this setting. In particular, there is no | |
| 2267 guarantee that the result returned by the <tt>isEnabled</tt> request will | |
| 2268 match the last value set via this request. | |
| 2269 </p> | |
| 2270 <params> | |
| 2271 <field name="value"> | |
| 2272 <ref>bool</ref> | |
| 2273 <p>Enable or disable analytics.</p> | |
| 2274 </field> | |
| 2275 </params> | |
| 2276 </request> | |
| 2277 <request method="sendEvent"> | |
| 2278 <p>Send information about client events.</p> | |
| 2279 <p> | |
| 2280 Ask the analysis server to include the fact that an action was performed | |
| 2281 in the client as part of the analytics data being sent. The data will only | |
| 2282 be included if the sending of analytics data is enabled at the time the | |
| 2283 request is processed. The action that was performed is indicated by the | |
| 2284 value of the <tt>action</tt> field. | |
| 2285 </p> | |
| 2286 <p> | |
| 2287 The value of the action field should not include the identity of the | |
| 2288 client. The analytics data sent by server will include the client id | |
| 2289 passed in using the <tt>--client-id</tt> command-line argument. The | |
| 2290 request will be ignored if the client id was not provided when server was | |
| 2291 started. | |
| 2292 </p> | |
| 2293 <params> | |
| 2294 <field name="action"> | |
| 2295 <ref>String</ref> | |
| 2296 <p>The value used to indicate which action was performed.</p> | |
| 2297 </field> | |
| 2298 </params> | |
| 2299 </request> | |
| 2300 <request method="sendTiming"> | |
| 2301 <p>Send timing information for client events (e.g. code completions).</p> | |
| 2302 <p> | |
| 2303 Ask the analysis server to include the fact that a timed event occurred as | |
| 2304 part of the analytics data being sent. The data will only be included if | |
| 2305 the sending of analytics data is enabled at the time the request is | |
| 2306 processed. | |
| 2307 </p> | |
| 2308 <p> | |
| 2309 The value of the event field should not include the identity of the | |
| 2310 client. The analytics data sent by server will include the client id | |
| 2311 passed in using the <tt>--client-id</tt> command-line argument. The | |
| 2312 request will be ignored if the client id was not provided when server was | |
| 2313 started. | |
| 2314 </p> | |
| 2315 <params> | |
| 2316 <field name="event"> | |
| 2317 <ref>String</ref> | |
| 2318 <p>The name of the event.</p> | |
| 2319 </field> | |
| 2320 <field name="millis"> | |
| 2321 <ref>int</ref> | |
| 2322 <p>The duration of the event in milliseconds.</p> | |
| 2323 </field> | |
| 2324 </params> | |
| 2325 </request> | |
| 2326 </domain> | |
| 2215 <types> | 2327 <types> |
| 2216 <h2 class="domain"><a name="types">Types</a></h2> | 2328 <h2 class="domain"><a name="types">Types</a></h2> |
| 2217 <p> | 2329 <p> |
| 2218 This section contains descriptions of the data types referenced | 2330 This section contains descriptions of the data types referenced |
| 2219 in the API’s of the various domains. | 2331 in the API’s of the various domains. |
| 2220 </p> | 2332 </p> |
| 2221 <include path="../../../analyzer_plugin/tool/spec/common_types_spec.html" | 2333 <include path="../../../analyzer_plugin/tool/spec/common_types_spec.html" |
| 2222 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl ude> | 2334 import="package:analyzer_plugin/protocol/protocol_common.dart"></incl ude> |
| 2223 <type name="AnalysisErrorFixes"> | 2335 <type name="AnalysisErrorFixes"> |
| 2224 <p> | 2336 <p> |
| (...skipping 1266 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3491 This section contains a list of all of the errors that are | 3603 This section contains a list of all of the errors that are |
| 3492 produced by the server and the data that is returned with each. | 3604 produced by the server and the data that is returned with each. |
| 3493 </p> | 3605 </p> |
| 3494 <p> | 3606 <p> |
| 3495 TODO: TBD | 3607 TODO: TBD |
| 3496 </p> | 3608 </p> |
| 3497 <h2 class="domain"><a name="index">Index</a></h2> | 3609 <h2 class="domain"><a name="index">Index</a></h2> |
| 3498 <index></index> | 3610 <index></index> |
| 3499 </body> | 3611 </body> |
| 3500 </html> | 3612 </html> |
| OLD | NEW |
