Home
MATRIXX Administration
Administering MATRIXX Engine
The topics in this section have information about maintaining, managing, and resolving issues with a MATRIXX Engine installation.
Managing Checkpoints and Transaction Logs
Follow the procedures in this section to change the default checkpointing behavior, create a checkpoint manually, and delete old transaction logs and transaction log files.
Create a Database Checkpoint Manually
You can manually create a database checkpoint outside of the configured checkpoint interval. For example, create a checkpoint before restarting an engine to reduce the number of transaction log files that must be replayed to get the engine restored.
create_checkpoint.py
The create_checkpoint.py script creates database checkpoints on demand. If you specify a checkpoint name, it creates the checkpoint in the local /var/log/mtx/local/checkpoints directory. If you do not specify a checkpoint name, this script generates the checkpoint in the default checkpoint directory (${MTX_SHARED_DIR}/checkpoints) on the local server. Run this script as user mtx.

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.
  - Checking the Statuses of MATRIXX Engine Services and Shared Storage
    Follow the procedures in this section to check whether MATRIXX Engine services are running and to check the configuration and state of the shared storage.
  - Displaying Information About MATRIXX Engine Components
    Follow the procedures in this section to display information about MATRIXX Engine components, such as pod or server and engine IDs, software version numbers, _glossary/mef.html contents, pricing configuration information, and MATRIXX Engine version information. For information about displaying MATRIXX Engine statistics, see MATRIXX Monitoring and Logging.
  - Managing Checkpoints and Transaction Logs
    Follow the procedures in this section to change the default checkpointing behavior, create a checkpoint manually, and delete old transaction logs and transaction log files.
    - Database Checkpoints
      Database checkpoints contain an exact snapshot of the in-memory databases (IMDBs) and configuration files at a specific time. Periodic database checkpoints are used to recover data from whole cluster failures and to reinstate an active processing cluster from a standby processing cluster after a disaster recovery operation. Use on-demand checkpoints for data analysis, setting up test environments, and troubleshooting. You confirm checkpoints using the validateCheckpoint.jar utility.
    - Create a Database Checkpoint Manually
      You can manually create a database checkpoint outside of the configured checkpoint interval. For example, create a checkpoint before restarting an engine to reduce the number of transaction log files that must be replayed to get the engine restored.
      - create_checkpoint.py
        The create_checkpoint.py script creates database checkpoints on demand. If you specify a checkpoint name, it creates the checkpoint in the local /var/log/mtx/local/checkpoints directory. If you do not specify a checkpoint name, this script generates the checkpoint in the default checkpoint directory (${MTX_SHARED_DIR}/checkpoints) on the local server. Run this script as user mtx.
  - Throttle the Incoming Event Rate
    Perform the tasks in this section if you did not set the incoming event rate as part of your base configuration process.
- 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
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

create_checkpoint.py

The create_checkpoint.py script creates database checkpoints on demand. If you specify a checkpoint name, it creates the checkpoint in the local /var/log/mtx/local/checkpoints directory. If you do not specify a checkpoint name, this script generates the checkpoint in the default checkpoint directory (${MTX_SHARED_DIR}/checkpoints) on the local server. Run this script as user mtx.

Syntax

create_checkpoint.py [-h] [ checkpoint_name ]

Options

checkpoint_name: The name of the checkpoint to create. For details about the database checkpoint filename syntax, see the discussion about database checkpoints in MATRIXX Architecture.
-h, --help: Displays the help.

For more information about the MATRIXX environment variables, see the discussion about container directories and environment variables in MATRIXX Installation and Upgrade.

Creates a Checkpoint in the Default Location

Creates a checkpoint in ${MTX_SHARED_DIR}/checkpoints:

create_checkpoint.py

Creates a Checkpoint in /var/log/mtx/local/checkpoints

Creates a checkpoint with the name test_checkpoint in var/log/mtx/local/checkpoints:

create_checkpoint.py test_checkpoint