Monitor EKM usage

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

You can use Cloud Monitoring to monitor your external key manager (EKM) connection. The following metrics can help you understand your EKM usage:

• cloudkms.googleapis.com/ekm/external/request_latencies
• cloudkms.googleapis.com/ekm/external/request_count

This page shows you how to create a dashboard to track metrics related to your Cloud EKM keys and external key manager connection, such as request counts and latencies. For more information about these metrics, see cloudkms metrics. For more information about the dashboard creation process described in the following sections, see Managing dashboards by API.

Before you begin

The steps on this page assume the following:

• You already have Cloud EKM set up in a project, including an EKM connection and one or more external keys.

Required roles

To get the permissions that you need to create dashboards using the gcloud CLI, ask your administrator to grant you the following IAM roles on your project:

• Monitoring Dashboard Configuration Editor (roles/monitoring.dashboardEditor)
• Service Usage Consumer (roles/serviceusage.serviceUsageConsumer)

For more information about granting roles, see Manage access.

These predefined roles contain the permissions required to create dashboards using the gcloud CLI. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to create dashboards using the gcloud CLI:

• monitoring.dashboards.create
• monitoring.dashboards.delete
• monitoring.dashboards.update
• serviceusage.services.use

You might also be able to get these permissions with custom roles or other predefined roles.

Create a dashboard to monitor your EKM

To monitor the status of your EKM, create a dashboard that monitors your request count and latencies:

1. Download the dashboard configuration: ekm-dashboard.json.

2. Create a custom dashboard with the configuration file by running the following command:

   gcloud monitoring dashboards create \
   --config-from-file=ekm-dashboard.json

View your EKM dashboard

1. In the Google Cloud console, go to the Monitoring page, or use the following button:

   Go to Monitoring

2. Select Resources > Dashboards and view the dashboard named Cloud KMS EKM.

What's next

• Explore your data across various metric dimensions using Metrics Explorer.
• Optional: Create alerting policies.