CloudMonitor provides various metrics to monitor the system status, performance, and metering of Object Storage Service (OSS). You can use monitoring metrics to track requests, analyze usage, collect statistics about business trends, and identify and resolve system issues at the earliest opportunity. This topic describes how to query OSS monitoring data by using the CloudMonitor API or SDK.
For CloudMonitor SDK sample code, see SDK reference.
Space
The Space parameter specifies the cloud service that you want to monitor. The namespace that CloudMonitor uses to monitor OSS is acs_oss_dashboard.
The following sample code provides an example on how to configure CloudMonitor to monitor OSS by using CloudMonitor SDK for Java:
DescribeMetricListRequest request = new DescribeMetricListRequest();
request.setNamespace("acs_oss_dashboard");StartTime and EndTime
The StartTime and EndTime parameters specify the time range to query monitoring data. CloudMonitor uses the left-open and right-closed (StartTime, EndTime] interval to specify a time range for data query. The interval between the start time and end time cannot exceed 31 days. Only data generated in the previous 31 days can be queried.
The following sample code provides an example on how to specify a time range for data query by using CloudMonitor SDK for Java:
// Specify the end time based on which you want to query monitoring data.
request.setEndTime("2019-05-13 11:06:27");
// Specify the start time based on which you want to query monitoring data.
request.setStartTime("2019-05-13 10:20:27");Dimensions
The Dimensions parameter specifies the bucket whose monitoring data you want to query. If you do not specify Dimensions, account-level metric data of buckets is queried. For more information about metric levels, see Metric.
The following sample code provides an example on how to query the monitoring data of a specific bucket by using CloudMonitor SDK for Java.
// Specify the bucket whose monitoring data you want to query.
request.setDimensions("{\"BucketName\":\"<yourBucketName>\"}");Period
The Period parameter specifies the cycle based on which the specified metrics are queried. The cycle for the OSS metering metrics is 3,600s. The cycle for other OSS metrics is 60s. For more information about metrics, see Metric.
The following sample code provides an example on how to specify the Period parameter for querying a non-metering metric:
request.setPeriod("60");Metric
The Metric parameter specifies the metric that you want to query. Metrics include non-metering metrics and metering metrics. The following sample code provides an example on how to query a specific metric by using CloudMonitor SDK for Java:
// Specify the name of the metric.
request.setMetric("<MetricName>");You can view OSS metrics on the Metric List page.
Non-metering metrics
Non-metering metrics are metrics that do not reflect usage metering information. The following table describes non-metering metrics for OSS.
Level | Metric | Description | Unit |
User level | UserAvailability | The availability. | % |
UserRequestValidRate | The percentage of valid requests. | % | |
UserTotalRequestCount | The total number of requests. | None | |
UserValidRequestCount | The number of valid requests. | None | |
UserInternetSend | The outbound traffic over the Internet. | Bytes | |
UserInternetRecv | The inbound traffic over the Internet. | Bytes | |
UserIntranetSend | The outbound traffic over the internal network. | Bytes | |
UserIntranetRecv | The inbound traffic over the internal network. | Bytes | |
UserCdnSend | The outbound traffic from Alibaba Cloud CDN. | Bytes | |
UserCdnRecv | The inbound traffic to Alibaba Cloud CDN. | Bytes | |
UserSyncSend | The outbound traffic that is generated when you use cross-region replication (CRR) to replicate data from the source bucket to the destination bucket. | Bytes | |
UserSyncRecv | The inbound traffic that is generated when you use CRR to replicate data from the source bucket to the destination bucket. | Bytes | |
UserServerErrorCount | The total number of requests that encountered server errors. | None | |
UserServerErrorRate | The percentage of requests that encountered server errors. | % | |
UserNetworkErrorCount | The total number of requests that encountered network errors. | None | |
UserNetworkErrorRate | The percentage of requests that encountered network errors. | % | |
UserAuthorizationErrorCount | The total number of failed authorization requests from the client. | None | |
UserAuthorizationErrorRate | The percentage of failed authorization requests from the client. | % | |
UserResourceNotFoundErrorCount | The total number of failed requests from the client because the resource does not exist. | None | |
UserResourceNotFoundErrorRate | The percentage of failed requests from the client because the resource does not exist. | % | |
UserClientTimeoutErrorCount | The total number of failed requests due to client timeouts. | None | |
UserClientOtherErrorRate | The percentage of failed requests due to client timeouts. | % | |
UserClientOtherErrorCount | The total number of requests that encountered other client errors. | None | |
UserClientOtherErrorRate | The percentage of requests that encountered other client errors. | % | |
UserSuccessCount | The total number of successful requests. | None | |
UserSuccessRate | The percentage of successful requests. | % | |
UserRedirectCount | The total number of redirection requests. | None | |
UserRedirectRate | The percentage of redirection requests. | % | |
Bucket level | Availability | The availability. | % |
RequestValidRate | The percentage of valid requests. | % | |
TotalRequestCount | The total number of requests. | None | |
ValidRequestCount | The number of valid requests. | None | |
InternetSend | The outbound traffic over the Internet. | Bytes | |
InternetRecv | The inbound traffic over the Internet. | Bytes | |
IntranetSend | The outbound traffic over the internal network. | Bytes | |
IntranetRecv | The inbound traffic over the internal network. | Bytes | |
InternetSendBandwidth | The outbound bandwidth over the Internet. | bps | |
InternetRecvBandwidth | The inbound bandwidth over the Internet. | bps | |
IntranetSendBandwidth | The outbound bandwidth over the internal network. | bps | |
IntranetRecvBandwidth | The inbound bandwidth over the internal network. | bps | |
CdnSend | The outbound traffic from Alibaba Cloud CDN. | Bytes | |
CdnRecv | The inbound traffic to Alibaba Cloud CDN. | Bytes | |
SyncSend | The outbound traffic that is generated when you use CRR to replicate data from the source bucket to the destination bucket. | Bytes | |
SyncRecv | The inbound traffic that is generated when you use CRR to replicate data from the source bucket to the destination bucket. | Bytes | |
ServerErrorCount | The total number of requests that encountered server errors. | None | |
ServerErrorRate | The percentage of requests that encountered server errors. | % | |
NetworkErrorCount | The total number of requests that encountered network errors. | None | |
NetworkErrorRate | The percentage of requests that encountered network errors. | % | |
AuthorizationErrorCount | The total number of failed authorization requests from the client. | None | |
AuthorizationErrorRate | The percentage of failed authorization requests from the client. | % | |
ResourceNotFoundErrorCount | The total number of failed requests from the client because the resource does not exist. | None | |
ResourceNotFoundErrorRate | The percentage of failed requests from the client because the resource does not exist. | % | |
ClientTimeoutErrorCount | The total number of failed requests due to client timeouts. | None | |
ClientTimeoutErrorRate | The percentage of failed requests due to client timeouts. | % | |
ClientOtherErrorCount | The total number of requests that encountered other client errors. | None | |
ClientOtherErrorRate | The percentage of requests that encountered other client errors. | % | |
SuccessCount | The total number of successful requests. | None | |
SuccessRate | The percentage of successful requests. | % | |
RedirectCount | The total number of redirection requests. | None | |
RedirectRate | The percentage of redirection requests. | % | |
GetObjectE2eLatency | The average end-to-end (E2E) latency of GetObject requests. | Milliseconds | |
GetObjectServerLatency | The average server latency of GetObject requests. | Milliseconds | |
MaxGetObjectE2eLatency | The maximum E2E latency of GetObject requests. | Milliseconds | |
MaxGetObjectServerLatency | The maximum server latency of GetObject requests. | Milliseconds | |
HeadObjectE2eLatency | The average E2E latency of HeadObject requests. | Milliseconds | |
HeadObjectServerLatency | The average server latency of HeadObject requests. | Milliseconds | |
MaxHeadObjectE2eLatency | The maximum E2E latency of HeadObject requests. | Milliseconds | |
MaxHeadObjectServerLatency | The maximum server latency of HeadObject requests. | Milliseconds | |
PutObjectE2eLatency | The average E2E latency of PutObject requests. | Milliseconds | |
PutObjectServerLatency | The average server latency of PutObject requests. | Milliseconds | |
MaxPutObjectE2eLatency | The maximum E2E latency of PutObject requests. | Milliseconds | |
MaxPutObjectServerLatency | The maximum server latency of PutObject requests. | Milliseconds | |
PostObjectE2eLatency | The average E2E latency of PostObject requests. | Milliseconds | |
PostObjectServerLatency | The average server latency of PostObject requests. | Milliseconds | |
MaxPostObjectE2eLatency | The maximum E2E latency of PostObject requests. | Milliseconds | |
MaxPostObjectServerLatency | The maximum server latency of PostObject requests. | Milliseconds | |
AppendObjectE2eLatency | The average E2E latency of AppendObject requests. | Milliseconds | |
AppendObjectServerLatency | The average server latency of AppendObject requests. | Milliseconds | |
MaxAppendObjectE2eLatency | The maximum E2E latency of AppendObject requests. | Milliseconds | |
MaxAppendObjectServerLatency | The maximum server latency of AppendObject requests. | Milliseconds | |
UploadPartE2eLatency | The average E2E latency of UploadPart requests. | Milliseconds | |
UploadPartServerLatency | The average server latency of UploadPart requests. | Milliseconds | |
MaxUploadPartE2eLatency | The maximum E2E latency of UploadPart requests. | Milliseconds | |
MaxUploadPartServerLatency | The maximum server latency of UploadPart requests. | Milliseconds | |
UploadPartCopyE2eLatency | The average E2E latency of UploadPartCopy requests. | Milliseconds | |
UploadPartCopyServerLatency | The average server latency of UploadPartCopy requests. | Milliseconds | |
MaxUploadPartCopyE2eLatency | The maximum E2E latency of UploadPartCopy requests. | Milliseconds | |
MaxUploadPartCopyServerLatency | The maximum server latency of UploadPartCopy requests. | Milliseconds | |
GetObjectCount | The number of successful GetObject requests. | None | |
HeadObjectCount | The number of successful HeadObject requests. | None | |
PutObjectCount | The number of successful PutObject requests. | None | |
PostObjectCount | The number of successful PostObject requests. | None | |
AppendObjectCount | The number of successful AppendObject requests. | None | |
UploadPartCount | The number of successful UploadPart requests. | None | |
UploadPartCopyCount | The number of successful UploadPartCopy requests. | None | |
DeleteObjectCount | The number of successful DeleteObject requests. | None | |
DeleteObjectsCount | The number of successful DeleteObjects requests. | None | |
MirrorTraffic | The amount of the inbound traffic from a specific origin for legitimate requests. | Bytes | |
MirrorTrafficByStatus | The amount of the inbound traffic from a specific origin for legitimate requests with a specific HTTP status code. | Bytes | |
MirrorRequestTransferSpeed | The average data transfer speed of legitimate requests to a specific origin. | Bytes/s | |
MirrorRequestTransferSpeedByStatus | The average data transfer speed of legitimate requests to a specific origin and with a specific HTTP status code. | Bytes/s | |
MirrorRequestCount | The total number of legitimate requests to a specific origin. | None | |
MirrorRequestCountByStatus | The total number of legitimate requests to a specific origin and with a specific HTTP status code. | None | |
MirrorAverageLatency | The average latency of legitimate requests to a specific origin. | Milliseconds | |
MirrorAverageLatencyByStatus | The average latency of legitimate requests to a specific origin and with a specific HTTP status code. | Milliseconds | |
MirrorRequestStatusRatio | The percentage of requests to a specific origin and with HTTP status codes 2xx, 3xx, 4xx, and 5xx out of all requests. | % | |
MirrorRequestStatusCount | The total number of requests to a specific origin and with HTTP status codes 2xx, 3xx, 4xx, and 5xx. | None |
Metering metrics
If you specify Dimensions when you query the following metrics, data of a specified bucket is queried. If you do not specify Dimensions, account-level data of buckets is queried.
In line with the billing rules, metering metrics are collected and displayed differently from non-metering metrics. For more information, see Billable usage metrics.
Metric | Description | Unit |
MeteringStorageUtilization | The storage usage. | Bytes |
MeteringGetRequest | The number of GET requests. | None |
MeteringPutRequest | The number of PUT requests. | None |
MeteringInternetTX | The metered outbound traffic over the Internet. | Bytes |
MeteringCdnTX | The metered outbound traffic from Alibaba Cloud CDN. | Bytes |
MeteringSyncRX | The metered inbound traffic that is generated when you use CRR to replicate data from the source bucket to the destination bucket. | Bytes |