|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
|
2 <!-- |
|
3 /******************************************************************************* |
|
4 * Copyright (c) 2008 The Eclipse Foundation. |
|
5 * All rights reserved. This program and the accompanying materials |
|
6 * are made available under the terms of the Eclipse Public License v1.0 |
|
7 * which accompanies this distribution, and is available at |
|
8 * http://www.eclipse.org/legal/epl-v10.html |
|
9 * |
|
10 * Contributors: |
|
11 * The Eclipse Foundation - initial API and implementation |
|
12 *******************************************************************************/ |
|
13 --> |
|
14 <html> |
|
15 <head> |
|
16 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
|
17 <title>How Does it Work?</title> |
|
18 <link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/PRODUCT_PLUGIN/book.css" media="screen" /> |
|
19 </head> |
|
20 |
|
21 <body> |
|
22 <h1>How Does it Work?</h1> |
|
23 <p>The Usage Data Collector is designed to have a minimal impact on user |
|
24 experience. The impact on performance is negligible.</p> |
|
25 |
|
26 <p>Once installed, the Usage Data Collector immediately starts |
|
27 monitoring your use of Eclipse. In particular, it takes note of the |
|
28 views, editors, perspectives, and commands that you use. It also keeps |
|
29 track of when you bring the Eclipse workbench window into focus. At a |
|
30 lower level, the Usage Data Collector records the bundles (plug-ins) |
|
31 that are loaded by Eclipse. The information collected amounts to the id |
|
32 of the entity (view, editor, perspective, etc.), the symbolic name and |
|
33 version of the bundle that contains the entity, and the time of the |
|
34 event.</p> |
|
35 |
|
36 <p>We recognize that the data collected may contain sensitive |
|
37 information. Symbolic names for bundles can potentially include company |
|
38 and product names; bundle versions, as well as view, editor, and |
|
39 perspective ids could potentially also contain sensitive information. |
|
40 With this in mind, the Usage Data Collector includes a filtering |
|
41 framework that can be used to restrict the type of information that is |
|
42 uploaded.</p> |
|
43 |
|
44 <p>After a configurable period of time (five days by default) |
|
45 passes, it asks you for permission to upload.</p> |
|
46 |
|
47 <p align="center"><img src="UploadWiz.png" /></p> |
|
48 |
|
49 <p>At this point, you can tell the Usage Data Collector what you want to |
|
50 do:</p> |
|
51 |
|
52 <ul> |
|
53 <li><em>Upload now</em> tells the Usage Data Collector to upload the |
|
54 data that has been captured to date. After the same configurable period |
|
55 of time passes, you will be asked again.</li> |
|
56 |
|
57 <li><em>Upload always</em> tells the Usage Data Collector to upload the |
|
58 data that has been captured to date and not ask again. Henceforth, the |
|
59 data will be uploaded without asking.</li> |
|
60 |
|
61 <li><em>Don't upload</em> tells the Usage Data Collector not to upload |
|
62 the data that has been captured. After that same configurable period of |
|
63 time passes, you will be asked again. All the data collected to this |
|
64 point will be retained.</li> |
|
65 |
|
66 <li><em>Turn UDC feature off</em> tells the Usage Data Collector not to |
|
67 upload the data and to stop collecting the data altogether. This turns |
|
68 off the usage data collection.</li> |
|
69 </ul> |
|
70 <p>The period of time between requests to upload the usage data can be |
|
71 configured by changing the "Upload Period" field on the |
|
72 "Usage Data Collection | Uploading" preferences page.</p> |
|
73 |
|
74 <p align="center"><img src="UploadingPrefs.png" /></p> |
|
75 |
|
76 <p>The target for uploads is a server hosted by The Eclipse Foundation. |
|
77 The data is stored in its collected form in a foundation database.</p> |
|
78 |
|
79 <p>Two different keys are used to identify the source of the uploaded |
|
80 data. The first key identifies the workstation; this key is stored |
|
81 locally in your "user home" directory. The second key |
|
82 identifies the workspace; this key is stored in the <em><?= $tempdir ?></em> |
|
83 directory for the workspace. These keys are uploaded along with the |
|
84 usage data.</p> |
|
85 </body> |
|
86 </html> |