Home
MATRIXX Monitoring and Logging
Monitoring Components
The following information describes monitoring different components for MATRIXX.
Monitoring MATRIXX SBA Gateway
The MATRIXX SBA Gateway SNMP statistics are defined in the matrixx_web_mib.txt file, using the snmp-net-utils snmpwalk command to display them.
Using SNMP Traps Instead of Prometheus Metrics
The SBA Gateway captures metrics in Prometheus format by default. However, if your environment does not have a Prometheus instance, complete these tasks to obtain these metrics as SNMP traps delivered to your SNMP network management system (NMS). The SNMP Prometheus Adapter can act as a bridge between the two formats by converting the captured Prometheus metrics to SNMP format.
Configuring SNMP Prometheus Adapter
You configure the SNMP Prometheus Adapter using the snmp-adapter.yaml file, which is read from /opt/mtx/conf. This file contains the entries detailed in the sections below.
Configuring SNMP Trap Destinations
When determining where SNMP notifications (traps) are sent, you can define one or more SNMP servers in the SNMP network management system (NMS) properties file, which is in the snmp-adapter.yaml file. This is only needed if you are pushing SNMP traps. For SNMP metrics, the NMS server must be configured with information about the MATRIXX SNMP Adapter. However, such configuration details are vendor-specific and are beyond the scope of this documentation.

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.
  - Monitoring MATRIXX Business API Gateway
    Business API Gateway SNMP statistics are defined in the matrixx_web_mib.txt file and you display them using the snmp-net-utils snmpwalk command.
  - Monitoring MATRIXX Call Control Framework
    The topics in this section have information about monitoring Call Control Framework (CCF) components, including Network Enabler and CAMEL Gateway.
  - Monitoring Diameter Events
    Diameter Event Logger listens to the Diameter Gateway through a TCP connection and logs diameter application messages to a JSON file.
  - Monitoring Event Streaming
    Event streaming errors are logged in the Event Streaming Framework mtx_event_streamer.log file. Event Streaming Framework uses Log4j 2.x to log error, debugging, and informational messages. You can also monitor event streaming performance using the performance_analysis_event_server.py script. For information about the script, see the discussion about performance_analysis_event_server.py.
  - Monitoring MATRIXX Route Cache
    Monitor the Route Cache by reading watermark log messages for each Route Cache table and Route Cache SNMP statistics. The SNMP statistics are defined in the matrixx_rc_mib.txt MIB file and returned by the print_snmp_stats.py script. They include statistics on subscriber and session data, statistics on insert, fetch, erase, and iterator operations, general statistics on subscriber records, and garbage collection.
  - Monitoring Payment Service Logging
    Payment service logs messages to the payment-service.log.
  - Monitoring MATRIXX SNMP Statistics
    By default, the SNMP Agent running on a MATRIXX Engine monitors the status and health of all the servers and clusters it has. It collects statistics to aid in identifying potential processing issues.
  - Monitoring MATRIXX Traffic Routing Agent
    Traffic Routing Agent SNMP statistics are defined in the matrixx_tra_mib.txt MIB file and are returned by the print_snmp_stats.py script when run on any of the Traffic Routing Agent servers. They include categories such as TCP traffic, UDP traffic, Diameter Gateway traffic, and MDC Gateway traffic.
  - Monitoring MATRIXX Web Apps
    Use the MATRIXX system logs and SNMP statistics and notifications to monitor the MATRIXX web-facing applications, such as RS Gateway, Gateway Proxy, and My MATRIXX.
  - Monitoring MATRIXX SBA Gateway
    The MATRIXX SBA Gateway SNMP statistics are defined in the matrixx_web_mib.txt file, using the snmp-net-utils snmpwalk command to display them.
    - Monitoring SBA Gateway with Prometheus
      SBA Gateway network functions include a Prometheus client that exposes various metrics, such as memory usage or the number of incoming HTTP requests. The Prometheus client is enabled by default, but it can be disabled if required.
    - Configuring SBA Gateway Logging
      SBA Gateway uses log4j2 to configure logging. You can change or override the default log4j2 settings using environment variables.
    - Using a Generic SNMP Trap
      To send a generic SNMP trap, you can use any process, rather than the standard Process Controller, Cluster Manager, SNMP agent, or TRA. The trap has error information, with specific alerts that relate back to specific error numbers. You can use the sysGenericErrorMessage SNMP trap to send out a system level alert with message text in the payload.
    - Using SNMP Traps Instead of Prometheus Metrics
      The SBA Gateway captures metrics in Prometheus format by default. However, if your environment does not have a Prometheus instance, complete these tasks to obtain these metrics as SNMP traps delivered to your SNMP network management system (NMS). The SNMP Prometheus Adapter can act as a bridge between the two formats by converting the captured Prometheus metrics to SNMP format.
      - Configuring SNMP Prometheus Adapter
        You configure the SNMP Prometheus Adapter using the snmp-adapter.yaml file, which is read from /opt/mtx/conf. This file contains the entries detailed in the sections below.
        Configuring SNMP Agent Properties
        When configuring the SNMP agent, you can define the SNMP agent properties to expose the SNMP metrics and send the proper notifications to the SNMP servers.
        Configuring SNMP Trap Destinations
        When determining where SNMP notifications (traps) are sent, you can define one or more SNMP servers in the SNMP network management system (NMS) properties file, which is in the snmp-adapter.yaml file. This is only needed if you are pushing SNMP traps. For SNMP metrics, the NMS server must be configured with information about the MATRIXX SNMP Adapter. However, such configuration details are vendor-specific and are beyond the scope of this documentation.
        Configuring SNMP Alarms for Log Files
        When configuring SNMP alarms you must specify which log files to monitor, what patterns to look for, and what types of notifications to send when an event matches a log entry.
        Configuring SNMP Metrics
        When configuring SNMP metrics, you must define one or more Prometheus HTTP endpoints to poll, and one or more mapping rules to convert the Prometheus metric data into SNMP metrics.
      - SBA Default Configuration in SNMP Prometheus Adapter
        The SNMP Prometheus Adapter includes an SBA default configuration which you can activate using the SBA spring profile. This default configuration automatically defines the alarm matching rules and metrics mapping rules.
      - Deploying the SNMP Prometheus Adapter
        You can deploy the SNMP Prometheus Adapter in various ways, depending on your MATRIXX environment.
  - Monitoring 5G Event Streaming
    5G event streaming can be monitored with standard Kafka and custom metrics.
  - Monitoring Kafka CDR Consumer
    Use aggregated logging and the Prometheus and Grafana third-party products to monitor Kafka CDR Consumer.
- Appendixes
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

Configuring SNMP Trap Destinations

When determining where SNMP notifications (traps) are sent, you can define one or more SNMP servers in the SNMP network management system (NMS) properties file, which is in the snmp-adapter.yaml file. This is only needed if you are pushing SNMP traps. For SNMP metrics, the NMS server must be configured with information about the MATRIXX SNMP Adapter. However, such configuration details are vendor-specific and are beyond the scope of this documentation.

SNMP NMS Properties and Defaults shows the SNMP NMS property definitions, URLs where the notifications will be sent, and default values.

Table 1. SNMP NMS Properties and Defaults
Property Name	Description	Default Value
snmp-adapter.nms.default.host	The host name (or IP address) of the SNMP NMS.	N/A
snmp-adapter.nms.default.notificationPort	The port where the NMS will receive SNMP notifications (traps).	162
snmp-adapter.nms.default.timeout	The duration for which the connection to the SNMP NMS will wait before it times out. Postfix the value with an s to indicate seconds, m for minutes or ms for milliseconds.	5s
snmp-adapter.nms.default.retries	The number of times the sending will retry.	2

The following shows a sample SNMP NMS in the YAML configuration file.

snmp-adapter:
  nms:
    default:
      host: localhost
      notificationPort: 162
      timeout: 5s
      retries: 1

The properties and YAML above define a single NMS called 'default'. You can define different entries by using different names. The name in the example above is used for display purposes and as a way to separate the configurations.

To configure the SNMP Prometheus Adapter to enable SNMP traps, you must add an IP address or hostname to your configuration, which should look similar to that shown above.

For more information about MIB system notifications, see the discussion about system notifications.