Package com.intellij.internal.statistic.service.fus.collectors

Class ProjectUsagesCollector

java.lang.Object

com.intellij.internal.statistic.service.fus.collectors.FeatureUsagesCollector

com.intellij.internal.statistic.service.fus.collectors.ProjectUsagesCollector

Direct Known Subclasses:

FacetTypeUsageCollector, FileTypeUsagesCollector, FUSLibraryJarUsagesCollector, InspectionsUsagesCollector, ProjectStructureUsageCollector, RunConfigurationTypeUsagesCollector, RunDashboardUsagesCollector, VcsLogFeaturesCollector, VcsLogRepoSizeCollector

public abstract class ProjectUsagesCollector
extends FeatureUsagesCollector

Use it to create a collector which records project state.

To implement a new collector:

1. Inherit the class, implement getMetrics(Project) and register collector in plugin.xml;
2. Specify collectors data scheme and implement custom validation rules if necessary.
   For more information see SensitiveDataValidator;
3. Create an issue to add group, its data scheme and description to the whitelist;

To test collector:

1. If group is not whitelisted, add it to local whitelist with "Add Test Group to Local Whitelist" action.
   com.intellij.internal.statistic.actions.localWhitelist.AddTestGroupToLocalWhitelistAction
2. Open toolwindow with event logs with "Show Statistics Event Log" action.
   com.intellij.internal.statistic.actions.ShowStatisticsEventLogAction
3. Record all state collectors with "Record State Collectors to Event Log" action.
   RecordStateStatisticsEventLogAction

See Also:

ApplicationUsagesCollector, FUCounterUsageLogger

Constructor Summary

Constructors

Constructor and Description
ProjectUsagesCollector()

Method Summary

Modifier and Type	Method and Description
FeatureUsageData	getData(Project project)
static java.util.Set<ProjectUsagesCollector>	getExtensions(com.intellij.internal.statistic.service.fus.collectors.UsagesCollectorConsumer invoker)
protected java.util.Set<MetricEvent>	getMetrics(Project project) If you need to perform long blocking operations with Read lock or on EDT, consider using getMetrics(Project, ProgressIndicator) along with ReadAction#nonBlocking if needed, or override requiresReadAccess() method to wrap metrics gathering with non-blocking read action automatically.
CancellablePromise<? extends java.util.Set<MetricEvent>>	getMetrics(Project project, ProgressIndicator indicator) Implement this method to calculate metrics.
java.util.Set<UsageDescriptor>	getUsages(Project project) Deprecated. use getMetrics(Project, ProgressIndicator)
protected boolean	requiresReadAccess()

Methods inherited from class com.intellij.internal.statistic.service.fus.collectors.FeatureUsagesCollector

getExtensions, getGroupId, getVersion, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectUsagesCollector

public ProjectUsagesCollector()

Method Detail

getExtensions

public static java.util.Set<ProjectUsagesCollector> getExtensions(com.intellij.internal.statistic.service.fus.collectors.UsagesCollectorConsumer invoker)

getMetrics

public CancellablePromise<? extends java.util.Set<MetricEvent>> getMetrics(Project project,
                                                                           ProgressIndicator indicator)

Implement this method to calculate metrics.

MetricEvent#eventId should indicate what we measure, e.g. "configured.vcs", "module.jdk".
MetricEvent#data should contain the value of the measurement, e.g. {"name":"Git"}, {"version":"1.8", "vendor":"OpenJdk"}

getMetrics

protected java.util.Set<MetricEvent> getMetrics(Project project)

If you need to perform long blocking operations with Read lock or on EDT, consider using getMetrics(Project, ProgressIndicator) along with ReadAction#nonBlocking if needed, or override requiresReadAccess() method to wrap metrics gathering with non-blocking read action automatically.

requiresReadAccess

protected boolean requiresReadAccess()

Returns:

true if collector should be run under read access. The clients of such collectors have to wrap invocation thisgetMetrics(Project) with non-blocking read-action ReadAction.nonBlocking(Runnable)

getUsages

@Deprecated
public java.util.Set<UsageDescriptor> getUsages(Project project)

Deprecated. use getMetrics(Project, ProgressIndicator)

getData

public FeatureUsageData getData(Project project)