System Logging Configuration

This page is for administrators who want to configure options related to logging.

There are several way to access system logging configuration:

In the header bar, click Administration → System → Logging
Open the System Console. In the top right of the console window, click System Logging Configuration.
(PhixFlow versions pre-11 only) Scroll to the bottom of the repository list and click System Logging

PhixFlow opens the System Logging properties tab.

Log file names can be up to 250 characters long. See Configure logback.xml and phixflow-logging.xml for information about setting log file names.

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. We recommend you always add a Description that explains the purpose of the item you are creating.

For a full list of all the PhixFlow property tabs and windows, see Properties, Windows, Menus and Toolbars.

Field	Description
_{Log Frequency}
Database Reporting Frequency	Enter the number-of-records frequency with which records are reported. For example, enter 50000 to write a message to the log after every 50000 records have been inserted.
File Reporting Frequency	Enter the number-of-records frequency with which records are reported from file imports. For example, enter 1000 to write a message to the log after every 1000 records have been imported.
Maximum Debug Messages	When the options set in system logging cause a message to be written to a log file, the message has the type DEBUG. If several of these options are ticked for a large analysis run, PhixFlow can generate very large log files. To limit the size of log files, enter a number to indicate the maximum number of debug messages that can be written to the log file.
Debugging On	Tick to write additional debug messages to the system log file.
Log Service Requests	Tick to write details of Service Requests from the GUI applications into the system log file. When you select this option, PhixFlow generates very large log files. Service requests include the data being handled, which could include sensitive data about your company, personal data and other information that should be protected. This type of information may be governed by data security controls in your company. If you need to share these log files with other people, either within your company or with third-parties (such as PhixFlow IT support or consultants) check them carefully to ensure they contain no sensitive information.
Allow Pipe and Data Handler Logging
Allow Logging	Changing this option requires the Enable System Logging privilege. Tick enables System Logging options for pipes and data handlers (collectors and exporters). With logging enabled you can then: either use the Pipe Logging and Collector/Exporter Logging sections. These options switch on logging for all objects of a specific type. or use the Log Traffic or equivalent property to switch on logging for individual objects.
_{Pipe Logging}
Log Input Multiplier Messages	Tick to write a message to the log every time an input multiplier value changes during an analysis run.
Log Pipe Traffic	Tick to record the number of records returned by all non lookup pipes, in the system log file.
Log Pipe SQL	Tick to record the details of the queries run by all non lookup pipes on their input tables into the system log file.
Log Lookup Pipe traffic	Tick to record the number of records returned by lookup pipes, in the system log file.
Log Lookup Pipe SQL	Tick to record the details of the queries run by lookup pipes on their input tables into the system log file.
_{Collector/ Exporter Logging}
Log File Collector Traffic	Tick to log the number of records read from files during file imports.
Log Database Collector Statements	Tick to write details of the queries run by database collectors (on their target source databases) into the system log file.
Log Database Exporter Statements	Tick to write details of the queries run by database exporters (on their target source databases) into the system log file.
Log HTTP Collector Connection Details	Tick to write details of the HTTP connection (URL, headers, request and response body) into the system log file.
Log HTTP Exporter Connection Details	Tick to HTTP connection (URL, headers, request and response body) into the system log file.
Maximum HTTP Log Length	Enter the maximum number of characters from the request and response body to log in the debug message.

Sections on this page

System Logging Configuration

Log Frequency

Pipe Logging

Collector/ Exporter Logging

Search

_{Log Frequency}

_{Pipe Logging}

_{Collector/ Exporter Logging}