- INFORMATION
-
gcloud alpha mldiagnostics profiler-session captureis not available in universe domainuniverse. - NAME
-
- gcloud alpha mldiagnostics profiler-session capture - create profiler sessions
- SYNOPSIS
-
-
gcloud alpha mldiagnostics profiler-session capturePROFILER_SESSION--duration=DURATION[--async] [--device-tracer-level=DEVICE_TRACER_LEVEL; default="device-tracer-level-enabled"] [--host-tracer-level=HOST_TRACER_LEVEL; default="host-tracer-level-info"] [--is-trace-enabled] [--location=LOCATION] [--machine-learning-run=MACHINE_LEARNING_RUN] [--python-tracer-level=PYTHON_TRACER_LEVEL; default="python-tracer-level-disabled"] [--targets=[TARGETS,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Create a profiler session - EXAMPLES
-
To create the profiler session, run:
gcloud alpha mldiagnostics profiler-session capture --location=us-central1 --machine-learning-run=my-ml-run --targets=my-target-1 - POSITIONAL ARGUMENTS
-
-
ProfilerSession resource - Identifier. The name of the profiler session. Format:
projects/{project}/locations/{location}/machineLearningRuns/{machine_learning_run}/profilerSessions/{profiler_session}
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
profiler_sessionon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
profiler_sessionon the command line with a fully specified name; -
provide the argument
--locationon the command line; -
set the property
compute/region.
To set the
machine-learning-runattribute:-
provide the argument
profiler_sessionon the command line with a fully specified name; -
provide the argument
--machine-learning-runon the command line.
This must be specified.
PROFILER_SESSION-
ID of the profilerSession or fully qualified identifier for the profilerSession.
To set the
profiler_sessionattribute:-
provide the argument
profiler_sessionon the command line.
-
provide the argument
-
provide the argument
-
ProfilerSession resource - Identifier. The name of the profiler session. Format:
projects/{project}/locations/{location}/machineLearningRuns/{machine_learning_run}/profilerSessions/{profiler_session}
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
- REQUIRED FLAGS
-
--duration=DURATION- Duration for the profiler session.
- OPTIONAL FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--device-tracer-level=DEVICE_TRACER_LEVEL; default="device-tracer-level-enabled"-
Device tracer level for the session. If the field is not set or unspecified, the
default is
DEVICE_TRACER_LEVEL_ENABLED.DEVICE_TRACER_LEVELmust be one of:device-tracer-level-disabled- Tracer level is disabled.
device-tracer-level-enabled- Tracer level is enabled.
--host-tracer-level=HOST_TRACER_LEVEL; default="host-tracer-level-info"-
Host tracer level for the session. If the field is not set or unspecified, the
default is
HOST_TRACER_LEVEL_INFO.HOST_TRACER_LEVELmust be one of:host-tracer-level-critical- Tracer level is critical.
host-tracer-level-disabled- Tracer level is disabled.
host-tracer-level-info- Tracer level is info.
host-tracer-level-verbose- Tracer level is verbose.
--is-trace-enabled- Customer setting to enable trace level details for the session.
--location=LOCATION- For resources [profiler_session, targets], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
--machine-learning-run=MACHINE_LEARNING_RUN- For resources [profiler_session, targets], provides fallback value for resource machine-learning-run attribute. When the resource's full URI path is not provided, machine-learning-run will fallback to this flag value.
--python-tracer-level=PYTHON_TRACER_LEVEL; default="python-tracer-level-disabled"-
Python tracer level for the session. If the field is not set or unspecified, the
default is
PYTHON_TRACER_LEVEL_DISABLED.PYTHON_TRACER_LEVELmust be one of:python-tracer-level-disabled- Tracer level is disabled.
python-tracer-level-enabled- Tracer level is enabled.
-
ProfilerTarget resource - List of profiler targets. Targets on which profiler
session to be started. If empty, control plan shall start profiler session on
all the targets associated with ML Run. This represents a Cloud resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
To set the
projectattribute:-
provide the argument
--targetson the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
--targetson the command line with a fully specified name; -
provide the argument
--locationon the command line; -
set the property
compute/region.
To set the
machine-learning-runattribute:-
provide the argument
--targetson the command line with a fully specified name; -
provide the argument
--machine-learning-runon the command line.
-
provide the argument
--targets=[TARGETS,…]-
IDs of the profilerTargets or fully qualified identifiers for the
profilerTargets.
To set the
profiler-targetattribute:-
provide the argument
--targetson the command line.
-
provide the argument
- 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. - API REFERENCE
-
This command uses the
hypercomputecluster/v1alphaAPI. The full documentation for this API can be found at: https://docs.cloud.google.com/cluster-director/docs - NOTES
- This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist.
gcloud alpha mldiagnostics profiler-session capture
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-02-10 UTC."],[],[]]