Home
MATRIXX Monitoring and Logging
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.
Monitoring with Prometheus and Grafana
The following information describes how to implement monitoring through Prometheus in a containerized environment for MATRIXX. Information collected by Prometheus can be displayed with tools such as Grafana.
Java Application Monitoring
Java application monitoring is facilitated by Micrometer Stats Exporter and Spring Boot Actuator.

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.
  - Monitoring with Prometheus and Grafana
    The following information describes how to implement monitoring through Prometheus in a containerized environment for MATRIXX. Information collected by Prometheus can be displayed with tools such as Grafana.
    - Installing Prometheus and Grafana
      Most Kubernetes environments offer a Prometheus and Grafana stack, often disabled by default.
    - Using Prometheus without ServiceMonitor
      Enabling monitoring with the MATRIXX Helm chart global.monitoring.enabled property installs a ServiceMonitor custom resource definition (CRD). When Prometheus is installed with the Prometheus operator, it discovers this CRD and configures itself to collect metrics from MATRIXX endpoints. If you install Prometheus without the operator, you must manually configure Prometheus to point to MATRIXX endpoints and configure the MATRIXX Helm chart to add annotations to the pods.
    - Prometheus Metrics Dashboard
      Prometheus metrics can be viewed directly in the Prometheus dashboard.
    - Grafana Dashboards
      To display MATRIXX metrics, MATRIXX provides Grafana dashboard templates in JSON format.
    - MATRIXX Engine and TRA Monitoring
      After you have implemented monitoring through Prometheus, you can refer to metrics for MATRIXX Engine and Traffic Routing Agent (TRA) described in this section.
    - Java Application Monitoring
      Java application monitoring is facilitated by Micrometer Stats Exporter and Spring Boot Actuator.
      - System Monitor Metrics
        System Monitor provides only one metric to Prometheus: MonitoredObject{key="name"} "value."
      - Health Checker Metrics
        Health Checker Metrics describes the metrics available to Prometheus from the inter-engine communication health check of the sub-domain health checker in a Topology Operator-based deployment.
      - Generic JVM/System Metrics
        docker_kubernetes/r_prom_jvm_system.html#r_prom_jvm_system__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for the Java Virtual Machine (JVM) and the larger system.
      - Spring MVC HTTP Request Metrics
        docker_kubernetes/r_prom_spring_mvc_req.html#r_prom_spring_mvc_req__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for the number of requests processed and time spent processing by Spring MVC framework.
      - Gateway/Web App Request Metrics
        docker_kubernetes/r_prom_apps_common.html#r_prom_apps_common__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for the number of requests processed by RS Gateway, MATRIXX Backoffice Customer Tool, and My MATRIXX.
      - RS Gateway Metrics
        RS Gateway Duration Metrics Explained describes the three types of duration metrics for RS Gateway HTTP web requests processed by MATRIXX Engine.
      - Notification Framework Metrics
        docker_kubernetes/r_prom_notifier.html#r_prom_notifier__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for Notification Framework.
      - Event Streaming Framework Metrics
        docker_kubernetes/r_prom_event_streamer.html#r_prom_event_streamer__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for Event Streaming Framework.
      - Payment Service Metrics
        docker_kubernetes/r_prom_payment_service.html#r_prom_payment_service__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for Payment Service.
      - Gateway Proxy Metrics
        docker_kubernetes/r_prom_gtwy_proxy.html#r_prom_gtwy_proxy__table_dhn_rvl_spb describes the metrics exported by Micrometer Stats Exporter for Gateway Proxy.
      - External Diameter Gateway Prometheus Metrics
        The following metrics are available for the External Diameter Gateway.
      - TMF Metrics
        Use the following recommended metrics to build a TMF Gateway (TMF) Grafana dashboard. TMF Metrics describes the recommended metrics for a TMF dashboard on the HTTP Server (incoming requests from the network).
    - Viewing MATRIXX SNMP Stats with Grafana
      Use Grafana to display MATRIXX SNMP statistics and other metrics exported to Prometheus, using MATRIXX-provided custom Grafana dashboard templates.
    - Monitoring Network Enabler with Prometheus
      Network Enabler (NE) SNMP statistics can be monitored with Prometheus.
  - Cluster HA States
    A cluster can change high availability (HA) states during engine start up, manual switchover, failover, and when the connection to a remote peer cluster is lost.
  - MATRIXX Engine Start-Up Sequence
    A Topology Operator engine-starter instance starts MATRIXX Engine and engine-level Traffic Routing Agent (TRA-PROC and TRA-PUB) pods.
  - Monitoring the MATRIXX Engine Environment Locally
    The following topics explain how to monitor the MATRIXX Engine locally using the internal MATRIXX Engine tools.
  - Custom System Monitor Configuration
    You configure the optional MATRIXX System Monitor by editing the sysmon_config.xml file. After the file is configured, System Monitor continuously monitors the MATRIXX Engine processing pod.
  - Alert Management Integration with SNMP Traps
    In a Cloud Native environment you can integrate the statistics and metrics data collected by Prometheus with other systems, such as Alert Manager, and you can configure snmp-notifier to convert the generated alerts to SNMP traps for reporting in external monitoring systems.
  - Retrieving Core Dump Information
    Core dumps are files that include the complete contents of the memory of a process at a point in time. Core dump handling in MATRIXX must be enabled per namespace. By default this feature is disabled and the commonly mounted /coredumps directory is empty until this feature is enabled.
- 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.
- 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

Java Application Monitoring

Java application monitoring is facilitated by Micrometer Stats Exporter and Spring Boot Actuator.

Micrometer Stats Exporter

MATRIXX Java-based gateways and web apps use an auto-configured Micrometer Stats Exporter to export metrics to Prometheus. The Micrometer project also provides a Grafana dashboard that can be used to monitor applications.

Spring Boot Actuator

The Spring Boot Actuator endpoint is exposed at the /actuator/prometheus context path and exposes metrics in a format that can be scraped by a Prometheus server. The application.yaml file requires additional configuration to expose the Prometheus endpoint. Non-Spring Boot applications must expose a similar HTTP endpoint. For an example, see the Micrometer documentation.