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

Class FUCounterUsageLogger

java.lang.Object

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

public class FUCounterUsageLogger
extends java.lang.Object

Use it to record IDE events e.g. invoked action, opened dialog.

To implement a new collector:

1. Record events with logEvent(Project, String, String), logEvent(Project, String, String, FeatureUsageData), logEvent(String, String) or logEvent(String, String, FeatureUsageData);
2. Register collector in plugin.xml as <statistics.counterUsagesCollector groupId="ID" version="1"/>;
3. Specify collectors data scheme and implement custom validation rules if necessary.
   For more information see SensitiveDataValidator;
4. 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

See Also:

ApplicationUsagesCollector, ProjectUsagesCollector

Constructor Summary

Constructors

Constructor and Description
FUCounterUsageLogger()

Method Summary

Modifier and Type	Method and Description
static FUCounterUsageLogger	getInstance()
void	logEvent(Project project, java.lang.String groupId, java.lang.String eventId) Records new project-wide event without context.
void	logEvent(Project project, java.lang.String groupId, java.lang.String eventId, FeatureUsageData data) Records new project-wide event with context.
void	logEvent(java.lang.String groupId, java.lang.String eventId) Records new application-wide event without context.
void	logEvent(java.lang.String groupId, java.lang.String eventId, FeatureUsageData data) Records new application-wide event with context information.
void	logRegisteredGroups()
void	register(FeatureUsageGroup group) Deprecated. Don't call this method directly, register counter group in XML as

Methods inherited from class java.lang.Object

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

Constructor Detail

FUCounterUsageLogger

public FUCounterUsageLogger()

Method Detail

getInstance

public static FUCounterUsageLogger getInstance()

register

@Deprecated
public void register(FeatureUsageGroup group)

Deprecated. Don't call this method directly, register counter group in XML as

logRegisteredGroups

public void logRegisteredGroups()

logEvent

public void logEvent(Project project,
                     java.lang.String groupId,
                     java.lang.String eventId)

Records new project-wide event without context.

For events with context use logEvent(Project, String, String, FeatureUsageData), useful to report structured events.

Example:
"eventId": "tooltip.shown"

Parameters:

project - shows in which project event was invoked, useful to separate events from two simultaneously opened projects.

groupId - is used to simplify access to events, e.g. 'dialogs', 'intentions'.

eventId - should be a verb because it shows which action happened, e.g. 'dialog.shown', 'project.opened'.

See Also:

logEvent(Project, String, String, FeatureUsageData)

logEvent

public void logEvent(Project project,
                     java.lang.String groupId,
                     java.lang.String eventId,
                     FeatureUsageData data)

Records new project-wide event with context.

Example:
"eventId": "action.called"
"data": {"id":"ShowIntentionsAction", "input_event":"Alt+Enter"}

Parameters:

project - shows in which project event was invoked, useful to separate events from two simultaneously opened projects.

groupId - is used to simplify access to events, e.g. 'dialogs', 'intentions'.

eventId - should be a verb because it shows which action happened, e.g. 'dialog.shown', 'project.opened'.

data - information about event context or related "items", e.g. "input_event":"Alt+Enter", "place":"MainMenu".

logEvent

public void logEvent(java.lang.String groupId,
                     java.lang.String eventId)

Records new application-wide event without context.

For events with context use logEvent(String, String, FeatureUsageData), useful to report structured events.
For project-wide events use logEvent(Project, String, String), useful to separate events from two simultaneously opened projects.

Example:
"eventId": "hector.clicked"

Parameters:

groupId - is used to simplify access to events, e.g. 'dialogs', 'intentions'.

eventId - should be a verb because it shows which action happened, e.g. 'dialog.shown', 'project.opened'.

See Also:

logEvent(String, String, FeatureUsageData), logEvent(Project, String, String, FeatureUsageData)

logEvent

public void logEvent(java.lang.String groupId,
                     java.lang.String eventId,
                     FeatureUsageData data)

Records new application-wide event with context information.

For project-wide events use logEvent(Project, String, String, FeatureUsageData), useful to separate events from two simultaneously opened projects.

Example:
"eventId": "ide.started"
"data": {"eap":true, "internal":false}

Parameters:

groupId - is used to simplify access to events, e.g. 'dialogs', 'intentions'.

eventId - should be a verb because it shows which action happened, e.g. 'dialog.shown', 'project.opened'.

data - information about event context or related "items", e.g. "input_event":"Alt+Enter", "place":"MainMenu".

See Also:

logEvent(Project, String, String, FeatureUsageData)