vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Segment by IBM IS Generation 2, resource name 









 Network monitoring metrics 



 Bytes received for a network interface 

The cumulative number of bytes received for a network interface since virtual server instance start.



Table 6: Average CPU usage percentage metric metadata

 Metadata Description 

 Metric name ibm_is_instance_network_in_bytes 
 Metric type gauge 
 Value type byte 
 Segment by IBM IS Generation 2, resource name, MAC address of the network interface 







 Bytes sent for a network interface 

The cumulative number of bytes sent for a network interface since virtual server instance start.



Table 7: Bytes sent for a network interface metric metadata

 Metadata Description 

 Metric name ibm_is_instance_network_out_bytes 
 Metric type gauge 
 Value type byte 
 Segment by IBM IS Generation 2, resource name, MAC address of the network interface 







 Number of packets received for a network interface 

The cumulative number of packets that were received for a network interface since virtual server instance start.



Table 8: Number of packets received for a network interface metric metadata

 Metadata Description 

 Metric name ibm_is_instance_network_in_packets 
 Metric type gauge 
 Value type none 
 Segment by IBM IS Generation 2, resource name, MAC address of the network interface 







 Number of packets sent for a network interface 

The cumulative number of packets that are sent for a network interface since virtual server instance start.



Table 9: Number of packets sent for a network interface metric metadata

 Metadata Description 

 Metric name ibm_is_instance_network_out_packets 
 Metric type gauge 
 Value type none 
 Segment by IBM IS Generation 2, resource name, MAC address of the network interface 







 Number of receiving errors for a network interface 

The cumulative number of receiving errors for a network interface since virtual server instance start.



Table 10: Number of receiving errors for a network interface metric metadata

 Metadata Description 

 Metric name ibm_is_instance_network_in_errors 
 Metric type gauge 
 Value type none 
 Segment by IBM IS Generation 2, resource name, MAC address of the network interface 







 Number of sending errors for a network interface 

The cumulative number of sending errors for a network interface since virtual server instance start.



Table 11: Number of sending errors for a network interface metric metadata

 Metadata Description
[Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) 
 Simulated Historical Instrument Analytics ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) 
 Simulated Instrument Analytics ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) 
 Software Instance Hosted Globally Hosted Globally Hosted Globally Hosted Globally 
 Speech to Text ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) 
 Streaming Analytics ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/adcecdbe4e86955f88aac7f3c1e7ec3ff44992ef/icons/checkmark-icon.svg) !
VPC resource quota overview metrics definitions for quota dashboard 

Some VPC resources have quotas associated with them. The following metrics definitions allow the user to see the consumption number related to the quota along with the associated limit when using the quota dashboard.



 Quota metrics available by resource type 

Resources that offer quota metrics, detailed in Table 1.



Table 1: Services offering quota metrics

 Resource type Resource quota name Location Secondary resource ID 

 share share {region} {account id} 
 volume volume {region} {account id} 
 load-balancer load-balancer {region} {account id} 
 instance instance-vcpu {region} {account id} 
 instance instance-memory {region} {account id} 
 dedicated host instance-vcpu {region} {account id} 
 vpc vpc {region} {account id} 
 security-group security-group {region} {vpc id} 
 security-group security-group-rule {region} {security group id} 
 subnet subnet {region} {vpc id} 
 floating-ip floating-ip {region} {account id} 
 network-acl network-acl {region} {vpc id} 
 network-acl network-acl-rule {region} {network acl id} 





 Resource quota consumption 

The amount of a resource that is consumed for a given resource type, detailed in Table 2.



Table 2: Resource quota consumption metric metadata

 Description Metadata 

 Metric Name ibm_is_resource_quota_consumption 
 Metric Type gauge 
 Value Type none 
 Segment By IBM IS Generation, Name of resource type for quota, Associated Resource 







 Resource quota limit 

The resource quota limit for a given resource type, detailed in Table 3.



Table 3: Resource quota limit metric metadata

 Description Metadata 

 Metric Name ibm_is_resource_quota_limit 
 Metric Type gauge 
 Value Type none 
 Segment By IBM IS Generation, Name of resource type for quota, Associated Resource 









 Attributes for segmentation 



 Global attributes 

The following attributes are available for segmenting all previously mentioned metrics.



Table 4: Global attributes

 Attribute name Attribute Attribute description 

 Cloud Type ibm_ctype The cloud type is a value of public, dedicated or local
By using this selective access, metrics can be available to some resource groups and not to others.
6. Check the Enable Platform Metrics checkbox. You must select this option to receive metrics from your VPN server.
7. Click Create. You are taken back to the monitoring metrics home page.



Within a few minutes, your new IBM Cloud Monitoring instance displays with several configurations. You might have to refresh your browser to see it.



 Working with the IBM Cloud Monitoring dashboard 

To view and work with your IBM Cloud Monitoring metrics, follow these steps:



1. Navigate to the [metrics monitoring portal](https://cloud.ibm.com/observe/monitoring).
2. Click Open Dashboard next to the service name of the IBM Cloud Monitoring instance that you want to work with.

The first time that you access your IBM Cloud Monitoring instance, several windows display as part of the internal setup. Keep the default entries, and click through the pages until you reach the main IBM Cloud Monitoring page.
3. Open the IBM VPN for VPC Monitoring Metrics dashboard by selecting Dashboards.
4. Click Dashboard Library > IBM > VPC VPN Server. The default dashboard is not editable.
5. The dashboard shows six main metrics. These metrics include VPN server health status, VPN server active client count, VPN server authentication failure count, VPN server CRL days until expiration, and VPN server bytes input/output. If you want to modify the parameters and segment your metrics by VPN server name, you must create a custom dashboard.

You can choose what time window that you'd like to see your metrics by using the time selection bar.







 Creating a custom metrics dashboard 

You can create your own dashboard to customize your monitoring metrics, such as viewing information and traffic about particular VPN servers.

To customize your dashboard, use the following steps:



1. Navigate to the [metrics monitoring portal](https://cloud.ibm.com/observe/monitoring).
2. Click Open Dashboard next to the service name of the IBM Cloud Monitoring instance you want to work with.
You can use a vector matching operation, which is similar to an SQL join, to add the information labels to your metric data.



 Example: Filtering an application metric by cluster 

In this example, a metric that is returned by an application is filtered by cluster. The PromQL aggregates a value of that metric for a cluster by having only one cluster selected in the scope.

sum (myapp_metric * on (container_id) kube_pod_container_info{cluster=$cluster})

This query:



* Filters the kube_pod_container_info information metric for only a specific cluster ($cluster, which is set as a dashboard variable) based on the cluster label and for a specific timeseries.
* Matches the myapp_metric non-information metric to the filtered kube_pod_container_info information metric when the container_id label has the same value. The values are multiplied, but because the information metric has a value of 1, the result is unchanged. The cluster label is added to the resulting data.
* Aggregates the timeseries of value myapp_metric by using the sum function, and returns the result.







 Example: Filtering average CPU used by account and region 

In this example, the average CPU used (percent) is calculated for a specific IBM Cloud account and region.

avg by(region,account_id) (host_cpu_used_percent * on (host_mac) group_left(region,account_id) sysdig_cloud_provider_info{account_id=$account, region=$region})

This query:



* Filters the sysdig_cloud_provider_info information metric for only a specific region ($region) and account ($account) that are set as dashboard variables based on the region and account_id labels.
* Matches the host_cpu_used_percent non-information metric to the filtered sysdig_cloud_provider_info information metric when the host_mac label has the same value. The values are multiplied, but because the information metric has a value of 1, the result is unchanged. The region and account labels are added to the resulting data.
* Calculates the average of the new metrics by account and region.









 cURL sample to extract latest metric
(https://cloud.ibm.com/docs-content/v1/content/dad8f28785f0dc036aaae4b777787e73db9ff0d4/metrics-router//images/metrics-routing-ov.png)

Figure 1. IBM Cloud Metrics Routing sample architecture



 Configuring the account 

To configure IBM Cloud Metrics Routing in your account, you must define where metrics are routed and stored. You must configure 1 or more targets, and 1 or more routes. You must also configure the account settings.



* A target defines the resource and location where time series data is routed. For more information, see [Targets](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-target&interface=api).
* A route defines the rules that indicate where time series data is routed in your account. For more information, see [Routes](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-routes&interface=api).
* The account settings configuration defines information such as default targets where metrics are collected in the account, type of endpoints that are allowed to manage the configuration, and allowed locations to store the data in the account. For more information, see [Account settings](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-settings).



You can configure the following types of targets:



Table 1. List of targets

 Target Type When to use 

 IBM Cloud Monitoring sysdig-monitor Consolidate time series data to the region of your primary operations. 



The following table outlines the locations where you can configure IBM Cloud Metrics Routing to collect and manage metrics:



Table 2. Supported locations

 Geo Region IBM Cloud Metrics Routing 

 Asia Pacific Chennai (in-che) 
 Asia Pacific Tokyo (jp-tok) 
 Asia Pacific Seoul (kr-seo) 
 Asia Pacific Sydney (au-syd) !
[Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) 
 vApp: View VM metrics ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) !
[Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) 
 Organization VDC: view metrics ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) 
 Organization vDC: VM-VM Affinity Edit ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) 
 Organization: Edit Association Settings ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/icons/checkmark-icon.svg) 
 Organization: Edit Federation Settings !
Metadata Description 

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







 Tuples inserted count 

Tuples inserted count



Table 30: Tuples inserted count metric metadata

 Metadata Description 

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







 Tuples inserted rate 

Tuples inserted rate



Table 31: Tuples inserted rate metric metadata

 Metadata Description 

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







 Tuples returned rate 

Tuples returned rate



Table 32: Tuples returned rate metric metadata

 Metadata Description 

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







 Tuples updated count 

Tuples updated count



Table 33: Tuples updated count metric metadata

 Metadata Description 

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







 Tuples updated rate 

Tuples updated rate



Table 34: Tuples updated rate metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_postgresql_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. Only for deployments that have dedicated CPU.



Table 35. Used CPU for an instance metric metadata

 Metadata Description 

 Metric Name ibm_databases_for_postgresql_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
Prometheus metrics 

As an alternative to IBM Cloud® Monitoring, you can use the [Prometheus](https://developer.ibm.com/components/prometheus/) open-source systems monitoring and alerting toolkit to monitor your IBM Blockchain Platform peer, orderer, and certificate authority (CA) nodes, and smart contract containers.

This tutorial helps you get started using Prometheus to monitor resource usage of peer, CA, and ordering service nodes. It describes how to configure Prometheus to monitor your existing IBM Blockchain Platform service instance.

Monitoring node resource allocation is critical to operating a blockchain network. You are responsible for monitoring resource usage and taking steps to address any resource contention. Prometheus is a useful tool for monitoring resources, but you can use any comparable alternative.



 Before you begin 

Before using this tutorial, you should have an IBM Blockchain Platform service instance deployed and configured with peer, CA, and ordering service nodes running and ready for monitoring. You will also use the IBM Blockchain Platform Console.





 Step one: Create a Sysdig identity to access nodes 

[Sysdig](https://sysdig.com/) uses mutual Transport Layer Security (TLS) to access cluster nodes. Use your organization’s TLS certificate authority (CA) to generate a private and public key pair for your new Sysdig identity.

For the component you are scraping Prometheus metrics from, select the CA that issued its certificates. Then, click Register User to create a new user identity that will access your network from Sysdig. Specify the Enroll ID and Secret for this user, and set the type to client.

Next, click Enroll Identity and select the TLS Certificate Authority from the CA drop-down list. Enter the Enroll ID and Secret that you specified in the previous step. When you click Next, the subsequent panel contains the certificates generated for your new user identity.

Enter an Identity display name. Click Add identity to Wallet to store the keys in your console wallet. These certificates are stored in the browser and are not saved by IBM Blockchain Platform.
[Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) 
 sysdig-monitor.dashboard-metrics-data.read Read dashboard metrics. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) 
 sysdig-monitor.dashboard.edit Edit dashboards. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/checkmark-icon.svg) !
: A list of Kafka brokers separated by commas, for example kafka-2.mh-svc.eu-de.containers.appdomain.cloud:9093,kafka-1.mh-svc.eu-de.containers.appdomain.cloud:9093,kafka-0.mh-svc.eu-de.containers.appdomain.cloud:9093. Notice that you must not enclose within " the URLs.

TLS
: The Transport Layer Security (TLS) method. Enable TLS to encrypt and protect the transfer of data.

Credentials
: The credentials used by Monitoring to to export the data from the Monitoring instance to the Kafka server. You can choose user and password, or a base64 encoded certificate.

Zoom

![Credential options](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/streaming2.png)

Credential options

Compression
: Choose the type of compression. Valid options are: LZ4, Snappy, Gzip, and Zstandard. For more information, see [Message compression in Apache Kafka](https://developer.ibm.com/articles/benefits-compression-kafka-messaging/).
6. Click Test Connection to verify the connection between IBM Cloud Monitoring and Kafka has been successfully configured.

You must test the connection before saving and enable the configuration.
7. 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.
[Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) 
 Organization VDC: view metrics ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) ![Available](https://cloud.ibm.com/docs-content/v1/content/11f96f96f8f4b60cf6f3fa4d904856a2c4528bc2/icons/checkmark-icon.svg) !
The monitoring metrics reflect the metrics coming from those listeners and health check port, or the back-end member ports. 



The following sample values are for the ibm_is_load_balancer_pool_name attribute in its different configurations. If the pool has no members, then this value will be in the format Pool_ListenerPort. If the pool has members and the health check port is configured, then this value will be in the format Pool_ListenerPort:HealthCheckPort. Otherwise, if the pool has members but no health check port configured, then the value will be Pool_ListenerPort:Member1Port/Member2Port/....



Table 14: Pool name attribute

 Listener Port HealthCheck Port Member1 Port Member2 Port Member3 Port 'ibm_is_load_balancer_pool_name Value' 

 9999 <br><br> * <br><br><br> <br><br> * <br><br><br> <br><br> * <br><br><br> <br><br> * <br><br><br> Pool_9999 
 80 80 80 8090 <br><br> * <br><br><br> Pool_80:80 
 8099 443 9080 7080 8888 Pool_8099:443 
 8081 <br><br> * <br><br><br> 80 8090 9090 Pool_8081:9090/8090/80 
 8088 <br><br> * <br><br><br> 9080 7080 <br><br> * <br><br><br> Pool_8088:9080/7080 



The displayed metrics contain a timestamp in UNIX epoch time and the metric value for the time interval ending at that timestamp. You can specify different scopes, as well as the time interval over which to report the metrics.

The supported listener protocols for IBM Cloud Application Load Balancer include:



* HTTP
* HTTPS
* TCP



Specifying a listener port filters the metric by that listener.