Upload metrics
Get-DataStreamMetrics
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
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey
command to list the account switch keys available to you.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position7
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-AggregationInterval
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.
Type String
Parameter Sets (All)
Aliases
Accepted values FIVE_MINUTE, HOUR, DAY
RequiredFalse
Position4
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position5
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-End
Specifies the end of the time range for the metrics in the ISO 8601 format. Set this no more than seven days after the start
date.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position2
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-GroupID
Unique identifier for each group.
Type Int32
Parameter Sets (All)
Aliases None
RequiredFalse
Position3
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-IncludeDetails
Retrieve detailed metrics. If absent, this operation returns only the timestamp
, streamId
, successAttemptResponseCount
, and failAttemptResponseCount
values.
Type SwitchParameter
Parameter Sets (All)
Aliases None
RequiredFalse
Position Named
Default valueFalse
Accept pipeline inputFalse
Accept wildcard charactersFalse
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position6
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-Start
Specifies the beginning of the time range for the metrics in the ISO 8601 format. Set this no more than seven days before the end
date.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position1
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
-StreamID
Uniquely identifies the stream.
Type String
Parameter Sets (All)
Aliases None
RequiredFalse
Position0
Default value None
Accept pipeline inputFalse
Accept wildcard charactersFalse
CommonParameters
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable
. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Related links
Updated 25 days ago