MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

FUS: update doc comments for collectors (IDEA-243852)

Browse Source 
GitOrigin-RevId: 4538006389e1f5aaf735f24e1705c5042288e21d
This commit is contained in:
Svetlana.Zemlyanskaya
2020-06-18 19:45:25 +03:00
committed by intellij-monorepo-bot
parent a32862d5ed
commit f48f0f2d45
3 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/statistics/src/com/intellij/internal/statistic/service/fus/collectors/ApplicationUsagesCollector.java
+4 -3
View File
@@ -20,18 +20,19 @@ import java.util.Set;
* <li>Inherit the class, implement {@link ApplicationUsagesCollector#getMetrics()} and register collector in plugin.xml;</li>
* <li>Specify collectors data scheme and implement custom validation rules if necessary.<br/>
* For more information see {@link SensitiveDataValidator};</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> to add group, its data scheme and description to the whitelist;</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> with group data scheme and descriptions
* to register it on the server in statistic metadata repository</li>
* </ol>
*
* To test collector:
* <ol>
* <li>
* If group is not whitelisted, add it to local whitelist with "Add Test Group to Local Whitelist" action.<br/>
* If group is not registered on the server, add it to events test scheme with "Add Group to Events Test Scheme" action.<br/>
* {@link com.intellij.internal.statistic.actions.scheme.AddGroupToTestSchemeAction}
* </li>
* <li>
* Open toolwindow with event logs with "Show Statistics Event Log" action.<br/>
* {@link com.intellij.internal.statistic.actions.ShowStatisticsEventLogAction}
* {@link com.intellij.internal.statistic.actions.OpenEventLogFileAction}
* </li>
* <li>
* Record all state collectors with "Record State Collectors to Event Log" action.<br/>
platform/statistics/src/com/intellij/internal/statistic/service/fus/collectors/FUCounterUsageLogger.java
+5 -4
View File
@@ -39,18 +39,19 @@ import java.util.concurrent.TimeUnit;
* <li>Register collector in plugin.xml as {@code <statistics.counterUsagesCollector groupId="ID" version="1"/>};</li>
* <li>Specify collectors data scheme and implement custom validation rules if necessary.<br/>
* For more information see {@link SensitiveDataValidator};</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> to add group, its data scheme and description to the whitelist;</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> with group data scheme and descriptions
* to register it on the server in statistic metadata repository</li>
* </ol>
*
* To test collector:
* <ol>
* <li>
* If group is not whitelisted, add it to local whitelist with "Add Test Group to Local Whitelist" action.<br/>
* {@link com.intellij.internal.statistic.actions.localWhitelist.AddTestGroupToLocalWhitelistAction}
* If group is not registered on the server, add it to events test scheme with "Add Group to Events Test Scheme" action.<br/>
* {@link com.intellij.internal.statistic.actions.scheme.AddGroupToTestSchemeAction}
* </li>
* <li>
* Open toolwindow with event logs with "Show Statistics Event Log" action.<br/>
* {@link com.intellij.internal.statistic.actions.ShowStatisticsEventLogAction}
* {@link com.intellij.internal.statistic.actions.OpenEventLogFileAction}
* </li>
* </ol>
*
platform/statistics/src/com/intellij/internal/statistic/service/fus/collectors/ProjectUsagesCollector.java
+4 -3
View File
@@ -26,18 +26,19 @@ import java.util.Set;
* <li>Inherit the class, implement {@link ProjectUsagesCollector#getMetrics(Project)} and register collector in plugin.xml;</li>
* <li>Specify collectors data scheme and implement custom validation rules if necessary.<br/>
* For more information see {@link SensitiveDataValidator};</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> to add group, its data scheme and description to the whitelist;</li>
* <li>Create an <a href="https://youtrack.jetbrains.com/issues/FUS">issue</a> with group data scheme and descriptions
* to register it on the server in statistic metadata repository</li>
* </ol>
*
* To test collector:
* <ol>
* <li>
* If group is not whitelisted, add it to local whitelist with "Add Test Group to Local Whitelist" action.<br/>
* If group is not registered on the server, add it to events test scheme with "Add Group to Events Test Scheme" action.<br/>
* {@link com.intellij.internal.statistic.actions.scheme.AddGroupToTestSchemeAction}
* </li>
* <li>
* Open toolwindow with event logs with "Show Statistics Event Log" action.<br/>
* {@link com.intellij.internal.statistic.actions.ShowStatisticsEventLogAction}
* {@link com.intellij.internal.statistic.actions.OpenEventLogFileAction}
* </li>
* <li>
* Record all state collectors with "Record State Collectors to Event Log" action.<br/>