set_subscriber_trace.py
The set_subscriber_trace.py script turns on tracing, which changes the log level for the specified gateway (Diameter Gateway, CAMEL Application Part (CAP), or both), and the Charging Server dynamically during runtime. Turning on tracing allows these MATRIXX processes to log trace messages to the mtx_debug.log file. The script applies to all servers in the specified engine.
Syntax
The set_subscriber_trace.py script has the following options, in addition to the standard engine command line options.
set_subscriber_trace.py [--imsi] | [--msisdn] | [--nai] | [--private] | [--sip_uri] | [--calling] | [--called] [--gateway][--log_level level]
Options
Note: A trace can run on one value only for each option (such as
--nai
or
--imsi
) at a time (multiple traces can be active at one time,
but you cannot start them in one command). Seven trace options are available, so
seven subscriber traces can be active at one time. A nonzero option value starts
the tracing, and a zero value stops it.- --imsi imsi_value
- The IMSI of the device to trace. In the CAMEL Application Part (CAP), the IMSI number is traced unnormalized and must match the exact digits sent on the network.
- --msisdn msisdn_value
- The MSISDN value of the device to trace.
- --log_level level
- The log level to set for the Diameter Gateway, CAMEL Application Part (CAP), and Charging Server tasks, which perform the tracing. This option is not required when
turning on trace logging because the log level is set to
trace. It is required when turning off trace
logging in the following circumstances:
- If only one trace is running and you want to reset the log level to a value other than info (the default), such as warning.
- If multiple traces are
running and you only want to stop the trace logging for one. In this
circumstance, you must specify the
--log_level
option with a value of trace to continue writing the messages for the traces still running.
- --nai nai _value
- This is the NAI (network access identifier) of the subscriber to be traced.
- --private private_id_value
- This is the private ID of the subscriber to be traced.
- --sip_uri sip_uri_value
- This is the SIP URI of the subscriber to be traced.
- --calling CallingPartyNumber_value
- This is the calling party number of the subscriber to be traced. In the CAMEL Gateway, the calling number is traced unnormalized and must match the exact digits sent on the network.
- --called CalledPartyNumber_value
- This is the called party number of the subscriber to be traced. In the CAMEL Gateway, the calling number is traced unnormalized and must match the exact digits sent on the network.
- --gateway gateway_value
- This is the gateway on which to trace. Set this option to diameter to trace the Diameter Gateway. Set the option to camel to trace the CAMEL Gateway. Set the option to both to trace both gateways. The default is Diameter Gateway only.
Turn on trace logging for an NAI
set_subscriber_trace.py --nai [email protected]
Turn on trace logging for an MSISDN device
set_subscriber_trace.py --msisdn 447871234567
Turn off trace logging for the IMSI device but keep on tracing for the MSISDN device
set_subscriber_trace.py --imsi 0 --log_level trace
Turn on trace logging for an IMSI device only on the CAMEL Gateway
set_subscriber_trace.py --imsi 310150123456789 --gateway camel
Turn off trace logging for MSISDN and set the default log level to warning
set_subscriber_trace.py --msisdn 0 --log_level warning