How to enable EMC Centera SDK Logging for Enterprise Vault (EV)

book

Article ID: 100017183

calendar_today

Updated On:

Resolution

When Enterprise Vault (EV) communicates with an EMC Centera Device to store data, EV leverages EMC's Software Development Kit (SDK). SDK logging can be enabled by adding system variable(s) on an EV server:

Method 1:
1. Start | Control Panel | System | Advance Tab | Environment Variables
 
2. Add a new variable:
Variable name: FPLIBRARY_LOG_FILE_DEBUG 
Variable value: Log file location and name e.g. c:\test.log.
 
Note: As this is a verbose log, ensure the location has sufficient space to store the SDK log.

3. Verify that it is set by issuing the set command at a DOS prompt.

4.  Restart the EV services to activate the logging.
 
Note:  Specifically enabling of the EMC SDK logging must be performed on EV server(s) which run the storage services that manage Vault stores configured to store items on Centera .

Method 2:
1. Start | Control Panel | System | Advance Tab | Environment Variables
2. Add the request/required variable(s) from the following table:
 
Variables:
 
Environment Variable
Description
Possible value(s)
FP_LOGPATH
Defines the full path to the log file on disk. This is required to enable logging. 
  Path and File name of the log. Ex. c:\SDKLog.txt
FP_LOGLEVEL
Determines which level of log data displays in the file. Note: If not set, default logging level is 3. 
  1 (Errors only)
  2 (Warnings and Errors)
  3 (Log, Warnings and Errors)
  4 (Debug, Log, Warnings and Errors)
FP_LOGFORMAT
Determines the log format. By default, the SDK API generates a tab-delimited log file.
  XML
  TAB
FP_LOGKEEP
Determines how the file is generated. If not set, by default it is set to Overwrite.
  • OVERWRITE: Replaces the existing log file.
  • APPEND: Adds to the existing log file.
  • CREATE: Creates a new log file name by appending a timestamp to the file name.
  OVERWRITE
  APPEND
  CREATE
FP_LOGFILTER
Determines which SDK component(s) are logged. Default is no filter (All components). (Comma separated value)
POOL, RETRY, XML, API, NET, TRANS, PACKET, EXCEPT, REFS, MOPI, STREAM, CSOD, CSO, MD5, APP (application level logging), SHA, LIB (library loading), and ALL (all components)
FP_LOG_MAX
_SIZE
Determines the maximum size of the log file. If not set, no max size is set. (in KB)
FPLong
FP_LOG_MAX_
OVERFLOWS
Determines the maximum number of backup (overflow) files to retain. The default is 1.
FPInt
 
Note: As this is a verbose log, ensure the location has sufficient space to store the SDK log.
 
3. Verify that the variables are set by issuing the  set  command at a DOS prompt.
4.  Restart the  EV  services to activate the logging.

To disable SDK logging, copy the log to an alternate location (as it will be removed during the next step), remove the additional system variable(s) added and restart the  EV services.

See Related Articles for additional resources on using EMC Tools to assist in troubleshooting Enterprise Vault access and communication with EMC Centera.​

See EMC Article:  How can I turn on logging for Centera SDK in my application?

 

Issue/Introduction

How to enable EMC Centera SDK Logging for Enterprise Vault (EV)
Powered by Wolken Software