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.
Set the -Start
and -End
dates to get metrics from a specific time range.
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. Account Switch Keys can be found using Get-AccountSwitchKey
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupID
Unique identifier for each group.
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Retrieve detailed metrics. If absent, this operation returns only the timestamp
, streamId
, successAttemptResponseCount
, and failAttemptResponseCount
values.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StreamID
Uniquely identifies the stream.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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