Environment: 
Oracle B2C Service
Service Health Metrics

Resolution:
Service Health Metrics REST APIs are available so your organization can monitor the overall health of the Oracle B2C Service. In addition to the REST APIs, we offer an operational dashboard that presents data which is useful for monitoring the Oracle B2C Service solution. The operational dashboard is available for administrators to use and is located within the Browser UI.

Why is the dashboard useful?
The dashboard offers a quick & easy way to access real-time health status data for the various services and features within your Oracle B2C Service application. This data empowers you to proactively identify potential issues and ensure optimal performance. Within the dashboard, you can: 

• 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

Are there any system requirements for the dashboard?

• This feature does not require a CX upgrade
• This feature does not require a feature flag
• The dashboard is accessed from within the Browser UI
• The dashboard is included in the June I release of Browser UI, and available on test sites beginning May 23rd 2025, and available on production sites beginning June 06th 2025

Service Health Metrics Dashboard - Overview & Definitions
Within the dashboard, a series of charts and trend graphs provide the following key metrics for a specific site: 

• Total Requests: The total number of all requests received
• Average Latency: The average time taken to process a request
• Success Percentage: Measures the percentage of successful requests
• Error Information: The count and percentage of error requests
   

The dashboard contains a filter for the time range:

• Default = Last 15 minutes
• Other options include the last 5 or 30 minutes, and the last 1 or 2 hours
• When a selection is made, then the dashboard is updated to reflect the new time interval
• The “from” date & “to” date shown are based on the selection made, and provide the starting and ending dates in UTC time

The dashboard includes a set of pie charts that show:

• The services that your site utilizes, such as
  • CX Service includes API requests, Custom Script requests and Customer Portal requests
  • Browser UI includes requests received by the Browser UI console
  • Chat includes requests received by the Chat service
  • Note: If you do not use one of these services, then it will not appear in the dashboard
• And the Total Average Latency (in milliseconds) for each service
  • Total Average Latency is the typical delay for all requests served by the service
• And the Success rate for each service
  • The data includes the count of successful HTTP requests
  • The value is provided as a percentage
• And the Error rate for each service
  • The data includes the count of unsuccessful HTTP requests
  • The value is provided as a percentage

The dashboard includes a set of trend graphs that show:

• A menu for Metric Data, where you can select from
  • Average Latency: This is the average latency for all the requests mentioned, by count
  • Count: This is the count of the request for the RequestType filter. For example: If RequestType ‘Success’ is selected, the count will only include HTTP Requests which received non-5xx http status. This is the default selection
• A menu for Request Type, where you can select from
  • All: Includes HTTP request data for both success & error
  • Success: Data includes 4XX and lower
  • Error: Data includes 5XX only
• The Y-axis is dynamic, and changes based on the selection made within the “Metric Data” & the “Request Type” menus
• The time in UTC is provided on the X-axis, and the time is shown with an interval of 1 minute
• The services that your site utilizes are included in the trend graphs
  • You can remove a service from the trend graph by clicking on the service name in the legend
  • CX Service includes API requests, Custom Script requests and Customer Portal requests
  • Browser UI includes requests received by the Browser UI console
  • Chat includes requests received by the Chat service
• Note: If data for a specific service is not available for the selected time range, then the trend graph displays a message “No data to display”

FAQ’s for the Service Health Metrics Dashboard

Who can view the dashboard?
If the profile assigned to the staff account has the "administrator" permission enabled, then the dashboard can be viewed within the Browser UI (BUI).

How can the dashboard be accessed?
To view the dashboard:

1. Login to the Browser UI
2. Go to the menu in the upper left corner
3. Go to “Administration”
4. Go to “Service Health Metrics Dashboard”
5. And a new tab for the "Service Health Metrics Dashboard" opens and the dashboard is presented

How do I know which site data is included in the dashboard?
The name of the site is provided in the top left corner of the dashboard.

How often does the dashboard refresh?
The dashboard refreshes every 1 minute and updates the data with the most recent aggregated values.

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