3 OSO Services

Oracle Communications Operations Services Overlay (OSO) provides the following observability services to help users observe the behavior of applications running in their cloud native environment.

3.1 Metrics

This section describes the observability metrics provided by the OSO services.

3.1.1 Metrics Collection

OSO uses Prometheus to collect metrics from all the Cloud Native Core (CNC) applications deployed in the user's CNE. Prometheus collects metrics from the following:

  • OSO services: Prometheus collects and stores metrics generated by the OSO services, such as Prometheus and AlertManager.
  • CNC Network Functions: OSO Prometheus receives customer metrics generated and delivered by the CNC NFs.

3.1.2 Storing Metrics

OSO Prometheus stores all the metrics in an internal Time Series Database (TSDB).

3.1.3 Support for Time Series Database (TSDB) Snapshot

Prometheus uses Time Series Database (TSDB) to store the metrics. Along with metric storage, OSO captures a snapshot at a specific point of time with the available data in the Prometheus data store. OSO allows you to capture these snapshots without shutting down or disrupting the Prometheus instance.

This feature can be used for the following:
  • Backups
  • Recovery
  • Debugging

For more information about the procedure for capturing TSDB snapshots, see the "Creating Backup of Prometheus Time Series Database (TSDB) Using Snapshot Utility" section in Oracle Communications Cloud Native Core, Operations Services Overlay Installation and Upgrade Guide.

3.2 OSO Alerts

OSO uses AlertManager to raise alerts. These alerts inform the user about the aspect of OSO that requires attention.

The applications deployed on OSO define their alerts to inform the user about the problems specific to each application. For more information on how applications can load alerting rules, see the Updating Alert Rules for an NF section.

Automated Configuration of NF Alerts

From release 25.1.200 onwards, OSO offers an automated mechanism to configure NF alerts after the successful deployment of all respective NFs and OSO components. This feature streamlines the management of OSO alert rules by dynamically updating the Prometheus ConfigMap during the Helm chart installation or upgrade process. As a result, manual intervention is minimized, ensuring consistent and efficient alert rule deployment across environments.

For more information about automation of alert configuration in OSO, see the "Automated Configuration of NF Alerts" section in Oracle Communications Cloud Native Core, Operations Services Overlay Installation and Upgrade Guide.

3.2.1 Alert Forwarding to Kafka

With this feature, OSO introduces a Alert Processing Microservice (APM) that consumes HTTP-based alerts from OSO (Alert manager), converts them into Kafka-compatible JSON messages, and publishes them to a designated Kafka cluster. This feature can be deployed independently using a dedicated Helm chart, offering flexibility to add or remove it without affecting the core OSO platform components.

Figure 3-1 Alert Forwarding to Kafka


Alert Forwarding to Kafka

The image illustrates the alert processing flow enabled by the APM within OSO:
  1. Prometheus continuously monitors the system metrics and applies alert rules to detect issues or threshold breaches.
  2. When an alert condition is met, Prometheus sends the alert to the Alert Manager within OSO. The Alertmanager aggregates the incoming alerts for further processing based on the configuration.
  3. The Alert Manager sends the processed alert as a JSON payload via an HTTP POST request to the Cluster IP.
  4. The APM receives the HTTP POSTed alert.
  5. APM’s Kafka client converts the alert into a Kafka-compatible JSON message. It manages retries, backoff, and delivery timeouts for reliable delivery.
  6. APM publishes the alert to the Kafka Cluster.
  7. The Kafka Cluster stores the alerts.

Managing the Alert Forwarding to Kafka

The APM feature is optional in OSO. It is not enabled by default and must be explicitly installed and configured if alert forwarding to Kafka is needed. If omitted, core OSO functionality is unaffected.

This section lists the Helm configuration details for this feature.

This feature can be enabled or disabled at the time of OSO deployment using the following Helm parameters:

Perform the following configuration to enable this feature using the Helm:

  1. Open the ocoso_csar_25_2_200_0_0_0_apm_custom_values.yaml file.
  2. Set the value of apmEnabled to true to enable the alert forwarding to Kafka cluster using APM.
  3. Configure the values for the following parameters:
    • env.kafkaIp -Indicates the external bootstrap service IP, which maps to the Kafka brokers.
    • env.kafkaPort -Indicates the external bootstrap service port which maps to the Kafka brokers.
    • env.kafkaTopic -Indicates the Kafka topic to which APM will publish alert messages.
    • env.kafkaGroupId -Indicates a name that the user provides for the Kafka group id.

    Note:

    Configure the following parameters in the ocoso_csar_25_2_200_0_0_0_alm_custom_values.yaml file.
    
config:
   receivers:
    - name: default-receiver
       webhook_configs:
         - url: 'http://APM-SVC-NAME.NAMESPACE.svc:APM-SVC-PORT/webhook'
           send_resolved: true

    For more information about the parameters, see Oracle Communications Cloud Native Core, Operations Services Overlay Installation and Upgrade Guide.

  4. Save the file.
  5. Install OSO. For more information about the installation procedure, see Oracle Communications Cloud Native Core, Operations Services Overlay Installation and Upgrade Guide.

Observability

Metrics

There are no metrics related to this feature.

Alerts

There are no alerts related to this feature.

KPIs

There are no new KPIs related to this feature.