Configure Advanced Logging - Command Line

You can enable advanced logging and set the log matching criteria from the command line by way of the AdvancedLogging.lua SPL-plugin. When adding log matching criteria, note that within in each set of criteria:

• an AND relationship means that all conditions must match before the system generates the log.
• an OR relationship means that only one set of conditions must match before the system generates the log.

Note:

The system does not require you to save and activate after performing this procedure.

Procedure

1. Use the spl start sip advanced-logging command to enable advanced logging.
2. Use the following commands to configure advanced logging.

   Command	Description
   spl set sip advanced-logging add-criteria	Adds another set of matching criteria.
   spl set sip advanced-logging log-label <label string>	Any logs of requests that are matched will have the specified <label string> appended before each log message for easier searching.
   spl set sip advanced-logging rate-count <match count>	Sets the rate-limiting to log only <match count> number of matching requests per time window.
   spl set sip advanced-logging rate-time <time window>	Sets the rate-limiting time window in seconds.
   spl set sip advanced-logging in-agent <session-agent>	Adds to the current set of matching criteria that the request must come from the specified incoming session-agent hostname.
   spl set sip advanced-logging in-realm <realm-id>	Adds to the current set of matching criteria that the request must come from the specified incoming realm identifier.
   spl set sip advanced-logging request-type <method name>	Adds to the current set of matching criteria that the request must be of the specified request method type, for example, INVITE and REGISTER.
   spl set sip advanced-logging from-uri-host <FROM URI host portion>	Adds to the current set of matching criteria that the request FROM headerURI host portion must match the specified value exactly.
   spl set sip advanced-logging from-uri-user <FROM URI username portion>	Adds to the current set of matching criteria that the request FROM headerURI username portion must match the string and the specified value exactly.
   spl set sip advanced-logging to-uri-host <TO URI host portion>	Adds to the current set of matching criteria that the request TO headerURI host portion must match the string and the specified value exactly.
   spl set sip advanced-logging to-uri-user <TO URI username portion>	Adds to the current set of matching criteria that the request TO headerURI username portion must match the string and the specified value exactly.
   spl set sip advanced-logging request-uri-host <RURI host portion>	Adds to the current set of matching criteria that the request RURI headerURI host portion must match the string and the specified value exactly.
   spl set sip advanced-logging request-uri-user <RURI username portion>	Adds to the current set of matching criteria that the request RURI headerURI username portion must match the string and the specified value exactly.
   spl set sip advanced-logging header <header-type> <header-value>	Adds to the current set of matching criteria that the request must have a header of type <header-type> with a value of <header-value> with exact string matches.