Home
MATRIXX Administration
Appendixes
MATRIXX Engine Scripts
You can use the following scripts to support servers, clusters, engines, pricing domains, system logging, notification messaging, and event-repository storage. Use them to gather information, perform maintenance operations, such as starting and stopping servers, configure system behavior, and manage engine failover operations.
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.
analyze_stack_frame.py
The analyze_stack_frame.py script takes a line in a stack frame in the mtx_debug.log or in a specified file and prints the function name, the source filename, and the line number of this stack frame. This information can be sent to a MATRIXX representative for troubleshooting errors.

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
- About MATRIXX Administration
  MATRIXX Administration describes how to monitor MATRIXX Engine components and to perform daily operations for maintaining a geographically redundant system. This includes administration for the engine, Traffic Routing Agent, MATRIXX gateways and web apps, and Notification Framework. It also provides information about recovering from a total system failure.
- Administering MATRIXX Engine
  The topics in this section have information about maintaining, managing, and resolving issues with a MATRIXX Engine installation.
- Administering MATRIXX Traffic Routing Agent
  The topics in this section describe administering Traffic Routing Agent (TRA) servers, including starting and stopping Traffic Routing Agent nodes and clusters. The information in this section applies to all Traffic Routing Agent functions unless otherwise noted.
- Administering the Route Cache
  The topics in this section describe administering the Route Cache.
- Administering US Tax Data
  US tax data is imported from CCH tax data, compiled in My MATRIXX, and output as compact MATRIXX Data Container (MDC) files, including an MDC file containing tax database metadata and status information. MDC files are packaged into a .zip file and loaded into the MATRIXX tax database.
- Troubleshooting Issues
  This section has information to help identify and resolve system issues.
- Appendixes
  - Admin Service Commands
    The Admin Service includes commands for administering MATRIXX components.
  - Engine Validation Error Codes
    The following return codes can be written to the system log when a network message is processed.
  - Python Value Type to AVP Type Mapping
    The following table describes how Python value types are mapped to AVP types.
  - MATRIXX Engine Scripts
    You can use the following scripts to support servers, clusters, engines, pricing domains, system logging, notification messaging, and event-repository storage. Use them to gather information, perform maintenance operations, such as starting and stopping servers, configure system behavior, and manage engine failover operations.
    - 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.
      - analyze_replay_performance.py
        After a database initialization completes, run the analyze_replay_performance.py script on the processing server that serviced the replay request to analyze transaction replay throughput statistics, including the checkpoint creation time, any throttling, the number of transactions replayed, and the duration to replay them. Look for database initialization requester or start sending in-memory database replay to peer cluster log messages to find the processing server on which to run the script. The script uses the mtx_debug.log file to analyze the replay performance because the server where it is run drove the replay, both locally and remotely.
      - analyze_stack_frame.py
        The analyze_stack_frame.py script takes a line in a stack frame in the mtx_debug.log or in a specified file and prints the function name, the source filename, and the line number of this stack frame. This information can be sent to a MATRIXX representative for troubleshooting errors.
      - check_system_configuration.py
        The check_system_configuration.py script checks and can correct system configuration settings for MATRIXX components. It runs on individual components as they are installed and on MATRIXX Engine when you start it by itself. You can also run this script as needed on components of an installed system to check or correct system configuration. The behavior of this script is limited to the permissions of the user running it. Running it as a user with non-sudo permissions just alerts you to configuration issues on file systems and files that the user as permission to read. Running this script with sudo permissions and the --autocorrect=1 option gives it access to more settings and directs it to correct any configuration issues it finds.
      - cluster_mgr_cli.py
        The cluster_mgr_cli.py script provides a simple command line client that can be run on an off-engine server such as a Network Operation Center (NOC) to manage certain cluster operations. This script can retrieve cluster and peer cluster HA states, low-level information about cluster status, the Cluster Manager leader, and the cluster schema version. This script can also shut down a target cluster.
      - print_blade_stats.py
        The print_blade_stats.py script displays statistics for MATRIXX Engine, in-memory databases, cluster and server states, system memory, notifications, Task Manager, Diameter, MDC Gateway, CCF statistics, checkpoint statistics (such as the server ID, last or in-progress checkpoint state, checkpoint start and end times, type of checkpoint (ad hoc, fast restart), related _glossary/global_transaction_counter.html, and checkpoint name and path), system monitor, and others. For a description of all SNMP statistics, see the discussion about all MATRIXX SNMP statistics in MATRIXX Monitoring and Logging.
      - print_data_container_file.py
        The print_data_container_file.py script prints the contents of a MATRIXX data container (MDC) file in XML format. The file can be a transaction log file, _glossary/mef.html, checkpoint file, or any MDC.
      - print_data_container_pickled_file.py
        The print_data_container_pickled_file.py script is a debugging script that prints the information stored in the ${MTX_CONF_DIR}/mdc_config_custom.pickled file (which holds the custom MATRIXX Data Containers (MDCs) or the ${MTX_DATA_DIR}/data_container/mdc_config_system.pickled file (which holds the system MDCs).
      - print_gw_connections.py
        The print_gw_connections.py script reports current connections maintained by Diameter Gateway or MDC Gateway.
      - print_in_use_mtxbufs
        The print_in_use_mtxbufs script provides information about the in-use memory buffers on a server. It mainly provides details about what is inside the MtxBuf buffers that are in-use.
      - print_mtx_version.py
        The print_mtx_version.py script prints the current version information, or prints a MATRIXX JAR or WAR file, if given.
      - print_object_id.py
        Use the print_object_id.py script to translate object IDs (OIDs) used by MATRIXX Data Export from INT format to OID strings, and from OID strings to INT format.
      - print_topology.py
        Use this script to display information about software topology, including sites, domains, load balancers, shared storage, MATRIXX engine IDs, cluster IDs, server IDs, and IP addresses.
      - validateCheckpoint.jar
        The validateCheckpoint.jar program analyzes a MATRIXX checkpoint, detects any errors in the database, and produces a validation report listing internal database statistics and any errors found. This information can be sent to a MATRIXX representative to help troubleshoot database errors.
    - Configuration, Demo, and Test Scripts
      Use these scripts to configure MATRIXX Engine, create demos, and test system functionality.
    - Server Administration Scripts
      Use the following server administration scripts to administer MATRIXX Engine servers.
    - Cluster Administration Scripts
      Use the cluster administration scripts to start, stop, restart, and check the status of all logical servers in a cluster and to sync all MATRIXX directories on all servers in the cluster.
    - Engine Administration Scripts
      Use the following engine administration scripts to administer the MATRIXX Engine.
    - Control Scripts for Containerized Installations
    - Failover Scripts
      Use these scripts to publish MATRIXX and clean up orphaned transaction log files after an engine failover.
    - Provisioning Scripts
      Use these scripts to provision data in the MATRIXX database.
  - Scripts and Utilities for MATRIXX Gateways and Web Apps
    Use the following scripts to administer MDC Gateway, Gateway Proxy, RS Gateway, and other MATRIXX gateways and web apps.
  - Traffic Routing Agent Administration Scripts
    Use the following scripts to administer Traffic Routing Agents (TRAs), to check the status of a TRA server, or to validate the TRA configuration.
  - MATRIXX Data Container Field Data Types
    MATRIXX Engine supports several data types for its network message MATRIXX Data Containers (MDCs) and database object MDCs. When you define custom MDCs and MDC fields, you must specify one of these data types for the fields.
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
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

analyze_stack_frame.py

The analyze_stack_frame.py script takes a line in a stack frame in the mtx_debug.log or in a specified file and prints the function name, the source filename, and the line number of this stack frame. This information can be sent to a MATRIXX representative for troubleshooting errors.

Syntax

analyze_stack_frame.py  -h -d -f stack_line

Options

-h, --help: Returns information about the script.
-d, --debug: If this option is specified, extra messages are printed to help with debugging this script.
-f, --file: If this option is specified, this is the name of the file to analyze. The file can contain any number of stack frames to analyze.
stack_line: The line in the stack frame to analyze. Stack frames are located in an LM_ERROR message and are preceded with the --Stack notation. The stack line is in the format filename(function_name+offset) [return_address_in_hex]. When referencing a stack frame in the command, enclose the line in double quotes (" "). The [return_address_in_hex] need not be included in the command.

The expected stack frame format is: fileName(functionName+offset), for example:

mtx(main+0x14af) [0x40ca8f]

or

mtx(_ZN6MtxRpf9Framework4initERKN7MtxUtil8EcbsmiIDEPKcS6_ii+0x4a)[0x40ecca]

Analyze a Test01 Stack Frame

analyze_stack_frame.py  "/home/workspace/MTX/test/Test01/Test01(_ZN58Test01_Header_Test8TestBodyEv+0xb10) [0x409b20]"