Maintaining the health of your Oracle B2C Service application is critical for optimal performance and user satisfaction. Oracle B2C Service offers a powerful tool to monitor the health and performance of your application: Service Health Metrics. The Service Health Metrics REST APIs empower your organization to gain valuable insights into the overall health of your B2C Service environment.

This blog provides a guide to monitor the health of your Oracle B2C Service application using REST APIs.

Why is monitoring important?

A well-tuned Oracle B2C Service is the backbone of a seamless digital customer experience. By proactively monitoring its health, you can ensure optimal performance, prevent downtime, and delight your customers with

•    Proactive Issue Detection: Identify potential problems before they escalate into major outages
•    Optimized Performance: Fine-tune your service to deliver improved response times and peak performance
•    Enhanced Customer Experience: Ensure a smooth and  consistent customer journey
•    Data-Driven Decision Making: Make informed choices based on real-time insights

Oracle B2C Service offers a robust set of REST APIs that allow you to:

•    Fetch Real-time Health Data: Access real-time insights into the health and performance of your Oracle B2C Service application 
•    Track Service Performance: Monitor response times, success rates, and error rates
•    Identify Bottlenecks: Pinpoint areas of your implementation that may be causing delays or failures

Service Health Metrics is a set of APIs that provide a way to fetch real-time health status data for various services and features within your Oracle B2C Service application. This data empowers you to proactively identify potential issues and ensure optimal performance. Service Health Metrics provides

•    Proactive Monitoring: Identify and address potential service disruptions before the user experience is compromised
•    Proactively Identify Issues: Detect potential problems early, before they escalate into major outages 
•    Enhanced Visibility: Get a comprehensive view of your B2C Service health in a single place

What are the questions that Service Health Metrics can help you answer? 

1.    What is the total number of incoming requests?
2.    What % of requests into the site were successful?
3.    What % of requests from a UI came through BUI (AgentWeb)?
4.    What % of unsuccessful requests failed due to the service being unavailable (i.e. HTTP Status Code = 503)?
5.    What % of incoming requests did timeout (504)?
6.    What was the distribution of incoming requests (i.e. traffic) across the various services?
7.    I have multiple instances of service cloud which is spread across multiple geographies. In such cases which endpoint can I hit to get the metrics?

Which key metrics can I track using Service Health Metrics?
1.    Total Requests: The total number of all requests received.
2.    Average Latency: The average time taken to process a request.
3.    Success Percentage: Measures the percentage of successful requests.
4.    Error Information: The count and percentage of error requests. 

How can I enable Service Health Metrics for my site?
To access the Service Health Metrics APIs, a one-time setup is required using Configuration Assistant, which must be performed by site administrators. Subsequently, authentication is handled through JWT Bearer tokens, necessitating the inclusion of a JSON Web Token in the Authorization header of GET API requests.

Where can I find more information about Service Health Metrics?

For more information about Service Health Metrics, please visit Answer ID 12835: Service Health Metrics: Quick Start Guide