NetBeans Architecture Answers for UI Gestures Collector Infrastructure module

WARNING: answering questions version 1.28 rather than the current 1.29.

Interfaces table

Group of logger interfaces
Interface NameIn/OutStabilitySpecified in What Document?
UI-Actions-org.openide.awtImportedFriend

which log info about invoked actions

UI-Actions-org.openide.windowsImportedFriend

which log info about invoked actions by keystrokes

UI_LOGGER_NAMEExportedUnder Development

The info about various UI events in the system is collected thru listening on
log records send to Logger.getLogger(UI_LOGGER_NAME_VALUE) , where UI_LOGGER_NAME_VALUE is a value of UI_LOGGER_NAME resource bundle key, defining the name of the UI usage logger. Any code in the system can get instance of this logger or any child logger and send useful informations to it. At the end of the session the last few hundereds events is taken and displayed to the user for further processing.

METRICS_LOGGER_NAMEExportedUnder Development

The info about various UI events in the system is collected thru listening on
log records send to Logger.getLogger(METRICS_LOGGER_NAME_VALUE) , where METRICS_LOGGER_NAME_VALUE is a value of METRICS_LOGGER_NAME resource bundle key, defining the name of the metrics logger. Any code in the system can get instance of this logger or any child logger and send useful informations to it. At the end of the session the last few hundereds events is taken and displayed to the user for further processing.

MSG_USER_CONFIGURATIONExportedUnder Development

Before the results are submitted one more LogRecord is added. This LogRecord message is set to MSG_USER_CONFIGURATION . Four upto six parameters are added. Four common parameters are added always before sending logger info and two error parameters are added only if an exception rised.
  • Operating system name, version and architecture
  • Virtual machine name and version
  • Application version and build number
  • User name
  • Error summary
  • User's comment to an error situation

Group of property interfaces
Interface NameIn/OutStabilitySpecified in What Document?
WELCOME_URLExportedPrivate

There is a key in the org.netbeans.modules.uihandler.Bundle that specifies the location of the page on a server one shall query and display to the user when the module is about the submit usage data for analysis.

METRICS_URLExportedPrivate

There is a key in the org.netbeans.modules.uihandler.Bundle that specifies the location of the page on a server one shall query and display to the user when the module is about the submit metrics data for analysis.

ERROR_URLExportedPrivate

There is a key in the org.netbeans.modules.uihandler.Bundle that specifies the location of the page on a server one shall query and display to the user when the module is about the submit an error report.

ICON_BASEExportedUnder Development

there is an extension to the regular formatting done by the
logging formatter that, in order to achieve nicer appearance to the user, allows each record to be associated with an icon. Just define MSG_KEY_ICON_BASE in the bundle associated with the LogRecord (where the MSG_KEY is the string returned by record.getMessage()) and the value is then going to be used for the Node representing the UI gesture.

REGISTRATION_URLExportedPrivate

There is a key in the org.netbeans.modules.exceptions.Bundle that specifies the location of the page on a server. This page should be display to the user when he uses a "register here" link on ReportPanel.

Group of java.io.File interfaces
Interface NameIn/OutStabilitySpecified in What Document?
WelcomePageContentExportedFriend

The page pointed by WELCOME_URL can contain any XHTML text, but it also should contain a <form/> tag that defines <input type="hidden" name="submit" value="localizedName"/>. The localizedName is then going to be used for a button for the dialog displaying the summary. When this button is invoked, the "action" URL is then feed with data from the UI logs. The server is then supposed to process the data, create some analytics pages and return them back to the client. If the returned page contains tag like <meta http-equiv='Refresh' content='3; URL=somepage'> an (external) browser is opened with the specified URL and the user can then interact directly with the server, thru pages it serves.

var-log-uigesturesExportedPrivate

The module stores its loggging information in $userdir/var/log/uigestures and $userdir/var/log/uigestures.1 files. There are written whenever a UI action happens and read when the data are send to server. Each of these files is supposed to contain at most 1000 of actions

Group of systemproperty interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.netbeans.modules.uihandler.SubmitExportedPrivate

For testing purposes one can specify different URL for upload of files, by setting org.netbeans.modules.uihandler.Submit property when invoking NetBeans.

nb.show.statistics.uiExportedPrivate

System property "nb.show.statistics.ui" controls if UI for Usage statistics is displayed in General panel. If this property is non null (for IDE) UI is shown. This property contains key of preference used to save status - true if usage statistics are collected and uploaded, false if not. Key is "usageStatisticsEnabled" and is described below.

Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?
CallbackInterfacesExportedUnder Development .../modules/uihandler/api/Activated.html

interfaces from the API of this module

org.jdesktop.layoutImportedPrivate

jdesktop layout is used to make the dialog provided by this module to look better

org.openide.explorerImportedPrivate .../overview-summary.html

The module uses explorer view to present the results before they get submitted to the analysis server.

uihandler-hooksImportedFriend

This module makes on of its Handler implement Callable<JButton> which is a signal for core providing the exception dialog to include such a JButton in its list of options. That way this module can enhance the dialog with "Report..." button.

Group of preferences interfaces
Interface NameIn/OutStabilitySpecified in What Document?
org.netbeans.modules.autoupdate.ideIdentityImportedFriend

This module shares the identity with autoupdate and reads it from its preferences node.

org.netbeans.modules.uihandler.autoautoSubmitWhenFullExportedUnder Development

This property allows other parts of the system to turn on/off the automatic submission of log files to the server. This can be used for example by installer to query the user and on his confirmation create config/Preferences/org/netbeans/modules/uihandler.properties file in user dir or in nbX.Y cluster with one line saying: autoSubmitWhenFull=true. This works since version 1.30 of this module.

org.netbeans.core.usageStatisticsEnabledImportedPrivate

Key "usageStatisticsEnabled" is read and controls if metrics logging is enabled or disabled. Installer has also similar UI to set this and stores it into NetBeans install dir nb/config/Preferences/org/netbeans/core.properties


General Information


Project and platform dependencies


Deployment


Compatibility with environment


Access to resources


Lookup of components


Execution Environment


Format of files and protocols


Performance and Scalability


Built on October 18 2017.  |  Portions Copyright 1997-2017 Oracle. All rights reserved.