You can set up monitoring of your ECE components in a cloud native environment. When configured to do so, ECE exposes JVM, Coherence, and application metric data through a single HTTP endpoint in an OpenMetrics/Prometheus exposition format. You can then use an external centralized metrics service, such as Prometheus, to scrape the ECE cloud native metrics and store them for analysis and monitoring.

ECE cloud native exposes metric data for the following components by default:

• ECE Server

• BRM Gateway

• Customer Updater

• Diameter Gateway

• EM Gateway

• HTTP Gateway

• CDR Formatter

• Pricing Updater

• RADIUS Gateway

• Rated Event Formatter

Setting up monitoring of these ECE cloud native components involves the following high-level tasks:

1. Ensuring that the ECE metric endpoints are enabled. See "Enabling ECE Metric Endpoints".

   ECE cloud native exposes metric data through the following endpoint: http://localhost:19612/metrics.

2. Setting up a centralized metrics service, such as Prometheus Operator, to scrape metrics from the endpoint.

   For an example of how to configure Prometheus Operator to scrape ECE metric data, see "Sample Prometheus Operator Configuration".

3. Setting up a visualization tool, such as Grafana, to display your ECE metric data in a graphical format.

The default ECE cloud native configuration exposes JVM, Coherence, and application metric data for all ECE components to a single REST endpoint. If you create additional instances of ECE components, you must configure them to expose metric data.

To ensure that the ECE metric endpoints are enabled:

1. Open your override-values.yaml file for oc-cn-ece-helm-chart.

2. Verify that the charging.metrics.port key is set to the port number where you want to expose the ECE metrics. The default is 19612.

3. Verify that each ECE component instance has metrics enabled.

   Each application role under the charging key can be configured to enable or disable metrics. In the jvmOpts key, setting the ece.metrics.http.service.enabled option enables (true) or disables (false) the metrics service for that role.

   For example, these override-values.yaml entries would enable the metrics service for ecs1.

   charging:
      labels: "ece"
      jmxport: "9999"
      …
      metrics:
         port: "19612"
      ecs1:
         jmxport: ""
         replicas: 1
         …
         jvmOpts: "-Dece.metrics.http.service.enabled=true"
         restartCount: "0"

4. Save and close your override-values.yaml file.

5. Run the helm upgrade command to update your ECE Helm release:

   helm upgrade EceReleaseName oc-cn-ece-helm-chart --namespace EceNameSpace --values OverrideValuesFile

   where:

   • EceReleaseName is the release name for oc-cn-ece-helm-chart.

   • EceNameSpace is the namespace in which to create ECE Kubernetes objects for the ECE Helm chart.

   • OverrideValuesFile is the name and location of your override-values.yaml file for oc-cn-ece-helm-chart.

After installing Prometheus Operator, you configure it to scrape metrics from the ECE metric endpoint. The following shows sample entries you can use to create Prometheus Service and ServiceMonitor objects that scrape ECE metric data.

This sample creates a Service object that specifies to:

• Select all pods with the app label ece

• Scrape metrics from port 19612

apiVersion: v1
kind: Service
metadata:
  name: prom-ece-metrics
  labels:
    application: prom-ece-metrics
spec:
  ports:
    - name: metrics
      port: 19612
      protocol: TCP
      targetPort: 19612
  selector:
    app: ece
  sessionAffinity: None
  type: ClusterIP
  clusterIP: None

This sample creates a ServiceMonitor object that specifies to:

• Select all namespaces with ece in their name

• Select all Service objects with the application label prom-ece-metrics

• Scrape metrics from the HTTP path /metrics every 15 seconds

kind: ServiceMonitor
metadata:
  name: prom-ece-metrics
spec:
  endpoints:
    - interval: 15s
      path: /metrics
      port: metrics
      scheme: http
      scrapeTimeout: 10s
  namespaceSelector:
    matchNames:
      - ece
  selector:
    matchLabels:
      application: prom-ece-metrics

For more information about configuring Prometheus Operator, see https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md.

ECE cloud native collects metrics in the following groups to produce data for monitoring your ECE components:

• JVM Metrics

• BRS Metrics

• Kafka JMX Metrics

• Session Metrics

• Rated Events Metrics

• CDR Formatter Metrics

• Coherence Metrics