Enable Cloud Monitoring for Workbench Instances

01 Sign in to the Google Cloud Management Console.

02 Select the GCP project that you want to examine from the console top navigation bar.

03 Navigate to Vertex AI console available at https://console.cloud.google.com/vertex-ai.

04 In the main navigation panel, under NOTEBOOKS, choose Workbench, and select the INSTANCES tab.

05 Choose View: INSTANCES to list the Vertex AI notebook instances created for the selected GCP project.

06 Click on the name (link) of the notebook instance that you want to examine.

07 Select the HEALTH tab and check the Cloud Monitoring setting status to determine if the Cloud Monitoring agent is enabled for your instance. If the Cloud Monitoring status is set to Not installed, the software agent is not installed, therefore, the Cloud Monitoring feature is not enabled for the selected Vertex AI notebook instance.

08 Repeat steps no. 6 and 7 for each Vertex AI notebook instance launched for the selected GCP project.

09 Repeat steps no. 2 – 8 for each project deployed within your Google Cloud account.

01 Run projects list command (Windows/macOS/Linux) with custom query filters to list the ID of each project available in your Google Cloud account:

gcloud projects list
  --format="table(projectId)"

02 The command output should return the requested GCP project ID(s):

PROJECT_ID
cc-vertex-project-123123
cc-appdata-project-112233

03 Run workbench instances list command (Windows/macOS/Linux) with the ID of the GCP project that you want to examine as the identifier parameter, to describe the name of each Vertex AI notebook instance created for the selected project:

gcloud workbench instances list
  --project cc-vertex-project-123123
  --location=us-central1-a
  --format="(NAME)"

04 The command output should return the requested notebook instance names:

NAME: tm-vertex-ai-notebook-instance
NAME: tm-development-notebook-instance

05 Run workbench instances describe command (Windows/macOS/Linux) with the name of the Vertex AI notebook instance that you want to examine as the identifier parameter and custom output filters to determine if the Cloud Monitoring agent is installed on the selected instance:

gcloud workbench instances describe tm-vertex-ai-notebook-instance
  --location=us-central1-a
  --format="yaml(gceSetup.metadata.install-monitoring-agent)"

06 The command output should return 'true' for install-monitoring-agent if the software agent is installed or null if the agent is not installed:

null

07 Repeat steps no. 5 and 6 for each Vertex AI notebook instance provisioned for the selected GCP project.

08 Repeat steps no. 3 – 7 for each GCP project deployed in your Google Cloud account.

01 Sign in to the Google Cloud Management Console.

01 Select the GCP project that you want to access from the console top navigation bar.

01 Navigate to Vertex AI console available at https://console.cloud.google.com/vertex-ai.

01 In the main navigation panel, under NOTEBOOKS, choose Workbench, and select the INSTANCES tab.

01 Choose CREATE NEW, select ADVANCED OPTIONS, and perform the following actions to create your new notebook instance:

1. For Details, provide the following information:
   1. For Name, enter a unique name for your new notebook instance.
   2. For Region and Zone, select the GCP location where the instance will be deployed.
   3. (Optional) Check the Enable Dataproc Serverless Interactive Sessions setting checkbox to enable access to Dataproc Spark kernels.
   4. (Optional) For Labels, choose ADD LABEL, and use the Key and Value fields to create labels for the new instance.
   5. (Optional) Use Network tags to assign network tags to your Workbench instance.
   6. For Workbench type, choose Instance.
   7. Choose Continue to continue the instance setup.
2. For Environment, perform the following actions:
   1. Choose whether to use a custom container or the latest version of the Vertex AI Workbench for the instance environment.
   2. (Optional) For Post-startup script, you can select a script that automatically runs after the instance boots up.
   3. (Optional) For Metadata, choose ADD METADATA to add metadata keys to your Workbench instance.
   4. Choose Continue to continue the setup.
3. For Machine type, perform the following operations:
   1. For Machine type, choose the appropriate machine type for your workload.
   2. For Shielded VM, check the Secure Boot, Virtual Trusted Platform Module (vTPM), and Integrity monitoring checkboxes for the most secure instance configuration.
   3. For Idle shutdown, check the Enable Idle Shutdown checkbox to enable the Idle Shutdown feature for the new instance. Enter the preferred idle timeout value (in minutes) in the Time of inactivity before shutdown (Minutes) box.
   4. Choose Continue to continue the setup process.
4. For Disks, perform the following operations:
   1. For Disks, choose the boot disk type and boot disk size (GB) for the instance disks. (Optional) Check the Delete to trash checkbox if you want to use the operating system's trash behavior.
   2. For Encryption, choose Cloud KMS key, and select the Cloud KMS Customer-Managed Encryption Key (CMEK) that you want to use for data encryption (recommended).
   3. Choose Continue to continue the setup.
5. For Networking, choose Network in this project, and select the appropriate VPC network and subnetwork. Ensure that a custom, non-default VPC network is selected (recommended). Choose whether to allow HTTPS access to your JupyterLab instance. For network isolation and stringent compliance, uncheck the Assign external IP address checkbox to prevent adding an external IP address to the instance. Choose Continue to continue the setup process.
6. For IAM and security, perform the following actions:
   1. For IAM and security, configure who can use the instance's JupyterLab interface. Choose Service account for default instance access or choose Single user to restrict access to one user only. Choose whether to use the default Compute Engine service account or a custom service account.
   2. For Security options, uncheck the Root access to the instance checkbox to disable the root access to the new instance, and choose whether to allow terminal access and file downloads from JupyterLab.
   3. Choose Continue to continue the setup.
7. For System health, perform the following operations:
   1. For System health, check the Environment auto-upgrade checkbox to enable automatic upgrades. Choose whether to upgrade your new instance Weekly or Monthly.
   2. For Reporting, check the Install Cloud Monitoring checkbox to install the Cloud Monitoring agent and enable the monitoring feature for the new instance. You can also check the Report custom metrics to Cloud Monitoring checkbox to collect system status and JupyterLab metrics. Ensure that Report system health and Report DNS status for required Google domains checkboxes are also checked for core service and DNS status verification.
   3. Choose CREATE to launch your new Google Cloud Vertex AI notebook instance.

01 Repeat step no. 5 for each Vertex AI notebook instance that you want to re-create, launched for the selected GCP project.

01 Repeat steps no. 2 – 6 for each project deployed within your Google Cloud account.

01 Run workbench instances create command (Windows/macOS/Linux) to create a new Google Cloud Vertex AI notebook instance with Cloud Monitoring enabled. To enable the monitoring feature for your new notebook instance, set the --metadata parameter value to 'install-monitoring-agent'='true' to install the required Cloud Monitoring agent:

gcloud workbench instances create tm-vertex-ai-notebook-instance
  --project=cc-vertex-project-123123
  --container-repository=gcr.io/deeplearning-platform-release/base-cpu
  --container-tag=latest
  --machine-type=e2-standard-2
  --location=us-central1-a
  --shielded-integrity-monitoring=true
  --shielded-secure-boot=true
  --shielded-vtpm=true
  --metadata 'install-monitoring-agent'='true'
  --format="yaml(gceSetup.metadata.install-monitoring-agent)"

02 The command output should return the Cloud Monitoring agent status for the new instance:

Waiting for operation on Instance [tm-vertex-ai-notebook-instance] to be updated with [projects/cc-vertex-project-123123/locations/us-central1-a/operations/operation-abcd1234abcd-abcd1234abcd-abcd1234-abcd1234]...done.
Created workbench instance tm-vertex-ai-notebook-instance [https://notebooks.googleapis.com/v2/projects/cc-vertex-project-123123/locations/us-central1-a/operations/operation-abcd1234abcd-abcd1234abcd-abcd1234-abcd1234].

gceSetup:
	metadata:
	install-monitoring-agent: 'true'

03 Repeat step no. 1 and 2 for each Vertex AI notebook instance that you want to re-create, provisioned for the selected GCP project.

04 Repeat steps no. 1 – 3 for each GCP project deployed in your Google Cloud account.