Home
MATRIXX Monitoring and Logging
Monitoring Components
The following information describes monitoring different components for MATRIXX.
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.
Web App Logging
When a user successfully logs into My MATRIXX or MATRIXX Backoffice Customer Tool, logs include the session ID associated with the user. This information can be used for security tracking and to track operations performed by individual users.
Configure Audit Logging for MATRIXX Backoffice Customer Tool
By default, audit logging is disabled for MATRIXX Backoffice Customer Tool. To enable logging, set mtx.audit.enabled to true. Configure audit logging using the application-default.yaml configuration file.

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.
    - Web App Logging
      When a user successfully logs into My MATRIXX or MATRIXX Backoffice Customer Tool, logs include the session ID associated with the user. This information can be used for security tracking and to track operations performed by individual users.
      - View Session IDs
        When users log in to a web app, a log message containing the session ID and user ID is written to the log file for the web app.
      - Configure Audit Logging for MATRIXX Backoffice Customer Tool
        By default, audit logging is disabled for MATRIXX Backoffice Customer Tool. To enable logging, set mtx.audit.enabled to true. Configure audit logging using the application-default.yaml configuration file.
        MATRIXX Backoffice Customer Tool Audit Logging Properties
        customer_manager/r_audit_logging_props.html#reference_fdv_psx_mwb__table_uzz_xhk_xlb describes the properties in the application-default.yaml file that configure audit logging for MATRIXX Backoffice Customer Tool.
    - Monitoring the Web Apps SNMP Statistics
      Use the snmp-net-utils snmpwalk command to display SNMP statistics for the MATRIXX web-facing applications.
  - 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 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

Configure Audit Logging for MATRIXX Backoffice Customer Tool

By default, audit logging is disabled for MATRIXX Backoffice Customer Tool. To enable logging, set mtx.audit.enabled to true. Configure audit logging using the application-default.yaml configuration file.

Procedure

Open the application-default.yaml file located at /opt/mtx/conf/webapps/matrixxbct/classes/config/. If the file and directory do not exist, create them and add the following as the default configuration:
```
mtx:
  audit:
    filter:
      default: true
    enabled: false
    log:
      request: true
      response: true
      permethod: true
    prefixes: /matrixxbct/api/,/matrixxbct/services/
```
Set mtx.audit.enabled to true to enable MATRIXX Backoffice Customer Tool audit logging.
Save the file.
Enter the following command to restart MATRIXX Backoffice Customer Tool:
systemctl restart mtx_matrixxbct