Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This page is for administrators who need to monitor events on the PhixFlow system. 

Overview

The areas of logging you can use to monitor PhixFlow activity are:

  1. User activity and tasks within PhixFlow: in use the 
    Insert excerpt
    _console
    _console
    nopaneltrue
    .
  2. The PhixFlow Webapp webapp activity on the server and network: see use the server log files, especially phixflow.log.
  3. Tomcat servlet activity related to PhixFlow; see use the Tomcat access log.

These are described in more details belowdetail below.

See also Logs for Third-Party Systems.

Activity Within PhixFlow

Where to Look

To find the information about user activity and tasks within PhixFlow, use the 

Insert excerpt
_console
_console
nopaneltrue
; see System Console. Use the:

  • Task Logs tab to monitor processes that are running on PhixFlow
  • Archive Log tab to monitor the archiving of stream sets; see pages in the Tasks, Task Plans and Archiving topic for details

    .

    Configuration

    You can configure system logging options in the System Logging Configuration properties. In the top right of the console, right-click 

    Insert excerpt
    _system_log
    _system_log
    nopaneltrue
    .

    In some cases you may need to investigate problems not covered by the information in the console. In this a case, refer to the server log files that record PhixFlow and Tomcat activity and network traffic. In particular, the phixflow.log files include information to help you track down problems.

    See also Logs for Third-Party Systems.



    Panel
    borderColor#7da054
    titleColorwhite
    titleBGColor#7da054
    borderStylesolid
    titleSections on this page

    Table of Contents
    indent12px
    stylenone


    1. You can get Tomcat to Log stuff about PhixFlow
    2. Create log for activity on the server: log files in the ?? logs directory
    3. Detailed activity within PhixFlow, 

    Server Log Files

    Where to Look

    To find the logged information about PhixFlow Webapp webapp activity on the server and network, use the log files saved in the <path>logs directory. You can also download a zip file of all or selected log files; see Downloading Server Log Files, below.

    The server log files generated by PhixFlow are:

    • phixflow.log and phixflow.log.<date>
      phixflow.log is the default name. The name and recorded data can be configured in logback.xml.
    • security.

    Configuration

    During the PhixFlow webapp installation, the administrator configures the level of server logging in:

    • logback.xml; see Configure logbacklog
    • manager.<date>.log
    • localhost_access_log.<date>.txt
    • localhost.<date>.log
    • host-manager.<date>.log
    • catalina.out and catalina.<date>.log

    The main log files are phixflow.log and phixflow.log.<date>. This is the default name. The name and recorded data can be configured in logback.xml.

    Security.log records:

    • all logouts including: username, session, IP address, whether the user logged out or the session timed out.
    • all login attempts
      • successful login: username, session, IP address of the user
      • failed attempts: username, IP address, and reason for the failure.

    If you have multiple instances of PhixFlow hosted under the same Tomcat instance, each PhixFlow instance has a different log file name. You can find out the log file names for different instances in logback.xml.

    Configuration

    phixflow-logging.xml

    phixflow-logging.xml is configured at installation; see Configure phixflow-login.xml

    When investigating problems, you can change the logging level for PhixFlow. If you are working with the PhixFlow support team, they can provide advice on what to change. The file contains a list of directories that contain log files. PhixFlow uses these directories when you download log files from the GUI. You only need to change this file as requested by PhixFlow Support.

    logback.xml


    Use logback.xml to configureis configured at installation; see Configure logback.xml. The installer sets:

    • to change the default level of event or error logging recorded when you are troubleshootingin the server log files. 
    • the name of the log files generated, if you have multiple PhixFlow instances; see Renaming the Log File.

    detailed event/error logging on the server. Changes When investigating problems, you can change the logging level set in logback.xml. If you are working with the PhixFlow support team, they can advise you about what to change. Changes to logback.xml take effect within a minute one or sotwo minutes, without having to restart the Tomcat server.Edit and save the 

    Some options can generate huge amounts of extra logging, and these will create very large log files.

    The logback.xml file, which  file is in:

    Code Block
    [tomcat installation base]/webapps/[instance name]/WEB-INF/classes/logback.xml

    For example:

    Code Block
    /usr/local/tomcat/webapps/phixflow/WEB-INF/classes/logback.xml

    Some options can generate huge amounts of extra logging, and these will create very large log files.

    PhixFlow will automatically pick up the change, so you can continue investigating, for example repeating Change the logging level and then rerun the activity that has the problem. After repeating the problem, check your Check phixflow.log file to  to see the additional logging details. 

    Tip

    Remember to reset logback.xml to the standard logging options once your investigation is finished.

    If you want to integrate PhixFlow server logs into other logging frameworks, such as Google Cloud's stackdriver, please contact support@phixflow.com.

    phixflow-logging

    .

    xml

    phixflow-logging.xml file contains a list of directories that contain log files, and is used when you download log files from the GUI. You only need to change this file as requested by PhixFlow Support.

    Anchor
    download
    download
    Downloading Server Log Files

    In addition to viewing the log files in the logs directory you can download a zip file of all or selected log files.

    In the bottom right, click

    Insert excerpt
    _administration
    _administration
    nopaneltrue
     to open the Administration menu.

    Select Other Options → Download Log Files. PhixFlow opens a window prompting you to enter file names.

    Enter file names, optionally using an asterisk * as a wildcard.

    Click 

    Insert excerpt
    _dialog_finish
    _dialog_finish
    nopaneltrue
     to start the download process. PhixFlow zips the specified log files into a single zipped archive. Depending on your system configuration, downloading all log files may take some time and will produce a large (several GB) zip file.

    When the download is finished, a blue notification box reports that the file is ready. Click the notification to download the zip file.

    The server log files generated by PhixFlow and Tomcat, are:

    • phixflow.log and phixflow.log.<date>
      phixflow.log is the default name. The name and recorded data can be configured in logback.xml.
    • security.log
    • manager.<date>.log
    • localhost_access_log.<date>.txt
    • localhost.<date>.log
    • host-manager.<date>.log
    • catalina.out and catalina.<date>.log

    The main log files are phixflow.log and phixflow.log.<date>. This is the default name. The name and recorded data can be configured in logback.xml.

    Security.log contains a record of all login attempts and logouts. Successful login attempts and logouts are logged with the username, session and IP address of the user. Logouts also record if the logout was the result of a user action or session timeout. Failed attempts to login are also logged with the username, IP address and reason for the failure.

    If you have multiple instances of PhixFlow hosted under the same Tomcat instance, each PhixFlow instance will have a different log file name. Check logback.xml file to find out the main log file names.


    Tomcat

    Where to look

    To find information about Tomcat servlet activity related to PhixFlow, look in the Tomcat access log. This records requests to the server.

    • catalina.out and catalina.<date>.log

    Configuration

    You can configure the Tomcat access log in $TOMCAT/conf/server.xml (this is the default location). To configure the log to record the PhixFlow user making a request, specify %{username}s in the log file configuration message pattern.

    For more information about configuring the Tomcat access log, see Tomcat Configuration Reference → Attributes.