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