vania-janet/multiturn-rag-retrieval-data huggingface dataset:
--------------------



 Collecting metrics 

You can collect metrics from a number of platforms, orchestrators, and a wide range of applications such as Prometheus, JMX, StatsD, Kubernetes, and other application stacks, that are available in the IBM Cloud®, outside the IBM Cloud, or on-prem. You can also add more metrics by creating custom metrics and adding integrations.



 Metrics and labels 

A metric is a quantitative measure that has one or more labels to define its characteristics.

Use metrics to analyze statistically data that has numerical values.

A metric is represented by time series. A time-series is a unique combination of a metric name and label key-value pairs. For example: website_failedRequest |region='Asia', customer_ID='abc'. A data-point is the value generated for a time-series at a given point in time.

Labels are classified as infrastructure labels and metric descriptor labels. Each metric has a set of pre-defined labels. For custom metrics, you can configure more labels.

You can use labels to identify and differentiate characteristics of a metric, for example,



* You can group infrastructure objects into logical hierarchies.
* You can filter out data.
* You can split aggregated data into segments.







 Collecting default metrics by using the Monitoring agent 

When you configure a Monitoring agent, data for default metrics is automatically collected. These metrics include metadata that you can use to label, segment, and display metrics when you monitor them. You do not need additional instrumentation or configuration in your hosts to obtain metrics that are collected automatically by the agent to gain insight into what is happening in them.

To monitor your infrastructure, network, and applications with the IBM Cloud® Monitoring service, you can deploy Monitoring agents on supported hosts. The host determines the agent type that you can deploy. The agent type determines the metrics that are collected automatically for that host.

To start collecting default metrics, you must configure a Monitoring agent per environment that you want to monitor.
-H 'correlation-id: <correlation_ID>' 
-H 'prefer: <return_preference>' 
-d '{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"name": "<key_alias>",
"description": "<key_description>",
"expirationDate": "<YYYY-MM-DDTHH:MM:SS.SSZ>",
"payload": "<key_material>",
"extractable": <key_type>
}
]
}'

Replace the variables in the example request according to the following table.



 Variable Description 

 region The region abbreviation, such as us-south or au-syd, that represents the geographic area where your Hyper Protect Crypto Services service instance resides. For more information, see [Regional service endpoints](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-regionsservice-endpoints). 
 port Required. The port number of the API endpoint. 
 IAM_token Your IBM Cloud access token. Include the full contents of the IAM token, including the Bearer value, in the cURL request. For more information, see [Retrieving an access token](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-retrieve-access-token). 
 instance_ID The unique identifier that is assigned to your Hyper Protect Crypto Services service instance. For more information, see [Retrieving an instance ID](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-retrieve-instance-ID). 
 correlation_ID The unique identifier that is used to track and correlate transactions.
The total number of connections present at the endpoint.



Metadata for the Endpoint connection count metric

 Metadata Description 

 Metric Name ibm_satellite_link_endpoint_connection_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance, Service instance name, Location ID, Endpoint ID, Endpoint Name 







 Endpoint traffic to cloud 

The rate of data in bytes per second in the to-cloud direction for the endpoint.



Metadata for the Endpoint traffic to cloud metric

 Metadata Description 

 Metric Name ibm_satellite_link_endpoint_to_cloud_data_rate 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance, Service instance name, Location ID, Endpoint ID, Endpoint Name 







 Endpoint traffic from cloud 

The rate of data in bytes per second in the from-cloud direction for the endpoint.



Metadata for the endpoint traffic from cloud metric

 Metadata Description 

 Metric Name ibm_satellite_link_endpoint_from_cloud_data_rate 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance, Service instance name, Location ID, Endpoint ID, Endpoint Name 







 Endpoint traffic total 

The total rate of data in bytes per second in to-cloud and from-cloud directions for the endpoint.



Metadata for the endpoint traffic total metric

 Metadata Description 

 Metric Name ibm_satellite_link_endpoint_total_data_rate 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance, Service instance name, Location ID, Endpoint ID, Endpoint Name 









 Attributes for segmentation 

Review the following global and additional attributes that are available for segmentation of Satellite metrics.



 Global attributes 

The following global attributes are available for segmenting all the [available metrics](https://cloud.ibm.com/docs/satellite?topic=satellite-monitoravailable-metrics).



Global attributes for metric segmentation

 Attribute Attribute Name Attribute Description 

 Cloud Type ibm_ctype The cloud type, which can be public, dedicated, or local 
 Location ibm_location The location of the monitored resource, which can be a region, data center, or global
[Enable the instance for platform-level metrics collection](https://cloud.ibm.com/docs/monitoring?topic=monitoring-platform_metrics_enabling). Note that within one region, only one Monitoring instance can be enabled for platform metrics collection.





2. In the Monitoring dashboard, click Open Dashboard for your Monitoring instance.
3. In the Monitoring dashboard, click Dashboards > IBM > Satellite Link - Overview. The pre-defined dashboard for Satellite Link metrics opens. Note that if you just created this Monitoring instance, it might take up to two hours for the **IBM ** dashboards to become available.

You can create a copy of this dashboard to customize the metrics that are shown. To add metrics that are enabled for IBM Cloud Satellite, search for the ibm_satellite_link prefix.
4. Review the [available metrics](https://cloud.ibm.com/docs/satellite?topic=satellite-monitoravailable-metrics) and [attributes for segmentation](https://cloud.ibm.com/docs/satellite?topic=satellite-monitorattributes).
5. Review more ways that you can [work with platform metrics](https://cloud.ibm.com/docs/monitoring?topic=monitoring-platform_metrics_working).



After you set up Monitoring with the pre-defined dashboard for Satellite Link metrics, you can quickly access this dashboard from the Link endpoints tab of your Satellite location console by clicking Launch monitoring.



 Available metrics 

The following metrics are available for your Satellite location control plane.



 Location tunnel numbers 

The total number of Satellite Link tunnel servers present at the endpoint. Three tunnels are created between the tunnel server and the connector to support redundancy across the three availability zones of your location.



Metadata for the location tunnel numbers metric

 Metadata Description 

 Metric Name ibm_satellite_link_location_tunnel_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance, Service instance name, Location ID 







 Location latency 

The total round trip time of data in milliseconds for the location.



Metadata for the location latency metric

 Metadata Description
This documentation is for the classic Watson Assistant experience. To see the documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Metrics overview 

The overview page provides a summary of the interactions between users and your assistant.

Analytics help you to understand the following things:



* What do customers want help with today?
* Is your assistant understanding and addressing customer needs?
* How can you make your assistant better?



To see metrics information, select Overview in the navigation bar. The information in Analytics is not immediately updated after a user interacts with your assistant. Watson Assistant prepares the data for Analytics in the background.

After the numbers in metrics hit the 3,000 and above range, the totals are approximated to prevent performance lags in the page.



 Scorecards 

The scorecards give you a quick view of your metrics. Scroll to see full interactive graphs later in the page.

![Shows the scorecards that are displayed at the start of the Analytics page](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/scorecard.png)



* Total conversations: The total number of conversations between active users and your assistant that occur during the selected time period. The total conversations metric and the User conversations page only include conversations in which both the assistant and customer participate. Conversations that only have welcome messages from the assistant, or that only have user messages of zero length, are not included. This metric is not used for billing purposes. An exchange with a user is not considered a billable conversation until the customer submits a message.
* Avg. msg. per conversation: The total messages received during the selected time period divided by the total conversations during the selected time period, as shown in the corresponding graph.
* Max. conversations: The maximum number of conversations for a single data point within the selected time period.
* Weak understanding: The number of individual messages with weak understanding.
"received": 7.04,
"seen_by_engine": 1.59,
"transcription": 0.49
},
"wall_clock_since_first_byte_received": 0.32,
"periodic": true
}
}
{
"processing_metrics": {
"processed_audio": {
"received": 7.04,
"seen_by_engine": 2.59,
"transcription": 1.25
},
"wall_clock_since_first_byte_received": 0.57,
"periodic": true
}
}
. . .
Show more







 Audio metrics 

Audio metrics provide detailed information about the signal characteristics of the input audio. The results provide aggregated metrics for the entire input audio at the conclusion of speech processing. For a technically sophisticated user, the metrics can provide meaningful insight into the detailed characteristics of the audio.

You can use audio metrics to provide a real-time indication of a problem with the input audio and possibly even a potential solution. For example, you can provide a message such as "There is too much noise in the background" or "Please come closer to the microphone." You can also use an offline analytical tool to review the signal characteristics and suggest data that is suitable for future model updates.



 Requesting audio metrics 

To request audio metrics, set the audio_metrics boolean parameter to true. By default, the service returns no metrics.



* With the WebSocket interface, you specify the parameter with the JSON start message for a speech recognition request.
* With the HTTP interfaces, you specify a query parameter with a speech recognition request.



The service returns audio metrics with the final transcription results. It returns the metrics just once for the entire audio stream. Even if the service returns multiple transcription results (for different blocks of audio), it returns only a single instance of the metrics at the very end of the results.

The WebSocket interface accepts multiple audio streams (or files) with a single connection.
Metrics overview 

The Overview page provides a summary of the interactions between users and your assistant. You can view the amount of traffic for a given time period, as well as the intents and entities that were recognized most often in user conversations.

The Analytics page was introduced with version 1.5.0. The Analytics feature is supported only on clusters that are installed on Red Hat OpenShift 4.5 or later.

Use the metrics to answer questions like:



* What was the average number of conversations per week during the last month?
* How often did customers need to go elsewhwere for support?
* Which intents appeared most often last week?
* Which entity values were recognized the most times during February?
* Which days had the largest or smallest numbers of conversations in the last month?



To see metrics information, select Overview in the navigation bar.



 Controls 

You can use the following controls to filter the information:



* Time period control - Use this control to choose the period for which data is displayed. This control affects all data shown on the page: not just the number of conversations displayed in the graph, but also the statistics displayed along with the graph, and the lists of top intents and entities.

The statistics can cover a longer time period than the period for which logs of conversations are retained.

![Time period control](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/oview-time.png)

You can choose whether to view data for a single day, a week, a month, or a quarter. In each case, the data points on the graph adjust to an appropriate measurement period. For example, when viewing a graph for a day, the data is presented in hourly values, but when viewing a graph for a week, the data is shown by day. A week always runs from Sunday through Saturday.

You can create custom time periods also, such as a week that runs from Thursday to the following Wednesday, or a month that begins on any date other than the first.
...
)

)

To be sure that your CNAME record is configured correctly, run dig <your domain> on the command line. The output looks similar to the following:

;; ANSWER SECTION:
api-testing.cdntesting.net. 900 IN CNAME api-testing.cdn.appdomain.cloud.

Here we see the domain name that is correctly mapped to the CNAME.





 Example code for getting integrated metrics 

This example shows you how to get the integrated metrics for a domain mapping with getMappingIntegratedMetrics API in the class SoftLayer_Network_CdnMarketplace_Metrics.

$client = SoftLayerSoapClient::getClient('SoftLayer_Network_CdnMarketplace_Metrics', null, $apiUsername, $apiKey);
try {
$metrics = $client->getMappingIntegratedMetrics(
123456789123456, // Mapping unique id
1590969600, // Start timestamp, must be later than 90 days ago
1591315200, // End timestamp, must be later than start time
'day' // The data frequency, can be 'aggregate' and 'day', default is 'day'.
);
print_r($vendors);
} catch (Exception $e) {
die('Unable to get mapping integrated metrics: ' . $e->getMessage());
}

The getMappingIntegratedMetrics API returns an array of metrics. Example output is as follows:

{
"0": {
"type": "INTEGRATED",
"names": [
"TotalHits",
"TotalBandwidth",
"0XX",
"200",
"206",
"2XX",
"302",
"304",
"3XX",
"404",
"4XX",
"5XX",
"Other",
* Metric name - The name for the collected metric.
* Metric type - Metric type determines whether the metric value is a counter metric or a gauge metric. Each of these metrics is of the type gauge, which represents a single numerical value that can arbitrarily fluctuate over time.
* Value type - A unit of measurement for a specific metric. Examples include bytes or counts. A value type of none means that the metric value represents individual occurrences of that metric type.
* Segment - How you want to divide and display the monitoring metrics.



Only the resources in the same zone as the selected subnet can connect through this VPN gateway.



 Active connections 

Active connections are the number of connections that are established on a load balancer at a specific time.

The active connection metric contains the following metadata:



Table 1: Application load balancer active connections metrics metadata

 Metadata Description 

 Metric name ibm_is_load_balancer_active_connections 
 Metric type gauge 
 Value type none 
 Segment by Application load balancer appliance metrics and Application load balancer listener metrics 







 Connection rate 

Connection rate is the number of new incoming active connections per second to your load balancer.



Table 2: Application load balancer connection rate metric metadata

 Metadata Description 

 Metric name ibm_is_load_balancer_connection_rate 
 Metric type gauge 
 Value type none 
 Segment by Application load balancer appliance metrics and Application load balancer listener metrics 







 Throughput 

Throughput is the amount of data that passes in and out of a load balancer over a period of time.



Table 3: Application load balancer throughput metric metadata

 Metadata Description 

 Metric name ibm_is_load_balancer_throughput 
 Metric type gauge 
 Value type byte 
 Segment by Application load balancer appliance metrics and Application load balancer listener metrics 







 Request Count 

The request count is the total number of HTTP/HTTPS requests that are sent by the load balancer to the back-end servers per minute. This metric is only available for HTTP and HTTPS listeners.



Table 4: Application load balancer request count metric metadata

 Metadata Description 

 Metric name ibm_is_load_balancer_request_count
* Resource usage metrics: Resource usage metrics reports on the health and state of CPU and memory for workers (nodes) and pods that are running in the cluster. The data can be analyzed by namespace, by worker, by pod, by workload object such as deployments, daemonSets, and more.



For a list of collected metrics, see [Metrics Available for orchestrated environments](https://docs.sysdig.com/en/docs/sysdig-monitor/using-monitor/metrics/metrics-library/prometheus-format/).

Through the Monitoring UI, you can analyze data in the Advisor tab, the Explore tab, and in the Dashboard tab. You monitor the data through metric views and dashboards.

Consider the following information when monitoring your data:



* In the Explorer tab, you can monitor individual metrics.
* In the Advisor tab, you can monitor Red Hat OpenShift or host level metrics.

This tab is only available for users that belong to a team that has access to monitor Red Hat OpenShift or host level metrics.
* In the Dashboard tab, you can monitor through panels predefined dashboards or custom ones and get a specialized insight into network data, application data, topology, services, hosts, and containers. A panel displays a metric or group of metrics in a dashboard.



For each metric view and dashboard, you can define the scope of the data, how to aggregate data, and what time and group filters to apply to the data. For more information, see [Managing panels](https://cloud.ibm.com/docs/monitoring?topic=monitoring-panels).

You can configure a dashboard as the default entry point for a team, unifying a team's experience, and allowing users to focus their immediate attention on the most relevant information for them.

For more information, see [Viewing metrics](https://cloud.ibm.com/docs/monitoring?topic=monitoring-monitoring).



 Objectives 

In this tutorial, you configure metrics for your Red Hat OpenShift on IBM Cloud cluster. In particular, you:



* Provision an IBM Cloud Monitoring instance.
The following global attributes are available for segmenting all the [available metrics](https://cloud.ibm.com/docs/satellite?topic=satellite-monitoravailable-metrics).



Global attributes for metric segmentation

 Attribute Attribute Name Attribute Description 

 Cloud Type ibm_ctype The cloud type, which can be public, dedicated, or local 
 Location ibm_location The location of the monitored resource, which can be a region, data center, or global 
 Resource ibm_resource The resource that is measured by the service, usually reported as an identifying name or GUID 
 Resource Type ibm_resource_type The type of the resource that is measured by the service 
 Resource group ibm_resource_group_name The resource group where the Satellite location was created 
 Scope ibm_scope The account GUID associated with this metric 
 Service name ibm_service_name The name of the service that generates this metric 







 Additional attributes 

The following additional attributes that are specific to Satellite are available for segmenting one or more of the [available metrics](https://cloud.ibm.com/docs/satellite?topic=satellite-monitoravailable-metrics). See the Segment By field for each metric to determine its available segmentation attributes.



Additional attributes for metric segmentation

 Attribute Attribute Name Attribute Description 

 Endpoint ID ibm_satellite_link_endpoint_id The identifier of the endpoint 
 Endpoint Name ibm_satellite_link_endpoint_name The name of the endpoint 
 Location ID ibm_satellite_link_location_id The identifier of the location 
 Service instance ibm_service_instance The service instance segment identifies the instance the metric is associated with 
 Service instance name ibm_service_instance_name The user-provided name of the service instance, which might not be unique across regions in the account 











 Setting up monitoring for clusters 

You cannot currently use the Red Hat OpenShift on IBM Cloud console or the observability plug-in CLI (ibmcloud ob) to enable monitoring for Satellite clusters. You must manually deploy monitoring agents to your cluster to forward metrics to Monitoring.
Viewing metrics 

The metrics report supports account and CDN-mapping levels with different report types:



Table 1: Report levels

 Report level Report type Metrics available 

 Account [Historical metrics report](https://cloud.ibm.com/docs/CDN?topic=CDN-metricshistorical-metrics-report) Dynamic Bandwidth, Static Bandwidth, Dynamic Hits, Static Hits 
 Account [Most recent metrics report](https://cloud.ibm.com/docs/CDN?topic=CDN-metricsmost-recent-metrics-report) Bandwidth, Hits 
 Mapping [Historical metrics report](https://cloud.ibm.com/docs/CDN?topic=CDN-metricsdomain-mapping-historical-metrics-report) Bandwidth, Hits, Hit Ratio, Hits By Type, Bandwidth per Region 
 Mapping [Most recent metrics report](https://cloud.ibm.com/docs/CDN?topic=CDN-metricsdomain-mapping-most-recent-metrics-report) Bandwidth, Hits, Hits By Type 





 Metrics report for account 

To view the metrics reports for account, open the CDN Overview Report page next to the All CDNs page.



 Historical metrics report 

You can view the overall metric reports over a custom time period. Select Custom time frame from the Time frame list on the CDN Overview Report page. Here you can find the total Static Bandwidth, Dynamic Bandwidth, Static Hits, Dynamic Hits and Hit Ratio, as well as a graphical representation of Static Bandwidth, Dynamic Bandwidth, Static Hits, and Dynamic Hits.

Zoom

![Custom time report](https://cloud.ibm.com/docs-content/v1/content/006fd22ab2811b7d19804c763a00568b3da4c03a/CDN/images/metrics-custom-time-report.png)

Figure 1: Custom time report

The maximum number of days that you can view metrics reports is 90 days. The latest date that you can view metrics reports is 3 days ago. Start and end time for the historical time range is fixed.