Lines 111-123
Link Here
|
111 |
</p> |
111 |
</p> |
112 |
|
112 |
|
113 |
<p> |
113 |
<p> |
114 |
<api name="org.netbeans.ui" group="logger" category="devel" type="export"> |
114 |
<api name="UI_LOGGER_NAME" group="logger" category="devel" type="export"> |
115 |
The info about various UI events in the system is collected thru |
115 |
The info about various UI events in the system is collected thru |
116 |
listening on |
116 |
listening on |
117 |
<a href="@JDK@/java/util/logging/LogRecord.html">log records</a> send to |
117 |
<a href="@JDK@/java/util/logging/LogRecord.html">log records</a> send to |
118 |
<a href="@JDK@/java/util/logging/Logger.html"> |
118 |
<a href="@JDK@/java/util/logging/Logger.html"> |
119 |
Logger.getLogger("org.netbeans.ui") |
119 |
Logger.getLogger(UI_LOGGER_NAME_VALUE) |
120 |
</a>. Any code in the system can get instance of this logger |
120 |
</a>, where UI_LOGGER_NAME_VALUE is a value of UI_LOGGER_NAME |
|
|
121 |
resource bundle key, defining the name of the UI usage logger. |
122 |
Any code in the system can get instance of this logger |
123 |
or any child logger and send useful informations to it. |
124 |
At the end of the session the last few hundereds events |
125 |
is taken and displayed to the user for further processing. |
126 |
</api> |
127 |
<api name="METRICS_LOGGER_NAME" group="logger" category="devel" type="export"> |
128 |
The info about various UI events in the system is collected thru |
129 |
listening on |
130 |
<a href="@JDK@/java/util/logging/LogRecord.html">log records</a> send to |
131 |
<a href="@JDK@/java/util/logging/Logger.html"> |
132 |
Logger.getLogger(METRICS_LOGGER_NAME_VALUE) |
133 |
</a>, where METRICS_LOGGER_NAME_VALUE is a value of |
134 |
METRICS_LOGGER_NAME resource bundle key, defining the name |
135 |
of the metrics logger. |
136 |
Any code in the system can get instance of this logger |
121 |
or any child logger and send useful informations to it. |
137 |
or any child logger and send useful informations to it. |
122 |
At the end of the session the last few hundereds events |
138 |
At the end of the session the last few hundereds events |
123 |
is taken and displayed to the user for further processing. |
139 |
is taken and displayed to the user for further processing. |
Lines 139-145
Link Here
|
139 |
There is a key in the <code>org.netbeans.modules.uihandler.Bundle</code> |
155 |
There is a key in the <code>org.netbeans.modules.uihandler.Bundle</code> |
140 |
that specifies the location of the page on a server one shall |
156 |
that specifies the location of the page on a server one shall |
141 |
query and display to the user when the module is about the |
157 |
query and display to the user when the module is about the |
142 |
submit data for analysis. |
158 |
submit usage data for analysis. |
|
|
159 |
</api> |
160 |
<api name="METRICS_URL" group="property" category="private" type="export"> |
161 |
There is a key in the <code>org.netbeans.modules.uihandler.Bundle</code> |
162 |
that specifies the location of the page on a server one shall |
163 |
query and display to the user when the module is about the |
164 |
submit metrics data for analysis. |
165 |
</api> |
166 |
<api name="ERROR_URL" group="property" category="private" type="export"> |
167 |
There is a key in the <code>org.netbeans.modules.uihandler.Bundle</code> |
168 |
that specifies the location of the page on a server one shall |
169 |
query and display to the user when the module is about the |
170 |
submit an error report. |
143 |
</api> |
171 |
</api> |
144 |
<api name="WelcomePageContent" group="java.io.File" category="friend" type="export"> |
172 |
<api name="WelcomePageContent" group="java.io.File" category="friend" type="export"> |
145 |
The page pointed by <code>WELCOME_URL</code> can contain |
173 |
The page pointed by <code>WELCOME_URL</code> can contain |
Lines 177-185
Link Here
|
177 |
<p> |
205 |
<p> |
178 |
To feed own data about special UI gestures one can just create own |
206 |
To feed own data about special UI gestures one can just create own |
179 |
<a href="@JDK@/java/util/logging/Logger.html"> |
207 |
<a href="@JDK@/java/util/logging/Logger.html"> |
180 |
Logger.getLogger("org.netbeans.ui.ownname") |
208 |
Logger.getLogger(UI_LOGGER_NAME_VALUE+".ownname") |
181 |
</a> and send own log records to it. The format of the log |
209 |
</a> and send own log records to it. |
182 |
messages shall follow the one described by the |
210 |
UI_LOGGER_NAME_VALUE is a value of UI_LOGGER_NAME |
|
|
211 |
resource bundle key, defining the name of the logger. |
212 |
The format of the log messages shall follow the one described by the |
183 |
<a href="@org-openide-util@/org/openide/util/doc-files/logging.html"> |
213 |
<a href="@org-openide-util@/org/openide/util/doc-files/logging.html"> |
184 |
structured logging |
214 |
structured logging |
185 |
</a> document, e.g. the |
215 |
</a> document, e.g. the |
Lines 293-301
Link Here
|
293 |
</question> |
323 |
</question> |
294 |
--> |
324 |
--> |
295 |
<answer id="compat-i18n"> |
325 |
<answer id="compat-i18n"> |
296 |
<p> |
326 |
There are several resource bundle keys related to branding. |
297 |
XXX no answer for compat-i18n |
327 |
These are: |
298 |
</p> |
328 |
<ul> |
|
|
329 |
<li> |
330 |
<code>userNameURL</code> - The URL used to report Exception |
331 |
reporter results, the user name is appended to the URL. |
332 |
</li> |
333 |
<li> |
334 |
<code>userIdURL</code> - The URL used to report by user identity, |
335 |
when user name is not defined. The user identity is appended |
336 |
to the URL. |
337 |
</li> |
338 |
<li> |
339 |
<code>ReportPanel.loginField.AccessibleContext.accessibleName</code> - |
340 |
The accessible name of the application's user name field |
341 |
</li> |
342 |
<li> |
343 |
<code>ReportPanel.loginField.AccessibleContext.accessibleDescription</code> - |
344 |
The accessible description of the application's user name field |
345 |
</li> |
346 |
<li> |
347 |
<code>REGISTRATION_URL</code> - The URL to register a new user |
348 |
</li> |
349 |
<li> |
350 |
<code>ReportPanel.jLabel11.text</code> - A label next to the |
351 |
application's user name field |
352 |
</li> |
353 |
<li> |
354 |
<code>ReportPanel.jPasswordField1.AccessibleContext.accessibleDescription</code> - |
355 |
The accessible description of the application's user password field |
356 |
</li> |
357 |
<li> |
358 |
<code>no_data_found</code> - Description text about |
359 |
a connection problem. |
360 |
</li> |
361 |
<li> |
362 |
<code>METRICS_LOGGER_NAME</code> - The logger name of metrics |
363 |
logging. |
364 |
</li> |
365 |
<li> |
366 |
<code>UI_LOGGER_NAME</code> - The logger name of UI usages |
367 |
logging. |
368 |
</li> |
369 |
<li> |
370 |
<code>UI_PERFORMANCE_LOGGER_NAME</code> - The logger name |
371 |
of performance-related logging. |
372 |
</li> |
373 |
<li> |
374 |
<code>UI_USER_CONFIGURATION</code> - Text of a configuration |
375 |
log message. Following three keys are used to provide the |
376 |
application version: |
377 |
<ul> |
378 |
<li> |
379 |
<code>ApplicationVersionResourceBundle</code> - |
380 |
A resource bundle the application version is read from |
381 |
</li> |
382 |
<li> |
383 |
<code>ApplicationVersionResourceKey</code> - |
384 |
A key with the application version number |
385 |
</li> |
386 |
<li> |
387 |
<code>ApplicationVersionSysPropertyResourceArg</code> - |
388 |
A system property, that is used as an argument to the |
389 |
application version number key |
390 |
</li> |
391 |
</ul> |
392 |
</li> |
393 |
<li> |
394 |
<code>WELCOME_URL</code> - The URL with the welcome text |
395 |
</li> |
396 |
<li> |
397 |
<code>METRICS_URL</code> - The URL to upload metrics logs to |
398 |
</li> |
399 |
<li> |
400 |
<code>ERROR_URL</code> - The URL to upload errors to |
401 |
</li> |
402 |
<li> |
403 |
<code>CHECKING_SERVER_URL</code> - The URL to authenticate |
404 |
the user with password |
405 |
</li> |
406 |
<li> |
407 |
<code>LOG_FILE</code> - The application's log file relative |
408 |
to the user directory |
409 |
</li> |
410 |
<li> |
411 |
<code>MSG_ConnetionFailedReport</code> - This message is |
412 |
displayed when connection to the server fails. |
413 |
</li> |
414 |
<li> |
415 |
<code>LBL_BottomText1</code>, <code>LBL_BottomText2</code>, |
416 |
<code>LBL_BottomText3</code> - Text displayed on the usage |
417 |
statistics dialog. |
418 |
</li> |
419 |
<li> |
420 |
<code>METRICS_INFO_URL</code> - This URL is displayed in |
421 |
a browser to provide more information about the metrics |
422 |
usage tracking. |
423 |
</li> |
424 |
</ul> |
299 |
</answer> |
425 |
</answer> |
300 |
|
426 |
|
301 |
|
427 |
|
Lines 491-497
Link Here
|
491 |
and registering <a href="@TOP@/org/netbeans/modules/uihandler/api/Deactivated.html">callback interfaces</a> |
617 |
and registering <a href="@TOP@/org/netbeans/modules/uihandler/api/Deactivated.html">callback interfaces</a> |
492 |
provided by its API. Or the modules do not need to depend on this module at all, |
618 |
provided by its API. Or the modules do not need to depend on this module at all, |
493 |
and just generate <a href="@JDK@/java/util/logging/LogRecord.html">log records</a> |
619 |
and just generate <a href="@JDK@/java/util/logging/LogRecord.html">log records</a> |
494 |
to the <code>org.netbeans.ui.someloggername</code> log. These records are |
620 |
to the <code>UI_LOGGER_NAME_VALUE+".someloggername"</code> logger. These records are |
495 |
then going to be consumed by this module, if enabled. |
621 |
then going to be consumed by this module, if enabled. |
496 |
</p> |
622 |
</p> |
497 |
</answer> |
623 |
</answer> |
Lines 716-722
Link Here
|
716 |
--> |
842 |
--> |
717 |
<answer id="exec-property"> |
843 |
<answer id="exec-property"> |
718 |
<p> |
844 |
<p> |
719 |
<api name="org.netbeans.ui.MSG_USER_CONFIGURATION" group="logger" category="devel" type="export"> |
845 |
<api name="MSG_USER_CONFIGURATION" group="logger" category="devel" type="export"> |
720 |
Before the results are submitted one more LogRecord is added. This LogRecord message is |
846 |
Before the results are submitted one more LogRecord is added. This LogRecord message is |
721 |
set to <code>MSG_USER_CONFIGURATION</code> . Four upto six parameters are added. |
847 |
set to <code>MSG_USER_CONFIGURATION</code> . Four upto six parameters are added. |
722 |
Four common parameters are added always before sending logger info and two error |
848 |
Four common parameters are added always before sending logger info and two error |
Lines 725-731
Link Here
|
725 |
<ul title="common parameters"> |
851 |
<ul title="common parameters"> |
726 |
<li>Operating system name, version and architecture</li> |
852 |
<li>Operating system name, version and architecture</li> |
727 |
<li>Virtual machine name and version</li> |
853 |
<li>Virtual machine name and version</li> |
728 |
<li>NetBeans version and build number</li> |
854 |
<li>Application version and build number</li> |
729 |
<li>User name</li> |
855 |
<li>User name</li> |
730 |
</ul> |
856 |
</ul> |
731 |
<ul title="error parameters"> |
857 |
<ul title="error parameters"> |