|
|
Right Java tools for J2EE, Web Service, Grid and more |
| |Home | Products | Documents | Downloads | Purchase | Support | Company | Partners | Contact | |
Attribute: Displays the Attribute Panel.
Register: Displays the Register Class Panel.
Scope: Displays the Scope Panel.
Reset Library: Displays the Reset Library Panel.
Tail: Displays the Tail Panel.
Parameter
Alarm Email: Displays the Alarm email list panel.
Run Example: Runs the example which comes with SuperLogging.
About: Displays version number and license information.
This panel shows the list of alarm email items. This is a summary panel.
Add: Adds a new Alarm Email entry.
Edit: Edits the highlighted Alarm Email entry.
Delete: Deletes the highlighted Alarm Email entry.
Test: Tests the highlighted Alarm Email entry. The test ignore Interval.
Alert Email: Displays Alert Email Panel for you to specify alert email and mail box information.
Close: Closes this panel.
There is a default entry. Its subject is !default. You should specify its email address. Do not delete it. See Alarm Email for details.
When an alarm is called, the system uses its subject to find its corresponding email address and sends a notification email. If the subject does not have a corresponding entry, the default entry will be used. The default entry is identified by subject !default.
Alert email parameters must be set before Alarm email can be used.
This Panel allows you to specify alarm emails.
Subject: The subject of the alarm email entry.
Address: The To address, the alarm email will send to this email address.
Interval: Alarm interval in minutes. See Alarm Email for more information.
This Panel allows you to specify alert emails.
PostMaster: PostMaster's email address. When alert messages are sent out, the SuperLogging uses this address as the From address. If an alert email can not go through, your email server will notify this email address. If this address is not set, the request for the alert email will be ignored.
To: It is the recipient's email addresses as the "To" address . This is the email address for sending an alert message to. It can be more than one email address, separated by commas. If this email address is not set, the request for the alert email will be ignored.
Alert interval: The minimum interval between two alert messages in minutes. When SuperLogging sends an alert message, it waits for this interval before accepting other alert request. All alert requests in this interval period will be ignored.
Note: when you get an alert email, it is the first alert email in that interval. There may be more. So you need to check your system thoroughly.
Mail host: The machine name of your mail server or outgoing mail (SMTP). If you are not sure of the name of your mail server, ask your system administrator.
Email server requires authentication: Check it if your email server requires authentication.
Mail host user name: The user name for your email server. This is visible if Email server requires authentication is checked.
Mail host password: The password for your email server. This is visible if Email server requires authentication is checked. When you key in password, the password will not show literally. When you open this panel again, the password will not show: SuperLogging does not download the password for client for security reasons.
Test Alert: Sends a test message to alert recipients. The test ignores Alert interval. Note: It is a test only. The parameters take effect one time only and will not be saved.
Save: Saves all parameters to the log database.
See Alert Email for more information
See Generic email aliases are recommended for related information.
Attribute panel allows you to configure SuperLogging. See Attribute for more information.
Mode: The mode of SuperLogging. There are three logging modes available:
Threshold: The log threshold. If the request level (the level given by a log statement) is lower than this log threshold, no message will be recorded in Conditional mode. The displayed text values are alias names for some int values. These alias names are suggested by Java:
- Conditional: logs message if the class or file is registered and log level is equal or greater than the threshold.
- Quiet: does not log out anything unconditionally.
- Verbose: logs everything unconditionally.
SEVERE = 1000; //something will prevent normal program execution.It can be any int value. You can input any number, but you can not define new alias.
WARNING = 900; //something has potential problems.
INFO = 800; //for significant messages.
CONFIG = 700; //for config information in debugging.
FINE = 500; //for information such as recoverable failures.
FINER = 400; //for information about entering or returning a method, or throwing an exception.
FINEST = 300; //for detail tracing information.
Log device: The device to write log messages by calling log method log(), such as com.acelet.logging.Logging.log().
Error device: The device to write log messages by calling log method error(), such as com.acelet.logging.Logging.error().
Note: STDOUT and STDERR are convenient for development. If you choose DATABASE (recommended), you do not need STDOUT, nor STDERR: they may slow down your application.
This panel allows you to specify new parameters for SuperLoggingEJB and SuperLoggingLibrary. Parameters can not dynamically reconfigured. The saved new jar files need to be deployed.
Driver: The log database driver name. The class or jar file must be accessible by SuperLoggingLibrary and SuperLoggingEJB.
URL: The log database URL.
User: The log database user name.
Password: The password for the log database User.
Query timeout: The time out for each access to the log database. The unit is one second. The value should be greater than 0. If you do not specify a value, the value will be zero, which means "no time out". Zero timeout is not recommended: when something is wrong, a call to the log database should return promptly, so SuperLogging can send alert email to administrators.
Save EJB jar as: Saves new parameters as a part of EJB jar file. A JFileChooser window will appear allowing you to specify the name of the new jar.
Save library jar as: Saves new parameters as a part of library jar file. A JFileChooser window will appear allowing you to specify the name of the new jar.
Save EJB with library jar as: Saves new parameters as a part of a jar which contains EJB and library. A JFileChooser window will appear allowing you to specify the name of the new jar.
This panel allows you to specify WHERE clause for selecting wanted records.
Where clause: The WHERE clause. This is an additional clause based on the algorithm of Tail.
The changes on this panel take effect on the next tail operation.
This panel allows you to specify log database parameters. SuperLogging server side library uses these parameters to connect to the log database.
This is an administrator tool. Do not change those parameters unless it is absolutely necessary. If you do need to change those parameters, please work with your database administrator to set these parameters.
Note: If you change it to different database, you need to put the new driver file on the CLASSPATH when you start you application server.
Driver: The log database driver name. The class or jar file must be on the CLASSPATH of your J2EE server.
URL: The log database URL.
User: The log database user name. If you use default database, do not change User. If you use other database than the default database, the User is assigned by your database administrator. You can not create a new user from this panel.
Password: The password for the log database User. This is the password associated with User already set in the log database. You can not create new password from this panel. When you key in password, the password will not show literally. When you open this panel again, the password will not show: SuperLogging does not download the password for client for security reasons.
Query timeout: The time out for each access to the log database. The unit is one second. The value should be greater than 0. If you do not specify a value, the value will be zero, which means "no time out". Zero timeout is not recommended: when something is wrong, a call to the log database should return promptly, so SuperLogging can send alert email to administrators.
Save: Saves parameters on the server side, so when the server restarts, or SuperLoggingLibrary resets, SuperLogging will connect the log database using new parameters.
Note 1: New log database parameters will be saved to this local installation only. The "local installation" is the instance of your application server on your local physical machine. If there are multi-servers, you need to do so for each server installation on each machine. If your remote server does not provide GUI environment, you can copy the parameter file to your destinations. The parameter file is saved under library installation directory as com/acelet/logging/logDatabaseParameters. For example, d:\bea81\weblogic81\acelet\logging\logDatabaseParameters.
Note 2: Super (the client) does not get the password from the server side for security reasons. You need to key in it manually. When you input password, it does not show literally. When you save it, it will be saved as plain text on server installations, where are trusted locations. If you have security concerns, you can leave the Password empty when you save these parameters. When the database connection is needed, the system will use these database parameters to connect to database. If the Password is not correct, the connection will fail. You need to open Reset Library Panel to reset the log database.
Note 3: The saved new parameters will not be effective until next application server restart or SuperLoggingLibrary reset. If you close this panel and open it immediately, you will still see old parameters.
This panel allows you to set database parameters. The default database is HypersonicSQL. If you need to use a different database, please contact us.
This panel allows you to specify options.
SuperLogging control component: The component which controls configuration of SuperLogging. It can be either SuperLoggingEJB or SuperLoggingServlet. If you choose SuperLoggingServlet, you need to deploy SuperLoggingServlet manually and specify SuperLogging servlet location. SuperLogging.war is under <SUPER_HOME>/beanbox directory.
SuperLogging servlet location: The URL of deployed SuperLoggingServlet. For example, for Weblogic it can be http://localhost:7001/SuperLogging/SuperLoggingServlet, for Websphere it can be http://localhost:9080/SuperLogging/SuperLoggingServlet.
This panel allows you to register or un-register Java classes and JSP files. If a Java class or a JSP file is not registered (by default), no log message will be generated in the Conditional mode. Both Quiet and Verbose modes ignore the class registration.
Add: Displays a FileChooser window for you to choose a Java class or a JSP file. The chosen class or file will be registered.
Remove: Un-registers a file. Removes a file that is highlighted on the registration list.
If the current scope is Global Static, both the Add and Remove
buttons are disabled, because the settings should not be changed within
Global Static scope.
This panel allows you to reset SuperLoggingLibrary globally: resets all instances of SuperLogging server side library that share the same log database. The reset will re-initialize the library, including re-connecting the log database. See Reset Library for more information.
You need to reset libraries in the following scenarios:
Full reset: Each instance of SuperLoggingLibraries will re-initialize SuperLoggingLibraries and reconnect the log database.
Reconnect if connection is broken: Each instance of SuperLoggingLibraries will re-initialize SuperLoggingLibrary and check its connection to the log database. If the connection is broken, the instance of SuperLoggingLibrary will reconnect the log database. If the connection is working, the existing reconnect will not be touched.
Log database password: The password for the log database.
Cancel: Close this panel and does nothing.
Note: The differences between above two options are for different way to connect the log database only. Other things are the same. For example, both options will re-read license information and refresh alert email information.
Note: If there is an error when reconnect the database, an alert email will be sent.
This panel allows you to specify Java classes or JSP files to register.
Full class name: The full Java class name or JSP file base name. Note: JSP files must include their extensions, for example: myJsp.jsp.
Browse: Displays a FileChooser to select a class in the file system.
You can choose a Java class or a JSP file.
Scope Panel
This panel allows you to change scope. Highlight the one you like and click the Ok button.
See Scope and Change Scope for more information.
This panel shows log records. This is the dynamic version of Tracer Panel of SuperTracer.
Log records are written by log methods from com.acelet.logging.Logging. See Logging for more information. Log messages can be inserted into the log database by other applications as well. Those applications can be written in any languages.
When you click a file name and line number of log messages on the Tail Panel, the line will be highlighted and the corresponding Source Code Panel will pop up and the line in question in the source code file will be marked. But, if the line number is not available at that time, no line will be marked on the Source Code Panel. See Source Code Panel for detail. Also see Log methods for more information. The source file can be a Java class file, a JSP file or a file written in other languages. If the source code file can not be found, the Tail Panel will do nothing.
Preference: Displays the Tail Preference Panel for you to set some attributes of tail.
Go: Restarts the tail process and gets messages from the server after the tail process has been stopped. Go and Stop are toggled buttons. Only one of them will be visible at a time.
Stop: Stops the tail process on client side. Go and Stop are toggled buttons. Only one of them will be visible at a time.
There will be no impact on the server side. It:
- stops getting messages from the server.
- will not stop the execution of your application.
- will not stop log statement calls in your application.
- will not stop SuperLogging server side library.
Clear: Clears the Tail Panel. Persistent log information on the database will not be cleared.
Filter: Displays the filter information. It is the WHERE clause for selecting log records.
Set: Opens the Filter Panel to set filter.
This Panel allows you to specify some attributes for the Tail Panel.
Pace: The interval value between tail operations in seconds. It should be greater than 0. It should be long enough for tail facilities to get data within that interval, otherwise, you will get time-out error.
Batch size: The batch size for tail. The unit is one row. This is the maximum number of rows Tail fetches. The actual number of rows may smaller than this.
The total bytes (batch size times the average length of rows) should not be more than 64K. Your operating system or network or JVM may have a limit on the size of the transferring data. But, generally speaking, you would not reach the limitation.
Query timeout: The timeout, in seconds, for each Tail operation.
The changes on this panel take effect on the next tail operation.
This panel allows you to view the parameters on the server. It is not editable.
Driver: The log database driver name. The class or jar file must be accessible by SuperLoggingLibrary.
URL: The log database URL.
User: The log database user name.
Password: The password for the log database User. Note: the Parameter field does not show the real password: SuperLogging does not download the password for security reason.
Query timeout: The time out for each access to the log database. The unit is one second. The value should be greater than 0. If you do not specify a value, the value will be zero, which means "no time out". Zero timeout is not recommended: when something is wrong, a call to the log database should return promptly, so SuperLogging can send alert email to administrators.