Siebel Analytics Web Administration Guide > Using Siebel Analytics Web Logging >

Analytics Web Configuration File Structure


The structure of the configuration XML file is shown in Figure 5. The cardinality of each node is shown in brackets.

Figure 5. Structure of a logconfig.xml File
Click for full size image

An example of a logconfig.xml file that has four writers is shown in Figure 6.

Figure 6. Example of a logconfig.xml File with Four Writers
Click for full size imageClick for full size image

An example of a logconfig.xml file that has one writer set up to record charting events is shown in Figure 7.

Figure 7. Example of a logconfig.xml File with ChartLogger Writer
Click for full size image

A description of each node in the configuration hierarchy is shown in Table 15.

Table 15. Siebel Analytics Web Log Configuration File Elements
Element
Attribute
Description

Writers

Contains writers configuration.

This configuration is loaded on startup.

Writer

Configures a writer.

implementation

Name of the C++ class that implements the writer.

The following implementations are defined:

  • FileLogWriter. Writes to a disk file.
  • CoutWriter. Writes to standard output.
  • EventLogWriter. Writes to Windows event log or UNIX syslog.
  • CrashWriter. Writes to a crash dump file when the Analytics Web Server attempts to log from a specific source file and line number.
    • Used in a production environment for information of some loggable but non-fatal error (for example, failed NQTEST).
    • On Windows, CrashWriter requires appropriate version of dbghelp.dll (at least 6.0.17.0).
      The correct dbghelp.dll is found in support/windows/system32.
      Put this DLL in the WINNT/system32 or in the main/bin directory.
      No registration is required.

name

Unique name for the writer.

writerClassId

Integer number in the range 1-10. This number is used by filters to allow or prohibit logging.

Each distinct writer must have a unique value, which is used later for filter configuration.

Different writers may have the same class ID, but if they do, those writers cannot be distinguished by filters.

Writer (continued)

FileLogWriter specific attributes:

dir

Directory where log files are to be created.

maxFileSizeKb

Maximum size of the logging file in kilobytes.

When the file size limit is reached, the file is closed and a new logging file is created.

filePrefix

Log files prefix.

filesN

Maximum number of logging files.

When this number is exceeded, the logger starts to write to the beginning of the first file.

EventLogWriter specific attributes:

winSource

Event log source for logged events.

CrashWriter specific attributes:

file

Dump file path.

On Windows, a dump file is created in bin/coredumps and Siebel Analytics Web Server continues to run.

line

Dump file line number.

WriterClassGroups

Contains definition for writer classes. Writer class is a group of Writer class IDs.

WriterClassGroup

Contains (as child text) a comma-separated list of class IDs.

name

Name of the WriterClassGroup.

Filters

Contain filter configuration.

FilterRecord

writerClassGroup

Specifies the group of writers to which this record is applied. WriterClassGroup should be defined previously in the WriterClassGroups section.

path

Log source path.

Current filter record is applied to the software component identified by that path and all its subcomponents.

information

An integer that specifies the severity of the corresponding message type.

Only messages with a severity index less than the provided number are logged.

warning

error

security

Siebel Analytics Web Administration Guide