Versions Compared

Version Old Version 19 New Version Current
Changes made by

Fiona Sargeant (Unlicensed)

Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

Insert excerpt
_Banners
_Banners
nameadministration
nopaneltrue

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 
    Insert excerpt
    _administration
    _administration
    nopaneltrue
     → 
    Insert excerpt
    _system
    _system
    nopaneltrue
     →  
    Insert excerpt
    _system_log
    _system_log
    nameadmin
    nopaneltrue

...

  • Open the 
    Insert excerpt
    _console
    _console
    nopaneltrue
    . In the top right of the console window, click 
    Insert excerpt
    _system_log
    _system_log
    namefull
    nopaneltrue
     Configuration.

PhixFlow opens the System Logging properties tab.

Tip

Log file names can be up to 250 characters long.

...

See Configure logback.xml and phixflow-logging.xml in Install the PhixFlow Webapp for information about setting log file names.

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

FieldDescription

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

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to write additional debug messages to the system log file.

Log Service Requests

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to write details of Service Requests from the GUI applications into the system log file.

Warning

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.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to write a message to the log every time an input multiplier value changes during an analysis run.

Log Pipe Traffic

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to record the number of records returned by all non lookup pipes, in the system log file.

Log Pipe SQL

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to record the number of records returned by lookup pipes, in the system log file.

Log Lookup Pipe SQL

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to log the number of records read from files during file imports.
Log Database Collector Statements
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to write details of the queries run by database collectors (on their target source databases) into the system log file.
Log Database Exporter Statements
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to write details of the HTTP connection (URL, headers, request and response body) into the system log file.

Log HTTP Exporter Connection Details

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to HTTP connection (URL, headers, request and response body) into the system log file.

Maximum HTTP Log LengthEnter the maximum number of characters from the request and response body to log in the debug message.


Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone