Home
MATRIXX Monitoring and Logging
Appendixes
System Log Configuration Files
Use the system log scripts and configuration files to configure log rotation, gather system logs, set object tracing, and change the log level dynamically.
rotate_mtx_logs.py
The rotate_mtx_logs.py script runs the logrotate command from $MTX_LOG_DIR.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
- About MATRIXX Monitoring and Logging
  MATRIXX Monitoring and Logging describes monitoring and logging for MATRIXX components in a MATRIXX environment.
- Metrics and Alerts
  The following information describes monitoring metrics and alerts information for MATRIXX. MATRIXX Support recommends using the Prometheus and Grafana third-party products to monitor a MATRIXX environment, along with aggregated logging.
- Logging
  The following describes logging information for MATRIXX.
- Tracing
  The following information describes tracing information for MATRIXX.
- Monitoring Components
  The following information describes monitoring different components for MATRIXX.
- Appendixes
  - System Log Configuration Files
    Use the system log scripts and configuration files to configure log rotation, gather system logs, set object tracing, and change the log level dynamically.
    - cron-hourly-logrotate-mtx
      The cron-hourly-logrotate-mtx command is a cron job that checks if the system logs must be rotated on an hourly basis instead of the default daily basis. If the logs must be rotated, the script calls the logrotate utility to perform the rotation.
    - logrotate_mtx.conf File
      Use the logrotate_mtx.conf file to configure system log rotation behavior. By default, the log volume is checked on a daily basis to determine if log rotation is needed, based on the settings defined in this file.
    - logrotate_tra.conf File
      Use the logrotate_tra.conf file to configure system log rotation behavior for a Traffic Routing Agent (TRA) server deployed in Kubernetes. By default, the log volume is checked on a daily basis to determine if log rotation is needed based on the settings defined in this file.
    - rotate_mtx_logs.py
      The rotate_mtx_logs.py script runs the logrotate command from $MTX_LOG_DIR.
    - gather_logs.py
      The gather_logs.py script collects system logs from the ${MTX_LOG_DIR} directory, core files, and custom configuration files that are used at runtime and adds them to a ZIP file so they can be offloaded to a non-engine sever. The gather_logs.py script also analyzes the data in the core file and writes the results to a file with the same name but with a .log extension.
    - rsyslog_mtx.conf File
      Specify configuration settings for the rsyslog utility in the rsyslog_mtx.conf configuration file. MATRIXX Engine uses the rsyslog utility to generate and manage log files.
    - Debug and Trace Logs
      System logs set to the debug or trace level show more details about the processing operations for each MATRIXX process.
    - set_trace.py
      The set_trace.py script changes the system log level dynamically for a single MATRIXX Engine server during runtime for the current session. Specific messages can be logged for one or more MATRIXX services, including more specific tasks that form a service. The script updates the values set in the ${MTX_CUSTOM_DIR}/mtx_log_config_update.cfg file but does not change the base system configuration parameter in the ${MTX_CONF_DIR}/mtx_config.xml file. The script only makes logging changes on the server on which the script runs.
    - 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.
    - System Log
      System logs contain standard information that identifies day-to-day processing. They are organized into logical sections.
    - split_mtx_debug_log.py
      The split_mtx_debug_log.py script reads the specified MATRIXX debug log file, retrieves all logical log entries that match the specified input parameter, and writes them to the specified output file.
  - Analytical and Informational Scripts
    Use the scripts in this section to gather information about system performance, system topology, performance statistics, system configuration, and MATRIXX Engine versioning. All scripts run locally on a server as user mtx.
  - Configuration, Demo, and Test Scripts
    Use these scripts to configure MATRIXX Engine, create demos, and test system functionality.
  - Dynamic Logging Scripts
    Use the system log scripts to change the log level dynamically.
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

rotate_mtx_logs.py

The rotate_mtx_logs.py script runs the logrotate command from $MTX_LOG_DIR.

Syntax

rotate_mtx_logs.py [-h] [ -c LOGROTATECONFIGFILE] [ -i TIMEINTERVALINSECS] [-s LOGROTATESTATUSFILE]

Options

The rotate_mtx_logs.py script has the following command line options:

-h, --help: Show this help message and exit.
-c LOGROTATECONFIGFILE, --logrotate_config_file=LOGROTATECONFIGFILE: Configuration file used by logrotate. Default is /opt/mtx/conf/logrotate_mtx.conf
-i TIMEINTERVALINSECS, --time_interval_in_seconds=TIMEINTERVALINSECS: Time interval in seconds to run logrotate. Default is 3600 seconds.
-s LOGROTATESTATUSFILE, --logrotate_status_file=LOGROTATESTATUSFILE: Status file used by logroate. Default is ./logrotate.status.

To pass a different command line option, you can add a line similar to the following line in the process_ctrl_cfg_sed.extra file, which configures logrotate to run every five seconds and uses a different logrotate configuration file:

s@service \(.*\) rotate_mtx_logs.py@service \1 rotate_mtx_logs.py -i 5 -c /opt/mtx/conf/my_logrotate_mtx.conf@

Note: The custom logrotate file can be added to a configuration source. The filename pattern must be *logrotate*.conf.

To disable this function, include the following line in process_ctrl_cfg_sed.extra file:

 s@service \(.*\) rotate_mtx_logs.py@#service \1 rotate_mtx_logs.py@