Supported Bean: DiagnosticsBean
Title: DiagnosticsBean. This bean provides the methods required for displaying and modifying information related with the log processing and handling on the application.
Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanDiagnostics (62)
Events
| loadDefaults | ||||
| Identifier for the event that allows users to load the default values of the diagnostics configuration. |
62005 | |||
| navigateDiagnostics | ||||
| Identifier for the event that allows users to navigate between the different pages (incremental fetch) of the diagnostic logs. |
62003 | |||
|
pageNo | Identifier of the argument that indicates the page number (incremental fetch) of log contents to show to the user. |
62012 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsPageNumber |
|
| saveDiagnostics | ||||
| Identifier for the event that allows users to save diagnostics configuration. |
62001 | |||
|
advLogger | Identifier of the argument that specifies the advanced logger.
The possible values are: - AdminServersHelper.PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_DISABLED - AdminServersHelper.PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_XMLAPI - AdminServersHelper.PROPERTY_VALUE_STATISTICS_ADVANCED_LOGGER_OTHER |
62021 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLogger |
|
|
advLogLevel | Identifier of the argument that specifies the level of the advanced logger. |
62020 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLoggerLevel |
|
|
advLogPackage | Identifier of the argument that specifies the package of the advanced logger. |
62017 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLoggerPackage |
|
|
advLogPattern | Identifier of the argument that specifies the pattern of the advanced logger. |
62018 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLoggerPattern |
|
|
advLogUser | Identifier of the argument that specifies the user of the advanced logger. |
62016 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLoggerUser |
|
|
advLogXMLAPIUser | Identifier of the argument that specifies the formatter of the advanced logger. |
62019 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsAdvancedLoggerXMLAPIUser |
|
|
diagCount | Identifier of the argument that specifies the number of file outputs |
62022 | ||
|
diagLevel | Identifier of the argument that indicates the level of diagnostics to be recorded on the log files.
Usage: Possible values for this argument are the names of the different levels such as Level.OFF, Level.SEVERE, etc. |
62002 | ||
|
diagLimit | Identifier of the argument that specifies the maximum output file size |
62023 | ||
|
diagType | Identifier of the argument that indicates the type of diagnostics configuration being viewed.
Usage: The different values that can be assigned to this argument include those defined on the DiagnosticsBean enumeration, such as
DiagnosticsBean.DIAGNOSTICS_TYPE_DEFAULT,
DiagnosticsBean.DIAGNOSTICS_TYPE_CUSTOM, etc. |
62001 | ||
|
flashProfiler | Identifier of the argument that specifies whether to Profile Analysis and Documents in Flash Mode. Used for debugging. |
62024 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsFlashProfiler |
|
|
logFolder | Identifier of the argument that specifies the path where the log files are to be saved.
Usage: The path indicated here has to be a full, valid one, for it to be considered as log file directory. |
62003 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsLogFile |
|
|
setupFile | Identifier of the argument that specifies the location of a custom log configuration file. |
62004 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsSetupFile |
|
|
statisticsFile | Identifier of the argument that specifies the path where the statistics file is to be saved. |
62015 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsStatisticsFile |
|
|
statisticsMode | Identifier of the argument that specifies the mode to use in the statistics recording.
Usage: Possible values for this argument include those defined on the StatsHandlerSupport interface, such
as StatsHandlerSupport.LOG_MODE_FILE, StatsHandlerSupport.LOG_MODE_SCREEN, etc. |
62014 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsStatisticsMode |
|
| showDiagnostics | ||||
| Identifier for the event that allows users to view the contents of the diagnostic logs. |
62002 | |||
|
fromDay | Identifier of the argument that indicates the starting day from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date from where the log files will start being analyzed. |
62006 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsFromDay |
|
|
fromMonth | Identifier of the argument that indicates the starting month from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date from where the log files will start being analyzed. |
62007 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsFromMonth |
|
|
fromYear | Identifier of the argument that indicates the starting year from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date from where the log files will start being analyzed. |
62008 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsFromYear |
|
|
showFlag | Identifier of the argument that specifies the level of log information to display to the user.
Usage: The level specified here depends on the level of detail the log files have recorded (specified on the EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsLevel of
each one of the files to show).
Possible values for this argument include
DiagnosticsBean.LOCAL_SHOW_ERRORS,
DiagnosticsBean.LOCAL_SHOW_WARNINGS, etc. |
62005 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsDisplay |
|
|
toDay | Identifier of the argument that indicates the ending day from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date where the log files will end being analyzed. |
62009 | ||
|
toMonth | Identifier of the argument that indicates the ending month from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date where the log files will end being analyzed. |
62010 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsToMonth |
|
|
toYear | Identifier of the argument that indicates the ending year from where log file contents will be retrieved.
Usage: The value of this argument will be used for building up the full date where the log files will end being analyzed. |
62011 | ||
| sort | ||||
| Identifier for the event that allows users to sort the contents of the diagnostic logs viewed. |
62004 | |||
|
sort | Identifier of the argument that indicates how the log file contents will be sorted.
Usage: Currently only sorting based on one key is supported. Values to specify for this argument include DiagnosticsBean.SORT_BY_TIMESTAMP_DESCENDING,
DiagnosticsBean.SORT_BY_TIMESTAMP_ASCENDING,
DiagnosticsBean.SORT_BY_USER_NAME_DESCENDING, etc. |
62013 |
EnumDiagnosticsBeanEvents.WebEventArgumentDiagnosticsSortOrder |
|
Notes
* denotes required field.