earth_america
user_standard Log on
action_search_stroke
earth_america
Log on to rate and give feedback 1 2 3 4 5 Log on to rate
0
How to

How to


Products: WebReports
Functionalities: Reports
Product version: 2.0, 2.1, 3.0, 3.1, 3.2, 3.3
12/16/2021

Changing Reporting Agent Logging Information

You change the Reporting Agent log file size and the number of log files to have the desired log files size and the number of log files you want to keep. You also edit the file to change the information level. Before you edit the file, review the values that are acceptable.

Show More
action_close

The log file for the Reporting Agent contains error, warning, debugging, and informational messages that can be used for identifying problems with the Reporting Agent.

During the installation, you set the size of the file and specify the number of log files you want to keep. The default values are recommended.

The WebReports installation places the log file in the Program Files directory, C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation WebReports\StruxureWare Reporting Agent. The file name is StruxureWareReportingAgentLog.txt.

When you want to modify the log file values, you edit the Reporting Agent configuration file. The file name is SE.WebReports.StruxureWareReportingAgent.exe.config. The file resides in C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation WebReports\StruxureWare Reporting Agent. For more information, see Reporting Agent Configuration File .

The log file size that you set depends on how much information you plan to log in the file. The default size is recommended. Keep in mind that the larger the file size, the longer it takes to open the file. You can also set the number of log files that you want to save. When the maximum number of log files has been reached, the oldest file is deleted to create space for the new file.

Log File Levels

You can control the type and amount of information that is stored in the log file using the information levels. By default, the log file is set to Info. You can change the default value by editing SE.WebReports.StruxureWareReportingAgent.exe.config.

Table: Log File Levels

Level

Description

Fatal

When set to Fatal, the log file records fatal errors only. Use Fatal to capture the least amount of information about the Reporting Agent.

Error

When set to Error, the log file records all errors including fatal errors.

Warn

When set to Warn, the log file records all fatal errors, errors, and warnings.

Info

When set to Info, the log file records all fatal errors, errors, warnings, and informational messages about the Reporting Agent. Info is the default setting.

Debug

When set to Debug, the log file records all fatal errors, errors, warnings, informational messages, and debugging information about the Reporting Agent. Use Debug to capture the most information about the Reporting Agent.

To change the Reporting Agent log file information

  1. Stop the Building Operation x.y WebReports Agent service from the Microsoft Management Console.

  2. In Windows, navigate to C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation WebReports\StruxureWare Reporting Agent.

  3. In the Folder Options dialog box, clear Hide extensions for known file types from the folder option for the StruxureWare Reporting Agent folder.

  4. In the StruxureWare Reporting Agent directory, open SE.WebReports.StruxureWareReportingAgent.exe .config in notepad.

  5. For the maximumFileSize parameter, type the number of megabytes for the size of the Reporting Agent log file.

     
    action_zoom_plus_stroke

  6. For the maxSizeRollBackups parameter, type the number of log files you want to keep.

  7. For the level parameter, type FATAL, ERROR, WARN, INFO or DEBUG.

  8. Save the file.

  9. Start the Building Operation x.y WebReports Agent service.

See Also

  • Reporting Agent Log File
  • Changing Events and Historical Records Information