com.google.jenkins.plugins.usage

Class GoogleUsageReportingPlugin

java.lang.Object

hudson.Plugin

com.google.jenkins.plugins.usage.GoogleUsageReportingPlugin

All Implemented Interfaces:

hudson.model.Saveable

public class GoogleUsageReportingPlugin
extends hudson.Plugin

A plugin that controls usage reporting to Google. This provides a means for Google-originated distributions of Jenkins to report usage metrics. Reporting is strictly gated on this plugin's config file, which should be configured through an opt-in mechanism. Default values always assume the user has not opted in.

This plugin intentionally does not expose configuration in the Jenkins UI. Usage reporting is intended to be nontrivial to enable within Jenkins, so that users who did not intend to send data will not accidentally do so.

Each instance of the plugin has an associated random UUID, which is used as an anonymous client identifier. The plugin configuration includes an optional hashed cloud project numeric ID; clients should never use an unhashed value, as this is sent over the wire.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.Plugin

hudson.Plugin.DummyImpl

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
GoogleUsageReportingPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAnalyticsId()
String	getClientId()
String	getCloudProjectNumberHash()
boolean	getEnableReporting()
static GoogleUsageReportingPlugin	getInstance() Returns the instance of this plugin created by Jenkins.
void	start()
String	toString()

Methods inherited from class hudson.Plugin

configure, configure, doDynamic, getConfigXml, getWrapper, load, postInitialize, save, setServletContext, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GoogleUsageReportingPlugin

public GoogleUsageReportingPlugin()

Method Detail

getInstance

public static GoogleUsageReportingPlugin getInstance()

Returns the instance of this plugin created by Jenkins.

getEnableReporting

public boolean getEnableReporting()

Returns:

whether reporting is enabled.

getAnalyticsId

public String getAnalyticsId()

Returns:

the Google Analytics ID that will receive reports.

getCloudProjectNumberHash

public String getCloudProjectNumberHash()

Returns:

the Google Cloud project ID hash associated with this instance.

getClientId

public String getClientId()

Returns:

the random Client ID associated with this instance.

start

public void start()
           throws IOException

Overrides:

start in class hudson.Plugin

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object