Home
MATRIXX Monitoring and Logging
Logging
The following describes logging information for MATRIXX.
Topology Operator Logging
Topology Operator and related components can be configured to log to STDOUT or a persistent volume (PV), similar to other MATRIXX components.

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.
  - Configuring MATRIXX Engine Logging
    The topics in this section provide information about maintaining, monitoring, and resolving problems with a MATRIXX Engine installation.
  - Network Enabler Logging in Kubernetes
    Network Enabler (NE) logs in a MATRIXX installation for Docker and Kubernetes must be written to a persistent volume so that they are retained if a NE container is re-created.
  - Changing System Logging Behavior
    Follow the procedures in this section to change the default rsyslog behavior and the log level for a MATRIXX business application or component.
  - Logging and Alerts
    Cloud native MATRIXX installations can replace or remove containers in the process of scaling or failure recovery. This presents challenges such as insuring log data persists after a container has been removed or replaced, and requiring to be able to view and search logs without having to log in to many individual containers.
  - Using Logs to Troubleshoot Problems
    This section contains information to help identify and resolve system problems.
  - Java-Based Container Logging
    Log output from applications running in containers must be written to persistent storage outside of the container to be preserved when the container is recreated after a failure or at application start.
  - Topology Operator Logging
    Topology Operator and related components can be configured to log to STDOUT or a persistent volume (PV), similar to other MATRIXX components.
- 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

Topology Operator Logging

Topology Operator and related components can be configured to log to STDOUT or a persistent volume (PV), similar to other MATRIXX components.

If the global.logging.output.persistentVolume property is set to false, the Topology Operator components generate log information at STDOUT only. When global.logging.output.persistentVolume is set to true, they generate log information at STDOUT and as files in shared logging storage.

For all types of shared storage, and for all MATRIXX components, when global.storage.type.createPersistentVolume is set to true, a PV is created at the location specified in global.storage.localStorageDir property (/home/data by default).

Topology Operator Log Output Directories describes the locations in shared logging storage where each component stores log files. Each directory is a subdirectory of the directory specified with the global.storage.localStorageDir property.

Table 1. Topology Operator Log Output Directories
Component	Directory
topology-operator	topology-operator
subdomain-operator	subdomain-operator-s`<subdomainId>`
pricing-operator	pricing-operator-s`<subdomainId>`
engine-operator	engine-operator-s`<subdomainId>`e`<engineId>`
pod-monitor	pod-monitor-s`<subdomainId>`e`<engineId>`
cluster-monitor	cluster-monitor-s`<subdomainId>`e`<engineId>`
topology-agent	Topology agent logs are saved in a directory with the same name as the pod, for example: `topology-agent-8fcc57755-2nn64`.
engine-starter	engine-starter-s`<subdomainId>`e`<engineId>`
engine-stopper	engine-stopper-s`<subdomainId>`e`<engineId>`
pre-update	topology-operator-pre-update
pre-delete	topology-operator-pre-delete

The topology-operator, subdomain-operator, pricing-operator, engine-operator, pod-monitor, cluster-monitor, and topology-agent logs rotate every day at a maximum size of 100 MB. The engine-starter, engine-stopper, pre-update, and pre-delete components log to a new file each time they are used.

For more information about cloud native logging, see the discussion about logging and alerts. For more information about Topology Operator, see the discussion about Topology Operator in MATRIXX Installation and Upgrade.