Home
MATRIXX 5G Event Streaming
Configuring 5G Event Streaming
Configure 5G event streaming by providing values for properties in one or more Helm values files.
Autoscaling
The Helm chart deploys the 5G event streaming applications using a fixed number of replicas. The number of replicas can be configured to scale based on application metrics such as average memory or CPU usage.

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
- About MATRIXX 5G Event Streaming
  MATRIXX 5G Event Streaming describes how to aggregate and stream charging data records (CDRs) from the SBA Gateway to an sFTP server using a Kafka broker.
- 5G Event Streaming Overview
  SBA Gateway can stream HTTP requests and MATRIXX Engine HTTP responses to a Kafka broker. The 5G event streaming applications convert the received JSON objects to ASN.1 binary format for export to Kafka applications and can optionally aggregate and route based on content. The GTP Prime Adapter microservice is provided for sending records from Kafka to a GPRS Tunneling Protocol (GTP) server.
- Converting CDRs to ASN.1 Format
  Charging data records (CDRs) are processed by the CDR ASN.1 Streamer Kafka client application to convert them from JSON into ASN.1 objects. After the ASN.1 objects are serialized as a binary message using Basic Encoding Rules (BER), they are placed in another Kafka topic for further processing. The ASN.1 sFTP Sink application then writes the message to file before transferring it over Secure FTP (sFTP).
- sFTP Sink Microservice Deployment
- ASN.1 Record Naming and Counting
  Each time the ASN.1 sFTP Sink application receives a batch of records, if the number of records is greater than or equal to the configured closure condition, the aggregated ASN.1 record is generated. Otherwise, the batch is held for the next ASN.1 record.
- CDR Aggregation Function
  Every request received by SBA Gateway from the SMF results in the creation of a 5G event, also known as a network _glossary/cdr.html. To avoid sending excessive records to a downstream system, CDRs must be aggregated on a per session basis so that only summary level CDRs are sent to third-party CGF or the BSS domain. The CDR Aggregation Function (CAF) application is a Kafka Streams application that aggregates network interactions handled by SBA Gateway on the 5G N40 interface.
- Content-Based CDR Routing
  The CDR Kafka router republishes each _glossary/cdr.html based on its content, either as received or enriched with additional data on a conditional basis.
- Write To Disk
  When Kafka is unavailable, the producer continues attempting to send to the Kafka broker until a timeout is reached. On timeout, the records are written to a separate log file on disk.
- Record Formats and Schemas
  Request and response records are sent in JSON format.
- Kafka Partition Key
  The Kafka partition key used is the SessionId for the exchange. If none is available, for example if there is an error returned by the engine, then no partition key is used.
- Installing 5G Event Streaming Applications
  The 5G event streaming applications are delivered as images for container creation in a Kubernetes cluster using a Helm chart. The following sections describe the installation process. The procedures assume you have knowledge of and access to the kubectl tool.
- Configuring 5G Event Streaming
  Configure 5G event streaming by providing values for properties in one or more Helm values files.
  - Docker Registry Configuration
    The following properties relate to the Docker registry hosting the 5G event streaming images at your site.
  - Service Account Configuration
    Kubernetes pods for 5G event streaming run under a single Kubernetes ServiceAccount that has the required role-based access control (RBAC) roles bound to it. The ServiceAccount, roles, and role bindings are created by default. An alternate, existing ServiceAccount can be specified if required.
  - Logging Configuration
    Network CDR components can log to a shared persistent volume. This is configured through the logging section in the chart values.
  - Message Broker Configuration
    Message broker configuration settings are used to specify the message broker, for example, Kafka, for sending and receiving messages. Connections between Kafka topics are also configurable.
  - Autoscaling
    The Helm chart deploys the 5G event streaming applications using a fixed number of replicas. The number of replicas can be configured to scale based on application metrics such as average memory or CPU usage.
  - Pod and Container Configuration
    5g_integration/c_5g_cb_config_pod_cont.html#c_5g_cb_config_pod_cont__table_uzz_xhk_xlb describes the properties related to general pod and container characteristics.
  - Pod Label Configuration
    Pods can be labeled globally using the labels.podLabels property and per-component using an app.label.podLabels configuration property. Labels added globally are added to all pods in the installation. Labels defined for a specific component are added to pods for that app, in addition to any globally defined labels.
  - Service Configuration
    5G event streaming applications each have a defined Kubernetes service.
  - Prometheus Monitoring Configuration
    5g_integration/c_5g_events_config_prometheus.html#c_5g_event_config_prometheus__table_uzz_xhk_xlb describes properties for configuring Prometheus.
  - Mapping
    Mapping configuration files can be supplied to the CDR ASN.1 Streamer in a configuration source. You can also supply your configuration mapping file changes directly with Helm chart properties.
- Configuring the Applications
  The 5G event streaming applications are configured in the Helm values file, the nf.yaml file, and an application.yaml files for each application.
- Applying Configuration
  You can apply configuration for 5G event streaming applications in several ways using the Helm values chart. These methods are not mutually exclusive and can be used together.
- Appendixes
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
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

Autoscaling

The Helm chart deploys the 5G event streaming applications using a fixed number of replicas. The number of replicas can be configured to scale based on application metrics such as average memory or CPU usage.

Autoscaling Properties describes the properties related to application scaling control.

Table 1. Autoscaling Properties
Property	Description
`application`.replicaCount	The number of pods to deploy for this application. This value is ignored if the corresponding `application.autoscaling.enabled` property is set to true. The default value is 1.
`application`.autoscaling.enabled	If set to `true`, then the corresponding `application.replicaCount` property is ignored and a horizontal pod auto scaler is created. See the discussion about the horizontal pod auto scaler in Kubernetes documentation at the Kubernetes website. The default value is `false`.
`application`.autoscaling.minReplicas	The minimum number of pods that the application must have at any one time. This property is only applicable if the corresponding `application.autoscaling.enabled` property is set to `true`. The default value is 2.
`application`.autoscaling.maxReplicas	The maximum number of pods that the application must have at any one time. Only applicable if the corresponding `application.autoscaling.enabled` property is set to `true`. The default value is 6.
`application`.autoscaling.targetCPUUtilizationPercentage	The target CPU usage percentage. If this value is exceeded, the number of pods is increased. Only applicable if the corresponding `application.autoscaling.enabled` property is set to `true`.
`application`.autoscaling.targetMemoryUtilizationPercentage	The average memory usage percentage. If this value is exceeded, the number of pods is increased. Only applicable if the corresponding `application.autoscaling.enabled` property is set to `true`.

Note: Austoscaling is not available for the ASN.1 sFTP Sink application as it is deployed using a StatefulSet.

The following example shows configuration of autoscaling for the CDR ASN.1 Streamer application:

cdr-asn1-streamer:
  autoscaling:
    enabled: true
    minReplicas: 2
    maxReplicas: 10
    targetCPUUtilizationPercentage: 90