Log Viewer Properties

This agent registers itself into the ServiceManager and accepts http requests to view information stored in log files. Given a directory, this agent will look for all the files in that directory and treat them as log files. The agent uses a mapping which provides information about how these files should be displayed. The logfile mapping maps a name to a text pattern. The agent will display the names and the matching lines of the log files.

log_dir

This property tells the LogViewerPage where to look for the log files. This agent will assume that all files in this given directory are log files.

log_map_file

This is the logfile mappings. This file should contain names mapped to text patterns. For example, a typical map file may look like this:

Total requests=GET LogViewer requests=GET /logviewer.agent

When the LogViewerPage is brought up on a browser, the summaries will show 2 fields: Total requests and LogViewer requests. The number of lines that matches the pattern GET will be counted and included in the first field. The number of lines that matches the pattern GET /logviewer.agent will be counted and included in the second field.

check_interval

All requests to view the actual lines of log files are processed in real time, that is to say, the log files are searched when a request to view certain lines of all the log files are recieved. However, counts are given and recorded regularly. This property tells this agent how often to update this count in milliseconds.

service_name

This is the name which to register to the ServiceManager. This is also the name that will be used to access this agent from a browser.

is_logger_output

If this property is set to true, the LogViewerPage will assume that the log files are generated by the WebServer's LoggerAgent and the formatting of some of the pages when lines of log files are used will be a little more readable.

max_show_log_length

This is the maximum length of data that will be shown when a request to view log output is received. Since there may possibly be megabytes of log files, if a request to show all logged requests is given, the LogViewerPage will only show the number of bytes given by this property.