| copyright | lastupdated | keywords | subcollection | ||
|---|---|---|---|---|---|
|
2024-10-09 |
IBM Cloud, registry, monitoring, metrics, pull traffic, storage usage, storage quota, monitor, locations, dashboard, storage, region, platform metrics |
Registry |
{{site.data.keyword.attribute-definition-list}}
{: #registry_monitor}
You can use {{site.data.keyword.mon_full}} to monitor platform metrics of {{site.data.keyword.registrylong}} usage for your account and to create alerts based on these metrics. {: shortdesc}
Platform metrics for {{site.data.keyword.registryshort_notm}} must be enabled in each {{site.data.keyword.registryshort_notm}} region that you want to monitor, see Enabling metrics for {{site.data.keyword.registryshort}}. For more information about {{site.data.keyword.monitoringlong_notm}}, see {{site.data.keyword.monitoringshort}} in {{site.data.keyword.cloud_notm}}.
{: #registry_enable_platform_metrics}
You must enable {{site.data.keyword.registryshort_notm}} metrics in each region that you want to see metrics. {: note}
You can create a {{site.data.keyword.mon_short}} instance in the region that you want to monitor and enable platform metrics for it. Alternatively, you can enable platform metrics on an existing {{site.data.keyword.mon_short}} instance in that region.
Complete the following steps to create and configure platform metrics for {{site.data.keyword.registryshort_notm}}.
-
Create and configure an {{site.data.keyword.mon_full_notm}} instance that is configured with platform metrics in the region that you want to monitor, see Getting started with {{site.data.keyword.mon_full_notm}}.
For more information about the locations where {{site.data.keyword.registryshort_notm}} is enabled for monitoring, see Locations of platform metrics.
-
Log in to {{site.data.keyword.cloud_notm}}.
ibmcloud login
{: pre}
-
Target the region where you want to enable metrics by running the
ibmcloud cr region-setcommand. Replace<region>with the name of the region.ibmcloud cr region-set <region>
{: pre}
-
Check whether metrics are already enabled for your account by running the following
ibmcloud cr platform-metricscommand. This command also displays the registry that the result applies to.ibmcloud cr platform-metrics --status
{: pre}
-
Enable platform metrics by running the following
ibmcloud cr platform-metricscommand. It can take up to 30 minutes for your metrics to become effective.ibmcloud cr platform-metrics --enable
{: pre}
If you want to target a different region, run the
ibmcloud cr region-setcommand.
{: #registry_monitor_locations}
You can configure one monitoring instance in each region to collect platform metrics for {{site.data.keyword.registrylong_notm}}. The following tables list the locations where metrics can be collected if you enable collection of {{site.data.keyword.registryshort_notm}} service metrics in that region.
| Locations in Americas | Platform metrics available |
|---|---|
Dallas (us-south) |
Yes |
Sao Paulo (br-sao) |
Yes |
Toronto (ca-tor) |
Yes |
| {: caption="The automatic collection of {{site.data.keyword.registryshort_notm}} service metrics in Americas locations" caption-side="bottom"} | |
| {: #table_registry_monitor_collect_service_metrics_americas} |
| Locations in Asia Pacific | Platform metrics available |
|---|---|
Osaka (jp-osa) |
Yes |
Sydney (au-syd) |
Yes |
Tokyo (jp-tok) |
Yes |
| {: caption="The automatic collection of {{site.data.keyword.registryshort_notm}} service metrics in Asia Pacific locations" caption-side="bottom"} | |
| {: #table_registry_monitor_collect_service_metrics_ap} |
| Locations in Europe | Platform metrics available |
|---|---|
Frankfurt (eu-de) |
Yes |
London (eu-gb) |
Yes |
Madrid (eu-es) |
Yes |
| {: caption="The automatic collection of {{site.data.keyword.registryshort_notm}} service metrics in Europe locations" caption-side="bottom"} | |
| {: #table_registry_monitor_collect_service_metrics_europe} |
| Location for Global | Platform metrics available |
|---|---|
Global |
Yes |
| {: caption="The automatic collection of {{site.data.keyword.registryshort_notm}} service metrics for Global" caption-side="bottom"} | |
| {: #table_registry_monitor_collect_service_metrics_global} |
For more information about where to see {{site.data.keyword.registryshort_notm}} metrics, see Where to look for metrics.
For more information about the locations where {{site.data.keyword.cloud_notm}} services are enabled to send metrics to {{site.data.keyword.mon_full_notm}}, see {{site.data.keyword.cloud_notm}} services by location.
{: #registry_monitor_ui}
{: #registry_monitor_ui_at}
The region in which a {{site.data.keyword.registryshort}} or a Vulnerability Advisor metric is available corresponds to the region of the {{site.data.keyword.registryshort}} that generated the metric.
The following table shows the location of {{site.data.keyword.mon_short}} metrics.
| Region for your account's registry | Domain name of your registry | Location of {{site.data.keyword.mon_short}} metrics |
|---|---|---|
ap-north |
jp.icr.io |
Tokyo (jp-tok) |
ap-south |
au.icr.io |
Sydney (au-syd) |
br-sao |
br.icr.io |
Sao Paulo (br-sao) |
ca-tor |
ca.icr.io |
Toronto (ca-tor) |
eu-central |
de.icr.io |
Frankfurt (eu-de) |
eu-es |
es.icr.io |
Madrid (eu-es) |
jp-osa |
jp2.icr.io |
Osaka (jp-osa) |
uk-south |
uk.icr.io |
London (eu-gb) |
us-south |
us.icr.io |
Dallas (us-south) |
| {: caption="Location of {{site.data.keyword.mon_short}} metrics" caption-side="bottom"} | ||
| {: #table_registry_monitor_metrics_location} |
The following table shows the location of global registry {{site.data.keyword.mon_short}} metrics.
| Registry | Global registry | Location of {{site.data.keyword.mon_short}} metrics |
|---|---|---|
Global |
icr.io |
Washington (us-east) |
| {: caption="Location of global registry {{site.data.keyword.mon_short}} metrics" caption-side="bottom"} | ||
| {: #table_registry_monitor_metrics_location_global} |
{: #registry_view_metrics}
To monitor {{site.data.keyword.registryshort_notm}} metrics, you must start the {{site.data.keyword.mon_short}} UI instance that is enabled for platform metrics in the region where you are using {{site.data.keyword.registryshort_notm}}. {: important}
{: #registry_view_metrics_opt2}
To start the Monitoring UI from the Observability page, complete the following steps:
- Start the Monitoring UI.
- Select DASHBOARDS.
- In the Default Dashboards section, expand IBM.
- Choose the {{site.data.keyword.registryshort_notm}} dashboard from the list. Available dashboards are Container Registry Usage and Container Registry Quota Usage. For more information about predefined dashboards, see Predefined dashboards.
Next, change the scope or make a copy of the Default dashboard so that you can monitor your account in {{site.data.keyword.registryshort_notm}}. For more information, see Working with dashboards.
{: #registry_dashboards_dictionary}
The following table outlines the predefined monitoring dashboards that you can use to monitor {{site.data.keyword.registryshort_notm}} metrics.
| Dashboard name | Description | Default dashboard |
|---|---|---|
| {{site.data.keyword.registryshort_notm}} Usage | A dashboard that you can use to visualize the traffic usage and storage usage. Traffic usage is the sum of bytes from image pulls from your {{site.data.keyword.registryshort_notm}} namespaces in the current billing period. Storage usage is the sum of bytes of images in your {{site.data.keyword.registryshort_notm}} namespaces. | Yes |
| {{site.data.keyword.registryshort_notm}} Quota Usage | A dashboard that you can use to visualize the traffic usage and storage usage and compare the data to your quotas, if set. Visible only to those accounts that have finite quotas. The Container Registry Quota Usage dashboard is available only if you enable metrics and you have both a storage and a traffic quota set. | No |
| {: caption="Predefined dashboards" caption-side="bottom"} | ||
| {: #table_registry_monitor_dashboards_predefined} |
The predefined dashboards can't be changed. You can copy any predefined dashboard so that you can change it to suit your requirements. For more information, see Working with dashboards. {: important}
When you start your dashboard, some metrics might display a Data Load Error warning icon. This warning is because more time is required to create the data. When data is available, the warning sign goes away, and the metric is populated. You might also need to change the resolution period.
{: note}
{: #metrics}
| Metric Name | Information |
|---|---|
Pull Traffic |
The account's pull traffic in the current month. |
Pull Traffic Quota |
The account's pull traffic quota. |
Storage Quota |
The account's storage quota. |
Storage |
The account's storage usage. |
| {: caption="Metrics available by plan names" caption-side="bottom"} | |
| {: #table_registry_monitor_metrics_plan} |
{: #ibm_containerregistry_pull_traffic}
The account's pull traffic in the current month.
| Metadata | Description |
|---|---|
Metric Name |
ibm_containerregistry_pull_traffic |
Metric Type |
gauge |
Value Type |
byte |
| {: caption="Pull Traffic metric metadata" caption-side="bottom"} | |
| {: #table_registry_monitor_metrics_pull_traffic} |
{: #ibm_containerregistry_pull_traffic_quota}
The account's pull traffic quota.
| Metadata | Description |
|---|---|
Metric Name |
ibm_containerregistry_pull_traffic_quota |
Metric Type |
gauge |
Value Type |
byte |
| {: caption="Pull Traffic Quota metric metadata" caption-side="bottom"} | |
| {: #table_registry_monitor_metrics_pull_traffic_quota} |
{: #ibm_containerregistry_storage_quota}
The account's storage quota.
| Metadata | Description |
|---|---|
Metric Name |
ibm_containerregistry_storage_quota |
Metric Type |
gauge |
Value Type |
byte |
| {: caption="Storage Quota metric metadata" caption-side="bottom"} | |
| {: #table_registry_monitor_metrics_storage_quota} |
{: #ibm_containerregistry_storage}
The account's storage usage.
| Metadata | Description |
|---|---|
Metric Name |
ibm_containerregistry_storage |
Metric Type |
gauge |
Value Type |
byte |
| {: caption="Storage metric metadata" caption-side="bottom"} | |
| {: #table_registry_monitor_metrics_storage} |