Home
MATRIXX Monitoring and Logging
Monitoring Components
The following information describes monitoring different components for MATRIXX.
Monitoring 5G Event Streaming
5G event streaming can be monitored with standard Kafka and custom metrics.
ASN.1 SFTP Sink Custom Metrics
The ASN.1 SFTP Sink application supports a number of metrics from different sources.

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 5G Event Streaming
    5G event streaming can be monitored with standard Kafka and custom metrics.
    - CDR ASN.1 Streamer Custom Metrics
      The CDR ASN.1 Streamer application supports a number of metrics from different sources.
    - CAF Metrics
      Prometheus can be used to monitor the CDR Aggregation Function (CAF) application and the Kafka cluster.
    - ASN.1 SFTP Sink Custom Metrics
      The ASN.1 SFTP Sink application supports a number of metrics from different sources.
    - CDR Kafka Router Metrics
      Use these metrics to monitor CDR Kafka Router application performance. CDR Kafka Router Metrics describes the recommended metrics for a CDR Kafka Router application dashboard.
    - CDR Kafka Replay Metrics
      Use these metrics to monitor CDR Kafka Replay microservice performance. CDR Kafka Replay Metrics describes the recommended metrics for a CDR Kafka Replay microservice dashboard.
    - Recommended Kafka Metrics
      You can use these metrics to monitor the performance of the CDR ASN.1 Streamer and ASN.1 SFTP Sink as Kafka producers, consumers, and streamers.
  - 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

ASN.1 SFTP Sink Custom Metrics

The ASN.1 SFTP Sink application supports a number of metrics from different sources.

Kafka consumer, producer, and streamer metrics
JVM metrics
Custom metrics

ASN.1 SFTP Sink Custom Metrics describes the custom metrics supported by the ASN.1 SFTP Sink application.

Table 1. ASN.1 SFTP Sink Custom Metrics
Name	Description	Type
mtx_events_sink_sftp_uploads_successful_total	The cumulative count of successful uploads to the SFTP server.	Counter
mtx_events_sink_sftp_uploads_ready	The number of files awaiting upload to the SFTP server.	Gauge
mtx_events_sink_sftp_buffer_closures_total	The cumulative count of buffer/file closures.	Counter
mtx_events_sink_sftp_condition_expired_total	The cumulative count of times the File Expired condition has triggered.	Counter
mtx_events_sink_sftp_condition_size_total	The cumulative count of times the File Size condition has triggered.	Counter
mtx_events_sink_sftp_condition_volume_total	The cumulative count of times the Volume Size condition has triggered.	Counter
mtx_events_sink_sftp_condition_always_total	The cumulative count of times the testing condition Always has triggered.	Counter
mtx_events_sink_sftp_records_count_total	The cumulative count of records received and processed.	Counter

ASN.1 SFTP Sink Kafka Client (Consumer) Metrics describes the consumer metrics recommended for dashboards.

Table 2. ASN.1 SFTP Sink Kafka Client (Consumer) Metrics
Source	Metric
Kafka Client (Consumer)	kafka_consumer_fetch_manager_records_lag_max kafka_consumer_fetch_manager_records_lag kafka_consumer_fetch_manager_bytes_consumed_rate kafka_consumer_fetch_manager_records_consumed_rate kafka_consumer_fetch_manager_fetch_rate

ASN.1 SFTP Sink Custom Metrics describes tags supported by the metrics described in ASN.1 SFTP Sink Custom Metric Tags.

Table 3. ASN.1 SFTP Sink Custom Metric Tags
Name	Description	Example
application	The Java application ID.	asn1-sftp-sink
instance	The `host`:`port` part of the target URL.	sink:8182
job	The configured job name to which the target belongs.	sink
nodeId	Configured property. See sftp.internal.uploader.fileFormat.nodeId. If no value is specified, the value returned is `unspecified`.	asn1-sink-1