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.
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.
Denial Codes in 5G
Denial codes in 5G are very similar to the Diameter denial codes used in 4G, in that denial codes provide a way to deny service access to subscribers for a specific reason. You define the denial codes in My MATRIXX and add the codes to rate table rows in place of a rating formula. A value is returned to the network based on which row is selected during rating.

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.
      - Denial Codes in 5G
        Denial codes in 5G are very similar to the Diameter denial codes used in 4G, in that denial codes provide a way to deny service access to subscribers for a specific reason. You define the denial codes in My MATRIXX and add the codes to rate table rows in place of a rating formula. A value is returned to the network based on which row is selected during rating.
    - 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.
  - 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

Denial Codes in 5G

Denial codes in 5G are very similar to the Diameter denial codes used in 4G, in that denial codes provide a way to deny service access to subscribers for a specific reason. You define the denial codes in My MATRIXX and add the codes to rate table rows in place of a rating formula. A value is returned to the network based on which row is selected during rating.

When a denial is encountered during rating, the rating process stops in a manner that is similar to when a hard credit limit is reached. No additional rate tables or product offers are examined for valid rates. During usage rating, each event segment is checked for a denial. For example, a data charge might use a "peak, offpeak, and weekend" normalizer to charge a different amount based on time-of-day and day of week. The charge can be configured to have a denial code formula associated with the "weekend" parameter to disallow data usage at this time.

During non-usage rating (purchase, cancel, recurring, first-use, and auto-renew), a denial indicates a failure to do the corresponding operation. A failure to perform recurring or first usage pricing does not impact whether usage can still occur. For example, if a recurring charge fails to allocate a monthly asset, usage might still be authorized as an overage. Or, failure to apply a first-usage charge to a balance does not prevent usage charges from being applied.

When the network interface to upstream systems is based on 5G, the following mapping is applied. Mapping Between Denial Codes and 5G Result Codes shows the mapping between the (customer-defined) denial codes you can create and the 5G result codes returned in the 5G charging data response.

Note: Denial code values 400 - 9,999 are reserved for customers, while values 10,000 and greater are reserved for MATRIXX.

Table 1. Mapping Between Denial Codes and 5G Result Codes
Denial Code	Result Code MDC field	multipleUnitInformation resultCode AVP
1-99	4	SERVICE_REJECTED
100-199	3	QUOTA_LIMIT_REACHED
200-299	6	RATING_FAILED
300-399	1	SERVICE_DENIED
400-9,999	1	SERVICE_DENIED
10,000-10,099	2	QUOTA_MGMT_NOT_APPLICABLE

For example, if you receive a denial code 320, the 5G charging data response includes the result code of 1, which returns the resultCode value SERVICE_DENIED. This means the service request was denied due to service restrictions or limitations related to the subscriber, for example the subscriber's balances could not cover the requested service.