mirror of
https://github.com/jenkinsci/jenkins.git
synced 2026-11-18 06:22:29 +00:00
Added anonymous usage statistics tracking with opt-out.
(<a href="http://www.nabble.com/-request-for-comments--tracking-usage-metrics-td20945409.html">discussion</a>) git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@13533 71c3de6d-444a-0410-be80-ed276b4c234a
This commit is contained in:
1 parent
d0d7c5846a
commit
cd7488cc1b
7 files changed
+216
No files matched your search
@@ -319,6 +319,11 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node,
|
||||
|
||||
private transient final UpdateCenter updateCenter = new UpdateCenter();
|
||||
|
||||
/**
|
||||
* True if the user opted out from the statistics tracking. We'll never send anything if this is true.
|
||||
*/
|
||||
private Boolean noUsageStatistics;
|
||||
|
||||
/**
|
||||
* HTTP proxy configuration.
|
||||
*/
|
||||
@@ -409,6 +414,7 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node,
|
||||
HudsonFilter.REMEMBER_ME_SERVICES_PROXY.setDelegate(rms);
|
||||
|
||||
WindowsInstallerLink.registerIfApplicable();
|
||||
UsageStatistics.register();
|
||||
}
|
||||
|
||||
public TcpSlaveAgentListener getTcpSlaveAgentListener() {
|
||||
@@ -446,6 +452,10 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node,
|
||||
return updateCenter;
|
||||
}
|
||||
|
||||
public boolean isUsageStatisticsCollected() {
|
||||
return noUsageStatistics==null || !noUsageStatistics;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a secret key that survives across container start/stop.
|
||||
* <p>
|
||||
@@ -1595,6 +1605,8 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node,
|
||||
authorizationStrategy = AuthorizationStrategy.UNSECURED;
|
||||
}
|
||||
|
||||
noUsageStatistics = json.has("usageStatisticsCollected") ? null : true;
|
||||
|
||||
{
|
||||
String v = req.getParameter("slaveAgentPortType");
|
||||
if(!isUseSecurity() || v==null || v.equals("random"))
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
package hudson.model;
|
||||
|
||||
import com.trilead.ssh2.crypto.Base64;
|
||||
import hudson.Util;
|
||||
import static hudson.util.TimeUnit2.DAYS;
|
||||
import net.sf.json.JSONObject;
|
||||
import org.apache.commons.io.output.ByteArrayOutputStream;
|
||||
|
||||
import javax.crypto.Cipher;
|
||||
import javax.crypto.CipherOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.OutputStreamWriter;
|
||||
import java.security.GeneralSecurityException;
|
||||
import java.security.KeyFactory;
|
||||
import java.security.PublicKey;
|
||||
import java.security.spec.X509EncodedKeySpec;
|
||||
import java.util.zip.GZIPOutputStream;
|
||||
|
||||
/**
|
||||
* @author Kohsuke Kawaguchi
|
||||
*/
|
||||
public class UsageStatistics extends PageDecorator {
|
||||
private final String keyImage;
|
||||
|
||||
/**
|
||||
* Lazily computed {@link PublicKey} representation of {@link #keyImage}.
|
||||
*/
|
||||
private volatile transient PublicKey key;
|
||||
|
||||
/**
|
||||
* When was the last time we asked a browser to send the usage stats for us?
|
||||
*/
|
||||
private volatile transient long lastAttempt = -1;
|
||||
|
||||
public UsageStatistics() {
|
||||
this(DEFAULT_KEY_BYTES);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an instance with a specific public key image.
|
||||
*/
|
||||
public UsageStatistics(String keyImage) {
|
||||
super(UsageStatistics.class);
|
||||
this.keyImage = keyImage;
|
||||
load();
|
||||
}
|
||||
|
||||
// register the instance
|
||||
static {
|
||||
PageDecorator.ALL.add(new UsageStatistics());
|
||||
}
|
||||
|
||||
/**
|
||||
* No-op, but calling this method makes sure that the static initializer is run.
|
||||
*/
|
||||
static void register() {}
|
||||
|
||||
/**
|
||||
* Returns true if it's time for us to check for new version.
|
||||
*/
|
||||
public boolean isDue() {
|
||||
// user opted out. no data collection.
|
||||
if(!Hudson.getInstance().isUsageStatisticsCollected()) return false;
|
||||
|
||||
long now = System.currentTimeMillis();
|
||||
if(now - lastAttempt > DAY) {
|
||||
lastAttempt = now;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
private Cipher getCipher() {
|
||||
try {
|
||||
if (key == null) {
|
||||
KeyFactory keyFactory = KeyFactory.getInstance("RSA");
|
||||
key = keyFactory.generatePublic(new X509EncodedKeySpec(Util.fromHexString(keyImage)));
|
||||
}
|
||||
|
||||
Cipher cipher = Cipher.getInstance("RSA");
|
||||
cipher.init(Cipher.ENCRYPT_MODE, key);
|
||||
return cipher;
|
||||
} catch (GeneralSecurityException e) {
|
||||
throw new Error(e); // impossible
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the encrypted usage stat data to be sent to the Hudson server.
|
||||
*/
|
||||
public String getStatData() throws IOException {
|
||||
JSONObject o = new JSONObject();
|
||||
o.put("version",1);
|
||||
|
||||
// json -> UTF-8 encode -> gzip -> encrypt -> base64 -> string
|
||||
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
||||
OutputStreamWriter w = new OutputStreamWriter(new GZIPOutputStream(new CipherOutputStream(baos,getCipher())), "UTF-8");
|
||||
o.write(w);
|
||||
w.close();
|
||||
|
||||
return new String(Base64.encode(baos.toByteArray()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Public key to encrypt the usage statistics
|
||||
*/
|
||||
private static final String DEFAULT_KEY_BYTES = "30819f300d06092a864886f70d010101050003818d0030818902818100c14970473bd90fd1f2d20e4fa6e36ea21f7d46db2f4104a3a8f2eb097d6e26278dfadf3fe9ed05bbbb00a4433f4b7151e6683a169182e6ff2f6b4f2bb6490b2cddef73148c37a2a7421fc75f99fb0fadab46f191806599a208652f4829fd6f76e13195fb81ff3f2fce15a8e9a85ebe15c07c90b34ebdb416bd119f0d74105f3b0203010001";
|
||||
|
||||
private static final long DAY = DAYS.toMillis(1);
|
||||
}
|
||||
Reference in new issue
Block a user