vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Working with platform metrics 

Platform metrics are metrics that are exposed by enabled-monitoring services and the platform in IBM Cloud.



* Platform metrics are regional.

You can monitor metrics from enabled-monitoring services on the IBM Cloud in the region where the service is available.
* You can configure 1 instance only of the IBM Cloud Monitoring service per region to collect platform metrics in that location.

To configure a monitoring instance, you must set the platform metrics configuration setting.

To configure platform metrics, you must be assigned the IAM Editor role or higher for the IBM Cloud Monitoring with monitoring service.
* If a monitoring instance in a region is already enabled to collect platform metrics, metrics from enabled-monitoring services are collected automatically and available for monitoring through this instance. For more information about enabled-monitoring services, see [Cloud services](https://cloud.ibm.com/docs/monitoring?topic=monitoring-cloud_services).
* To monitor platform metrics for a service instance, check that the IBM Cloud Monitoring instance is provisioned in the same region where the service instance that you want to monitor is provisioned.





 Controlling what data is visible 

You can use attributes to segment metrics so that you can define what data is visible to users.

The following global attributes are available for segmenting metrics:



Table 1. Global attributes

 Attribute Attribute Name Attribute Description 

 Cloud Type ibm_ctype Type. <br>Valid values: public, dedicated, or local 
 Location ibm_location Location of the monitored resource. <br>This field can be set to a region, a data center, or global. 
 Scope ibm_scope Scope of the metric. <br>This field can be set to the account GUID, an organization GUID, or a space GUID. 
 Service name ibm_service_name Name of the service generating this metric. 
 Service instance ibm_service_instance Service instance GUID that identifies the instance the metric is associated with. 
 Service instance name ibm_service_instance_name Service instance name. <br>This field provides the user-provided name of the service instance which isn't necessarily a unique value depending on the name provided by the user.
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. Learn more:



* [Collecting default metrics by using the Monitoring agent](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metricsabout-collect-metrics-2)
* [Collecting custom metrics by using the Monitoring agent](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metricsabout-collect-metrics-3)
* [Collecting custom metrics by using Prometheus remote write](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metricsabout-collect-metrics-4)
* [Collecting custom metrics by using Prometheus exporters](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metricsabout-collect-metrics-5)
* [Collecting Platform metrics from IBM Cloud services](https://cloud.ibm.com/docs/monitoring?topic=monitoring-about-collect-metricsabout-collect-metrics-6)





 Configure platform metrics 

Platform metrics are metrics that are exposed by enabled-monitoring services and the platform in IBM Cloud. You must configure a IBM Cloud Monitoring instance in a region to monitor these metrics. [Learn more](https://cloud.ibm.com/docs/monitoring?topic=monitoring-platform_metrics_enabling).

To see the list of enabled-monitoring services, see [Cloud services](https://cloud.ibm.com/docs/monitoring?topic=monitoring-cloud_services).

For example, to configure platform metrics in a region, complete the following steps:



1. From theIBM Cloud dashboard, go to the menu icon !
Metric Name ibm_databases-for-enterprisedb_disk_total_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 







 Transaction commit count 

Transaction commit count



Table 22: Transaction commit count metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_transaction_commit_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance 







 Transaction commit rate 

Transaction commit rate



Table 23: Transaction commit rate metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_transaction_commit_rate 
 Metric Type gauge 
 Value Type rate 
 Segment By Service instance 







 Transaction rollback count 

Transaction rollback count



Table 24: Transaction rollback count metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_transaction_rollback_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance 







 Transaction rollback rate 

Transaction rollback rate



Table 25: Transaction rollback rate metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_transaction_rollback_rate 
 Metric Type gauge 
 Value Type rate 
 Segment By Service instance 







 Tuples deleted count 

Tuples deleted count



Table 26: Tuples deleted count metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_tuples_deleted_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance 







 Tuples deleted rate 

Tuples deleted rate



Table 27: Tuples deleted rate metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_tuples_deleted_rate 
 Metric Type gauge 
 Value Type rate 
 Segment By Service instance 







 Tuples fetched count 

Tuples fetched count



Table 28: Tuples fetched count metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_tuples_fetched_count 
 Metric Type gauge 
 Value Type none 
 Segment By Service instance 







 Tuples fetched rate 

Tuples fetched rate



Table 29: Tuples fetched rate metric metadata

 Metadata Description
correlation_ID Optional.The unique identifier that is used to track and correlate transactions. 
 new_key_ring_ID Required. The unique identifier for the target key ring that you would like to move the key to. 



A successful PATCH api/v2/keys/keyID_or_alias request returns the key's metadata, including the id of the key ring that the key is a part of.

{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "02fd6835-6001-4482-a892-13bd2085f75d",
"name": "test-root-key",
"aliases":
"alias-1",
"alias-2"
],
"description": "A test root key",
"state": 1,
"extractable": false,
"keyRingID": "new-key-ring",
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
"imported": false,
"creationDate": "2020-03-12T03:37:32Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
* [Available metrics](https://cloud.ibm.com/docs/satellite?topic=satellite-monitoravailable-metrics)
* [Attributes for segmentation](https://cloud.ibm.com/docs/satellite?topic=satellite-monitorattributes)



* [Setting up monitoring for clusters](https://cloud.ibm.com/docs/satellite?topic=satellite-monitorsetup-clusters-monitoring)



[Auditing events for Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_events)



* [Events for Satellite clusters](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_actions_clusters)
* [Events for the Satellite Link component](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_actions_link)
* [Events for the Satellite Config component](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_actions_config)
* [Events for Satellite storage](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_actions_storage)
* [Events for Satellite assignments](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_actions_assignments)
* [Viewing events for Satellite](https://cloud.ibm.com/docs/satellite?topic=satellite-at_eventsat_ui)







 Setting up storage 

[Understanding Satellite storage](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-template-ovstorage-template-ov)



* [What are my options for deploying storage to Satellite?](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-template-ovstorage-sat-configure)
* [Which deployment option should I use?]
IBM Cloud VPC monitoring dashboards 

You can monitor various aspects of VPC services with IBM Cloud® Monitoring dashboards. For more information about IBM Cloud Monitoring, see the IBM Cloud Monitoring [Getting started tutorial](https://cloud.ibm.com/docs/monitoring?topic=monitoring-getting-started).



 VPC service metric definitions 

Each monitoring dashboard has the relevant metrics for its associated service as defined in Table 1.



Table 1: VPC metric definitions

 Dashboard name Metric definition dictionary 

 VPC VSI Gen 2 Overview [VPC virtual server instances metrics definitions](https://cloud.ibm.com/docs/vpc?topic=vpc-vpc-monitoring-metrics) 
 VPC Gen 2 VPN [Monitoring VPN for VPC metrics](https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-monitoring-metrics&interface=ui) 
 VPC Gen 2 Load Balancer [Monitoring Application Load Balancer for VPC metrics](https://cloud.ibm.com/docs/vpc?topic=vpc-monitoring-metrics-alb) 
 VPC Gen 2 Load Balancer [Monitoring Network Load Balancer for VPC metrics](https://cloud.ibm.com/docs/vpc?topic=vpc-nlb_monitoring-metrics) 
 VPC Flow Logs Overview [Monitoring flow logs for VPC metrics](https://cloud.ibm.com/docs/vpc?topic=vpc-fl-monitoring-metrics) 
 VPC Resource Quota Overview [VPC quota metrics definitions](https://cloud.ibm.com/docs/vpc?topic=vpc-vpc-quota-metrics) 



To see a list of Cloud services outside of VPC that offer monitoring, see [Cloud services](https://cloud.ibm.com/docs/monitoring?topic=monitoring-cloud_services).





 View a specific monitoring dashboard 



1. To view a specific dashboard on the monitoring, first go to the [monitoring UI](https://cloud.ibm.com/observe/monitoring).
Learning about IBM Cloud Metrics Routing architecture and workload isolation 

Review the following sample architecture for IBM Cloud Metrics Routing, and learn more about different isolation levels so that you can choose the solution that best meets the requirements of the workloads that you want to run in the cloud.



 IBM Cloud Metrics Routing architecture 

IBM Cloud Metrics Routing is a multi-tenant, regional service that is available in IBM Cloud. With IBM Cloud Metrics Routing, you can manage collection and routing of metrics in your account.

The following figure shows the high level architecture for IBM Cloud Metrics Routing:

Zoom

![A diagram that shows a sample IBM Cloud Metrics Routing architecture.](https://cloud.ibm.com/docs-content/v1/content/dad8f28785f0dc036aaae4b777787e73db9ff0d4/metrics-router/images/Metrics-Router-01-Architecture.svg)

Figure 1. IBM Cloud Metrics Routing sample architecture

IBM Cloud Metrics Routing is deployed and managed per region. See [List of supported regions](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-regions). In each region, the service runs in three physically separate data centers to ensure availability. All data and the configuration for each service deployment is retained within the region in which it is hosted.

You can use the IBM Cloud Metrics Routing CLI, the IBM Cloud Metrics Routing API, and IBM Cloud Metrics Routing Terraform to manage the service in your account.

You can configure the IBM Cloud Metrics Routing settings to define how to manage metrics globally in your account. You can configure whether you want to use private endpoints only, location of the metadata that is required by the service to run, default destinations in case you do not set a rule for a region where you operate, and more.

Before you can configure the resources that define how to manage metrics in the account, you must define a Primary metadata region. The Primary metadata region defines the location where metadata about your account and resources is stored.
To view more in-depth metrics for a standard cluster or your apps, you can configure a monitoring agent in your cluster to send metrics to IBM Cloud Monitoring. You can also install third-party monitoring solutions, such as Prometheus or Weave Scope, or use the metrics that are provided in the Kubernetes dashboard. For more information, see [Choosing a monitoring solution](https://cloud.ibm.com/docs/containers?topic=containers-health-monitorview_metrics).

To set up a host-based intrusion detection system (HIDS) and security event log monitoring (SELM), install third-party tools that are designed to monitor your cluster and containerized apps to detect intrusion or misuse, such as [Twistlock](https://www.paloaltonetworks.com/prisma/cloud) or the [Sysdig Falco project](https://sysdig.com/opensource/falco/).

How can I audit events that happen in my cluster?
: You can [set up IBM Cloud® Activity Tracker in your IBM Cloud Kubernetes Service cluster](https://cloud.ibm.com/docs/containers?topic=containers-at_eventsat_events). For more information, view the [Activity Tracker documentation](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-getting-started).

What are my options to enable trust in my cluster?
: By default, IBM Cloud Kubernetes Service provides many features for your cluster components so that you can deploy your containerized apps in a security-rich environment. Extend your level of trust in your cluster to better ensure that what happens within your cluster is what you intended to happen. You can implement trust in your cluster in various ways, as shown in the following diagram.

Zoom

![Deploying containers with trusted content.](https://cloud.ibm.com/docs-content/v1/content/4d497aff9e27b92fbbc2ee4e343a9ec4549cb1d7/containers/images/trusted_story.svg)

Figure 1.
Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_tuples_updated_rate 
 Metric Type gauge 
 Value Type rate 
 Segment By Service instance 







 Used CPU for an instance 

How much CPU is used as a percentage of total CPU available.



Table 35. Used CPU for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases-for-enterprisedb_cpu_used_percent 
 Metric Type gauge 
 Value Type percent 
 Segment By Service instance 







 Used disk space for an instance 

How much disk your deployment is using.



Table 36. Used disk space for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases-for-enterprisedb_disk_used_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 







 Used memory for an instance 

How much memory your deployment is using.



Table 37. Used memory for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases-for-enterprisedb_memory_used_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 







 WAL logs size in bytes 

WAL logs size in bytes



Table 38: WAL logs size in bytes metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_enterprisedb_wal_used_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 









 Attributes for Segmentation 



 Global Attributes 

The following attributes are available for segmenting all of the metrics listed.



Table 39. Global Attributes Metadata

 Attribute Attribute Name Attribute Description 

 Cloud Type ibm_ctype The cloud type is a value of public, dedicated, or local. 
 Location ibm_location The location of the monitored resource - might be a region, data center, or global. 
 Resource ibm_resource The resource that is measured by the service - typically an identifying name or GUID. 
 Resource Type ibm_resource_type The type of the resource that is measured by the service. 
 Scope ibm_scope The scope is the account, organization, or space GUID associated with this metric. 







 Additional Attributes 

The following attributes are available for segmenting one or more attributes as described in the previous references. See the individual metrics for segmentation options.
Check [Locations](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-regions).
* Identify which services in those locations generate metrics that you can route through IBM Cloud Metrics Routing. Check [Services generating metrics](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-cloud-services-mr).



You can use IBM Cloud Metrics Routing to manage metrics at the account-level. IBM Cloud Metrics Routing can only route metrics that are generated in [supported regions](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-regions). Other regions, where IBM Cloud Metrics Routing is not available, continue to manage metrics by using IBM Cloud Monitoring.





 Metadata location 

Decide the location in your IBM Cloud account where the IBM Cloud Metrics Routing account configuration metadata is stored.

You can choose any of the supported locations where IBM Cloud Metrics Routing is available. For more information, see [Locations](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-regions).

Take into account any corporate or industry compliance requirements such as Financial Services Validated locations, or EU-managed regions.

You can define a primary metadata location and a backup metadata location. Once a primary location is set, you can change it to a different region but you cannot disable it.

You must define a primary metadata location in the account before you can configure destinations and rules to route metrics in the account.





 Endpoints allowed 

You can use public endpoints, private endpoints or both to manage the IBM Cloud Metrics Routing account configuration.

Decide whether public endpoints, private endpoints, or both are allowed to manage the IBM Cloud Metrics Routing account configuration. For more information, see [Enforcing private endpoints to configure IBM Cloud Metrics Routing resources](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-endpoints-enforce-private).
Returns the real-time metrics for the current account, including the total data (bandwidth and hits) over the given period of time and the detailed data divided with the given time interval. For more details, [View the examples](https://cloud.ibm.com/docs/CDN?topic=CDN-code-examples-using-the-cdn-apiexample-code-for-getting-real-time-metrics).



* Parameters:



* vendorName - The name of the CDN provider. Currently, only akamai is supported.
* startTime - The start time timestamp (UTC+0) for query. The start time must be later than 48 hours ago. For example, if it's 9:00 AM 08 March 2020 now, the start time should be later than 9:00 AM 06 March 2020 in the same time zone(The timestamp should be more than 1583485200).
* endTime - The end time timestamp (UTC+0) for query must be later than the start time.
* timeInterval - An optional parameter to provide the time interval in seconds. The time interval must be a multiple of 60 and should be less than the time range from start time to end time.



* Return - A collection of objects of type SoftLayer_Container_Network_CdnMarketplace_Metrics.



--------------------





 getMappingRealTimeMetrics 

Returns the real-time metrics for the given mapping, including the total data (bandwidth and hits) over the given period of time and the detailed data divided with the given time interval. For more details, [View the examples](https://cloud.ibm.com/docs/CDN?topic=CDN-code-examples-using-the-cdn-apiexample-code-for-getting-real-time-metrics).



* Parameters:



* mappingUniqueId - Unique ID of the mapping for which metrics are queried.
* startTime - The start time timestamp (UTC+0) for query. The start time must be later than 48 hours ago.
Metric Name ibm_databases-for-cassandra_disk_used_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 







 Used memory for an instance 

How much memory your deployment is using.



Table 14. Used memory for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases-for-cassandra_memory_used_bytes 
 Metric Type gauge 
 Value Type byte 
 Segment By Service instance 







 Used JVM heap percent 

How much Java virtual machine (JVM) heap memory your deployment is using.



Table 15. Used JVM percent for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_cassandra_jvm_heap_percent 
 Metric Type graph 
 Value Type percent 
 Segment By Service instance 







 Garbage collection percent 15-minute average 

How much garbage collection has been used over 15 minutes as a percentage of total your deployment is using.



Table 16. Used JVM percent for an instance metric metadata

 Metadata Description 

 Metric Name ibm_cassandra_garbage_collection_percent_average_15m 
 Metric Type graph 
 Value Type percent 
 Segment By Service instance 









 Attributes for Segmentation 



 Global Attributes 

The following attributes are available for segmenting all of the metrics listed.



Table 17. Global Attributes Metadata

 Attribute Attribute Name Attribute Description 

 Cloud Type ibm_ctype The cloud type is a value of public, dedicated, or local. 
 Location ibm_location The location of the monitored resource - might be a region, data center, or global. 
 Resource ibm_resource The resource that is measured by the service - typically an identifying name or GUID. 
 Resource Type ibm_resource_type The type of the resource that is measured by the service. 
 Scope ibm_scope The scope is the account, organization, or space GUID associated with this metric. 







 More Attributes 



Table 18. Additional Attributes Metadata

 Attribute Attribute Name Attribute Description 

 Service instance ibm_service_instance The service instance segment identifies the instance the metric is associated with.
Select the Scope and define the Metrics to be exported.

For Scope, select one or more labels to filter the defined metrics.

Metrics must specify the complete metric name using PromQL.
8. Click Save.



After you save the confuguration, you must wait at least 30 minutes before the streaming is active.







 Enable or stop streaming through the UI 

You can start and stop streaming of metrics from the Metric Data Streaming page:



1. Launch the web UI as a user with administrator authority. For more information on how to launch the Web UI, see [Navigating to the Web UI](https://cloud.ibm.com/docs/monitoring?topic=monitoring-launchlaunch).
2. Click the user icon. This is the icon with the initials of the logged on user. Then click Settings.
3. Select Metric Data Streaming. The list of streaming configurations is displayed.

Zoom

![List of streaming configurations](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/streaming3.png)

Streaming configurations
4. Enable or disable a streaming configuration through the toggle.









 Manage streaming by using the API 

Complete the following steps to manage streaming through the UI:



 List the streaming configurations 

Use this method to get the details for all the existing streaming configurations.

curl --request GET https://<ENDPOINT>/api/v1/dataStream/configs
-H "content-type: application/json"
-H "Authorization: <TOKEN>"

Where



* <ENDPOINT>indicates the endpoint targetted by the REST API call. For more information, see [Monitoring REST API endpoints](https://cloud.ibm.com/docs/monitoring?topic=monitoring-endpointsendpoints_rest_api).