14 Tracing BRM REST Services Manager Cloud Native

Learn how to use Zipkin to trace the flow of API calls made to BRM REST Services Manager in your Oracle Communications Billing and Revenue Management (BRM) cloud native system.

Topics in this document:

• About BRM REST Services Manager Tracing

• Securing Communication with Zipkin

• Enabling Tracing in BRM REST Services Manager

About BRM REST Services Manager Tracing

You can trace the flow of REST API calls made to BRM REST Services Manager using Zipkin, an open-source tracing system. For more information, see the Zipkin website: https://zipkin.io/.

To set up tracing in BRM REST Services Manager cloud native:

1. Install Zipkin. See the Zipkin Quickstart documentation: https://zipkin.io/pages/quickstart.html.

2. (Optional) Secure communication between BRM REST Services Manager and Zipkin. See "Securing Communication with Zipkin".

3. Enable Zipkin tracing in BRM REST Services Manager cloud native. See "Enabling Tracing in BRM REST Services Manager".

Afterward, you can start tracing the flow of API calls to BRM REST Services Manager using the Zipkin UI or Zipkin API.

Securing Communication with Zipkin

To use secure communication with Zipkin:

1. Create a client TrustStore that BRM REST Services Manager can use to connect to Zipkin.
2. In your override-values.yaml file for oc-cn-helm-chart, set the following keys:

   • ocrsm.rsm.configEnv.trustStoreFileName: The file name of the BRM REST Services Manager SSL certificate.

   • ocrsm.rsm.secretVal.trustStorePassword: The TrustStore password in Base64 format.

Enabling Tracing in BRM REST Services Manager

By default, tracing is disabled in BRM REST Services Manager cloud native. To enable tracing with Zipkin:

1. In your override-values.yaml file for oc-cn-helm-chart, set the following keys under ocrsm.rsm.configEnv:

   • isTracingEnabled: Set this to true.

   • zipkinHostName: Set this to the host name of the server on which Zipkin is running.

   • zipkinPort: Set this to the port number for Zipkin.

   • zipkinProtocol: Set this to HTTP or HTTPS.

2. Deploy or redeploy the BRM Helm release by running the helm install command:

   helm install BrmReleaseName oc-cn-helm-chart –-values OverrideValuesFile -n BrmNameSpace

   where:

   • BrmReleaseName is the release name for oc-cn-helm-chart and is used to track this installation instance.

   • OverrideValuesFile is the file name and path to your override-values.yaml file.

   • BrmNameSpace is the namespace in which to create BRM Kubernetes objects for the BRM Helm chart.