Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 13 Next »

This page is for administrators who need to monitor events on the PhixFlow system. 

Overview

  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, 

Finding Logs

The  System Console has a series of tabs displaying information about PhixFlow activity; 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.

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.

System Logging Properties

You can configure some logging options from the system console.  To open the System Logging Configuration properties, right-click  Logging.


See also Logs for Third-Party Systems.

Sections on this page


Tomcat

The Tomcat access log records requests to the server. By default the access log is configured in $TOMCAT/conf/server.xml. The access log may be configured to log the PhixFlow username of the user making the request. It may be specified as %{username}s in the log file configuration message pattern. For more information on configuring the access log see https://tomcat.apache.org/tomcat-8.5-doc/config/valve.html#Access_Log_Valve/Attributes

Configuring Server Log Files

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

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.


logback.xml

 logback.xml controls detailed event/error logging on the server. Changes to logback.xml take effect within a minute or so, without having to restart the Tomcat server.

Change the configuration of this file

  • at installation, to rename the log file if you have multiple PhixFlow instances; see Renaming the Log File.
  • to log more detailed information when troubleshooting.

Edit and save the logback.xml file, which is in:

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

For example:

/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 the activity that has the problem. After repeating the problem, check your phixflow.log file to see the additional logging details. 

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.


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  Administration 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  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.


  • No labels