SecureSpan Bridge / XML VPN Client: Log Configuration and Customization

Products

• STARTER PACK-7
• CA Rapid App Security
• CA API Gateway

Issue/Introduction

Question: 

How do I configure and customize the SecureSpan Bridge / XML VPN Client log?

Environment:  

All Windows operating systems.

Answer: 

Configure SSB log to record posting and response messages

Modify the "SecureSpan Bridge.ini" / "SecureSpan XML VPN Client.ini" (Windows) commandline entry or "Bridge.sh" / "Client.sh" (Linux) extra entry by adding or appending the following system variables to true
 -Dcom.l7tech.proxy.processor.logPosts
 -Dcom.l7tech.proxy.processor.logResponses

Note: After modifying either of the files, the SSB / XVC will need to be restarted. The log file containing the SSB / XVC information is called ssa0.log and is located in the SSB / XVC service users¿ home directory. (Windows: "C:\Documents and Settings\<user>\.l7tech\ssa0.log" Linux: "<user home directory/.l7tech/ssa0.log)"


Configure SSB / XVC log to override logging properties file location

Modify the "SecureSpan Bridge.ini" / "SecureSpan XML VPN Client.ini" (Windows) commandline entry or "Bridge.sh" / "Client.sh" (Linux) extra entry by appending the following system variable to the location of the logging properties file. -Djava.util.logging.config.file=logging.properties


Configure SSB / XVC log to override logging default severity level (default severity level INFO)

Modify the "logging.properties" file located in SSB / XVC home directory (eg. Windows: "C:\Program Files\Layer 7 Technologies\SecureSpan Bridge ( or XML VPN Client) <version>\logging.properties" Linux: <Bridge/Client install directory>/ logging.properties)

For example, if you would like to override logging level to ALL, with max records in file of 10000000:

handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.level = ALL
java.util.logging.ConsoleHandler.level = ALL
java.util.logging.FileHandler.level = ALL
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.FileHandler.limit = 10000000
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

Please note that after modification of "logging.properties", you need restart the SSB/XVC to make changes effective. Now "ssa0.log" should be logging with severity level as specified.Modify the "SecureSpan Bridge.ini" / "SecureSpan XML VPN Client.ini" (Windows) commandline entry or "Bridge.sh" / "Client.sh" (Linux) extra entry by adding or appending the following system variables to true
 -Dcom.l7tech.proxy.processor.logPosts
 -Dcom.l7tech.proxy.processor.logResponses

Note: After modifying either of the files, the SSB / XVC will need to be restarted. The log file containing the SSB / XVC information is called ssa0.log and is located in the SSB / XVC service users¿ home directory. (Windows: "C:\Documents and Settings\<user>\.l7tech\ssa0.log" Linux: "<user home directory/.l7tech/ssa0.log)"


Configure SSB / XVC log to override logging properties file location

Modify the "SecureSpan Bridge.ini" / "SecureSpan XML VPN Client.ini" (Windows) commandline entry or "Bridge.sh" / "Client.sh" (Linux) extra entry by appending the following system variable to the location of the logging properties file. -Djava.util.logging.config.file=logging.properties


Configure SSB / XVC log to override logging default severity level (default severity level INFO)

Modify the "logging.properties" file located in SSB / XVC home directory (eg. Windows: "C:\Program Files\Layer 7 Technologies\SecureSpan Bridge ( or XML VPN Client) <version>\logging.properties" Linux: <Bridge/Client install directory>/ logging.properties)

For example, if you would like to override logging level to ALL, with max records in file of 10000000:

handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.level = ALL
java.util.logging.ConsoleHandler.level = ALL
java.util.logging.FileHandler.level = ALL
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.FileHandler.limit = 10000000
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

Please note that after modification of "logging.properties", you need restart the SSB/XVC to make changes effective. Now "ssa0.log" should be logging with severity level as specified.

Additional Information:

None.

Environment

Release:
Component: APIXVC