gcloud_alpha_dataflow_metrics_list (1)
NAME
- gcloud alpha dataflow metrics list - retrieves the metrics from a specific job
SYNOPSIS
-
gcloud alpha dataflow metrics list JOB_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 a
POSITIONAL ARGUMENTS
-
- JOB_ID
-
The job ID to operate on.
FLAGS
-
- --changed-after=CHANGED_AFTER
-
Only display metrics that have changed after the given time. See $ gcloud topic
datetimes for information on time formats. For example, 2018-01-01 is
the first day of the year, and -P2W is 2 weeks ago.
- --hide-committed
-
If true, hide committed values.
- --region=REGION_ID
-
The region ID of the job's regional endpoint.
- --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 filter EXPRESSION to each resource item to be listed. If
the expression evaluates True, then that item is listed. For more details
and examples of filter expressions, run $ gcloud topic filters. This flag
interacts with other flags that are applied in this order: --flatten,
--sort-by, --filter, --limit.
- --limit=LIMIT
-
Maximum number of resources to list. The default is unlimited. This flag
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: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
EXAMPLES
Filter metrics with the given name:
- $ gcloud alpha dataflow metrics list --filter="name=ElementCount"
Filter child metrics with matching transforms:
- $ gcloud alpha dataflow metrics list --transform=WordCount
Filter child output metrics:
- $ gcloud alpha dataflow metrics list --transform=WordCount/Write.*out
Filter all output metrics:
- $ gcloud alpha dataflow metrics list --transform=.*out
Filter all custom-defined user metrics
- $ gcloud alpha dataflow metrics list --source=user
Filter metrics with a scalar value greater than a threshold.
- $ gcloud alpha dataflow metrics list --filter="scalar > 50"
List metrics that have changed in the last 2 weeks:
- $ gcloud alpha dataflow metrics list --after=-P2W
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:
- $ gcloud beta dataflow metrics list