Upload metrics

Synopsis

View upload metrics.

Syntax

Get-DataStreamMetrics [[-StreamID] <String>] [[-Start] <String>] [[-End] <String>] [[-GroupID] <Int32>] [[-AggregationInterval] <String>] [-IncludeDetails] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets aggregated metrics for log file uploads, including success or failure upload counts, upload latency, and the volume of data uploaded in the stream.

To get metrics from a specific time range, set the -Start and -End dates. To get the group data by time intervals, set the -AggregationInterval parameter.

Parameters

‑AccountSwitchKey	StringPipeline input: False An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑AggregationInterval	StringAccepted values: `FIVE_MINUTE`, `HOUR`, `DAY`Pipeline input: False Specifies the time interval for metrics aggregation, either 5 minutes, an hour, or 24 hours. If omitted, this operation returns the metrics grouped in hourly intervals.
‑EdgeRCFile	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
‑End	StringPipeline input: False Specifies the end of the time range for the metrics in ISO 8601 format. Set this no more than seven days after the `start` date.
‑GroupID	IntPipeline input: False Your group's ID.
‑IncludeDetails	SwitchPipeline input: False Retrieve detailed metrics. If absent, this operation returns only the `timestamp`, `streamId`, `successAttemptResponseCount`, and `failAttemptResponseCount` values.
‑Section	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
‑Start	StringPipeline input: False Specifies the beginning of the time range for the metrics in ISO 8601 format. Set this no more than seven days before the `end` date.
‑StreamID	StringPipeline input: False Your stream's ID.

Related Links

Updated 2 months ago