gcloud workbench instances diagnose Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud workbench instances diagnose - diagnoses a workbench instance
- SYNOPSIS
gcloud workbench instances diagnose(INSTANCE:--location=LOCATION)--gcs-bucket=GCS_BUCKET[--async][--enable-copy-home-files][--enable-packet-capture][--enable-repair][--relative-path=RELATIVE_PATH][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Diagnoses a workbench instance.
- EXAMPLES
- To diagnose an instance, run:
gcloudworkbenchinstancesdiagnoseexample-instance--location=us-west1-b--gcs-bucket=gs://example-bucketTo diagnose an instance with a relative path:
gcloudworkbenchinstancesdiagnoseexample-instance--location=us-west1-b--gcs-bucket=gs://example-bucket--relative-path=logsTo diagnose an instance, with packet capture:
gcloudworkbenchinstancesdiagnoseexample-instance--location=us-west1-b--gcs-bucket=gs://example-bucket--enable-packet-capture - POSITIONAL ARGUMENTS
- Instance resource - User-defined unique name of this instance. The instance namemust be 1 to 63 characters long and contain only lowercase letters, numericcharacters, and dashes. The first character must be a lowercase letter and thelast character cannot be a dash. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
INSTANCE- ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:- provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- Google Cloud location of this environmenthttps://cloud.google.com/compute/docs/regions-zones/#locations.
To set the
locationattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
notebooks/location.
- provide the argument
- provide the argument
- Instance resource - User-defined unique name of this instance. The instance namemust be 1 to 63 characters long and contain only lowercase letters, numericcharacters, and dashes. The first character must be a lowercase letter and thelast character cannot be a dash. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- REQUIRED FLAGS
--gcs-bucket=GCS_BUCKET- The Cloud Storage bucket where the log files generated from the diagnose commandwill be stored. storage.buckets.writer permissions must be given to project'sservice account or user credential. Format: gs://
{gcs_bucket}
- OPTIONAL FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--enable-copy-home-files- Enables flag to copy all
/home/jupyterfolder contents --enable-packet-capture- Enables flag to capture packets from the instance for 30 seconds
--enable-repair- Enables flag to repair service for instance
--relative-path=RELATIVE_PATH- Defines the relative storage path in the Cloud Storage bucket where thediagnostic logs will be written. Default path will be the root directory of theCloud Storage bucketFormat of full path:gs://
{gcs_bucket}/{relative_path}/
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- This variant is also available:
gcloudbetaworkbenchinstancesdiagnose
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-01 UTC.