gcloud alpha dataflow metrics list

NAME
gcloud alpha dataflow metrics list - retrieves the metrics from a specific job
SYNOPSIS
gcloud alpha dataflow metrics listJOB_ID[--changed-after=CHANGED_AFTER][--hide-committed][--region=REGION_ID][--source=SOURCE; default="all"][--tentative][--transform=TRANSFORM][--filter=EXPRESSION][--limit=LIMIT][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) This command can be used to explore the job's metrics at afine-grained level.
EXAMPLES
Filter metrics with the given name:
gcloudalphadataflowmetricslistJOB--filter="name=ElementCount"

Filter child metrics with matching transforms:

gcloudalphadataflowmetricslistJOB--transform=WordCount

Filter child output metrics:

gcloudalphadataflowmetricslistJOB--transform=WordCount/Write.*out

Filter all output metrics:

gcloudalphadataflowmetricslistJOB--transform=.*out

Filter all custom-defined user metrics

gcloudalphadataflowmetricslistJOB--source=user

Filter metrics with a scalar value greater than a threshold.

gcloudalphadataflowmetricslistJOB--filter="scalar > 50"

List metrics that have changed in the last 2 weeks:

gcloudalphadataflowmetricslistJOB--changed-after=-P2W
POSITIONAL ARGUMENTS
JOB_ID
Job ID to operate on.
FLAGS
--changed-after=CHANGED_AFTER
Only display metrics that have changed after the given time. See $gcloud topic datetimes forinformation on time formats. For example,2018-01-01 is the firstday of the year, and-P2W is 2 weeks ago.
--hide-committed
If true, hide committed values.
--region=REGION_ID
Region ID of the job's regional endpoint. Defaults to 'us-central1'.
--source=SOURCE; default="all"
Set the metrics source.SOURCE must be one of:
all
Retrieves all metrics.
service
Retrieves only dataflow service metrics.
user
Retrieves only custom user metrics.
--tentative
If true, display tentative values.
--transform=TRANSFORM
Filters only the metrics that prefix match the given regex.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filterEXPRESSION to each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--limit=LIMIT
Maximum number of resources to list. The default isunlimited. Thisflag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
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 help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetadataflowmetricslist

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-05-07 UTC.