FCS Activity PCS Log Traces for the MCS/FCS Backend

This topic describes the feature providing a way to monitor FCS API usage on the MCS and their performance without having to enable VERBOSE-MQL traces which are too verbose and may have an impact on performance.

The File Collaboration Server (FCS) is the component in the 3DSpace Service responsible for file storage.

The MCS - Metadata Collaboration Server - is the component in the 3DSpace Service connected to the database which stores metadata.

To be able to perform file-based operations, applications must call FCS APIs on the MCS.

This feature allows an administrator to activate a new logback logger which, for each call to an FCS operation, prints a line in the log file indicating which operation was called and how long it took.

To enable FCS on the MCS, an administrator has to activate the logback traces for the logger "FCSActivity" at the level TRACE. To do so, add the following line in the logback.xml configuration file located in:

TOMEE_INSTALL/webapps/ROOT_URI/WEB-INF-classes

<logger name="FCSActivity" level="TRACE"/>

It can be inserted after the definition of the root logger which is the following by default:

<root level="info">
<appender-ref ref=" ROLLING"/>
</root>

Once enabled, the traces will be printed in the logback output on a single line per operation.

Fo example: an MCS checkout operation (used to get an FCS ticket and which may trigger file replication):

Tenant=global|Verb=Checkout|Size=102505|ReplicationCount=1|ReplicationSize=102398|
Start=1484590045909|Duration=845|FcsWait=163|ReplicationWait=685|Zipped=false|NBFile=2

ParameterDescription
Tenant=global The tenant of the user that cause the operation
Verb=Checkout Operation name
Size=102505 Size of the files involved in the operation (may not be set)
Start=1484590045909 Timestamp of the start of the operation
Duration=845 Duration of the operation
NBFile=2 Number of files involved in the operation
Zipped=false Whether the operation requested compression
ReplicationCount=1 Number of files synchronized due to this operation
ReplicationSize=102398 Size of the files synchronized due to this operation
ReplicationWait=685 Duration of the synchronization due to this operation
FcsWait=163 Duration spend on FCS server

The different operation names for the FCS Java API are:

PreCheckin		     : checkin ticket
Checkin		        : checkin finalization
CheckinStart	    : checkin ticket
CheckinEnd		     : checkin finalization
CheckinNextRange	: checkin ticket
RefFile		        : soft link creation
Checkout		       : checkout ticket + eventually file replication
FileURL		        : single file checkout for browser + eventually file replication
RemoteExec		     : remote exec on FCS
Copy		:          : file copy + possibly file replication

The following operation names are also used by MQL command:

ReplicateThroughStore
copy
copyTenantFile
deleteTenantFile
exchangePublicKey
exporter
fcsAtimeCheck
fcsFilePing
fcsFilePingList
fcsFileRechecksum
fcsFileRechecksumList
fcsOrphanFile
groupIdenticalFiles
importer
mreplicate
FCSDelete
validatefcsCert
validatefcsFS
validatefcsTransfer