The monitoring service of Object Storage Service (OSS) provides metrics such as the running status, performance, and metering of the system. These metrics help you track requests, analyze usage, collect statistics for business trends, and discover and diagnose system issues at your earliest opportunity. This topic describes the parameters used to query OSS monitoring data by using the API or SDKs provided by Cloud Monitor.

Note For more information about Cloud Monitor SDK examples, see CloudMonitor SDK for Java.

Space

Space is used to specify the cloud services to be monitored. The namespace used by the monitoring service of OSS is acs_oss_dashboard.

The following SDK for Java provides an example on how to specify the monitoring service of OSS:
DescribeMetricListRequest request = new DescribeMetricListRequest();
request.setNamespace("acs_oss_dashboard");

StartTime and EndTime

StartTime and EndTime specify the time range to query monitoring data. The value range of time parameters in Cloud Monitor uses a left-open and right-closed interval in the (StartTime, EndTime]format. You can query data based on the range from StartTime to EndTime (including the EndTime value). The interval between start time and end time cannot exceed 31 days. Only data generated within the last 31 days can be queried.

The following SDK for Java provides an example on how to query monitoring data based the specified time range:
// Specify the end time based on which to query monitoring data. 
request.setEndTime("2019-05-13 11:06:27");
// Specify the start time based on which to query monitoring data. 
request.setStartTime("2019-05-13 10:20:27");

Dimensions

Dimensions specifies the name of the bucket you want to query. If you do not specify Dimensions, data at the user level is queried. For more information about levels, see Metric.

The following SDK for Java provides an example on how to query bucket-level data:
// Specify the name of the bucket you want to query. 
request.setDimensions("{\"BucketName\":\"<yourBucketName>\"}");

Period

Period specifies the period during which to query metrics. The period for metering metrics of the OSS monitoring service is 3,600s. The period for other metrics is 60s. For more information about the metrics, see Metric.

The following SDK for Java provides an example on how to monitor a specified non-metering metric:
request.setPeriod("60");

Metric

Metric is used to specify the metric you want to query. The following Java SDK code provides an example on how to specify the metric you want to query:

// Set the name of the metric. 
request.setMetric("<MetricName>");

Metrics include non-metering metrics and metering metrics.

  • Non-metering metrics
    Level Metric Metric name Unit
    User level UserAvailability Availability %
    UserRequestValidRate Valid request rate %
    UserTotalRequestCount Total number of requests Count
    UserValidRequestCount Number of valid requests Count
    UserInternetSend Internet outbound traffic Byte
    UserInternetRecv Internet inbound traffic Byte
    UserIntranetSend Internal network outbound traffic Byte
    UserIntranetRecv Internal network inbound traffic Byte
    UserCdnSend CDN outbound traffic Byte
    UserCdnRecv CDN inbound traffic Byte
    UserSyncSend Cross-region replication (CRR) outbound traffic Byte
    UserSyncRecv CRR inbound traffic Byte
    UserServerErrorCount Number of server-side error requests Count
    UserServerErrorRate Server-side error request rate %
    UserNetworkErrorCount Number of network-side error requests Count
    UserNetworkErrorRate Network-side error request rate %
    UserAuthorizationErrorCount Number of client-side authorization error requests Count
    UserAuthorizationErrorRate Client-side authorization error request rate %
    UserResourceNotFoundErrorCount Number of client-side error requests that indicate resources not found Count
    UserResourceNotFoundErrorRate Rate of client-side error requests that indicate resources not found %
    UserClientTimeoutErrorCount Number of client-side timeout error requests Count
    UserClientOtherErrorRate Client-side timeout error request rate %
    UserClientOtherErrorCount Number of other client-side error requests Count
    UserClientOtherErrorRate Rate of other client-side error requests %
    UserSuccessCount Number of successful requests Count
    UserSuccessRate Successful request rate %
    UserRedirectCount Number of redirect requests Count
    UserRedirectRate Redirect request rate %
    Bucket level Availability Availability %
    RequestValidRate Valid request rate %
    TotalRequestCount Total number of requests Count
    ValidRequestCount Number of valid requests Count
    InternetSend Internet outbound traffic Byte
    InternetRecv Internet inbound traffic Byte
    IntranetSend Internal network outbound traffic Byte
    IntranetRecv Internal network inbound traffic Byte
    InternetSendBandwidth Outbound bandwidth over Internet bps
    InternetRecvBandwidth Inbound bandwidth over Internet bps
    IntranetSendBandwidth Outbound bandwidth over the internal network bps
    IntranetRecvBandwidth Inbound bandwidth over the internal network bps
    CdnSend CDN outbound traffic Byte
    CdnRecv CDN inbound traffic Byte
    SyncSend Cross-region replication (CRR) outbound traffic Byte
    SyncRecv CRR inbound traffic Byte
    ServerErrorCount Number of server-side error requests Count
    ServerErrorRate Server-side error request rate %
    NetworkErrorCount Number of network-side error requests Count
    NetworkErrorRate Network-side error request rate %
    AuthorizationErrorCount Number of client-side authorization error requests Count
    AuthorizationErrorRate Client-side authorization error request rate %
    ResourceNotFoundErrorCount Number of client-side error requests that indicate resources not found Count
    ResourceNotFoundErrorRate Rate of client-side error requests that indicate resources not found %
    ClientTimeoutErrorCount Number of client-side timeout error requests Count
    ClientTimeoutErrorRate Client-side timeout error request rate %
    ClientOtherErrorCount Number of other client-side error requests Count
    ClientOtherErrorRate Rate of other client-side error requests %
    SuccessCount Number of successful requests Count
    SuccessRate Successful request rate %
    RedirectCount Number of redirect requests Count
    RedirectRate Redirect request rate %
    GetObjectE2eLatency Average end-to-end latency of GetObject requests Millisecond
    GetObjectServerLatency Average server latency of GetObject requests Millisecond
    MaxGetObjectE2eLatency Maximum end-to-end latency of GetObject requests Millisecond
    MaxGetObjectServerLatency Maximum server latency of GetObject requests Millisecond
    HeadObjectE2eLatency Average end-to-end latency of HeadObject requests Millisecond
    HeadObjectServerLatency Average server latency of HeadObject requests Millisecond
    MaxHeadObjectE2eLatency Maximum end-to-end latency of HeadObject requests Millisecond
    MaxHeadObjectServerLatency Maximum server latency of HeadObject requests Millisecond
    PutObjectE2eLatency Average end-to-end latency of PutObject requests Millisecond
    PutObjectServerLatency Average server latency of PutObject requests Millisecond
    MaxPutObjectE2eLatency Maximum end-to-end latency of PutObject requests Millisecond
    MaxPutObjectServerLatency Maximum server latency of PutObject requests Millisecond
    PostObjectE2eLatency Average end-to-end latency of PostObject requests Millisecond
    PostObjectServerLatency Average server latency of PostObject requests Millisecond
    MaxPostObjectE2eLatency Maximum end-to-end latency of PostObject requests Millisecond
    MaxPostObjectServerLatency Maximum server latency of PostObject requests Millisecond
    AppendObjectE2eLatency Average end-to-end latency of AppendObject requests Millisecond
    AppendObjectServerLatency Average server latency of AppendObject requests Millisecond
    MaxAppendObjectE2eLatency Maximum end-to-end latency of AppendObject requests Millisecond
    MaxAppendObjectServerLatency Maximum server latency of AppendObject requests Millisecond
    UploadPartE2eLatency Average end-to-end latency of UploadPart requests Millisecond
    UploadPartServerLatency Average server latency of UploadPart requests Millisecond
    MaxUploadPartE2eLatency Maximum end-to-end latency of UploadPart requests Millisecond
    MaxUploadPartServerLatency Maximum server latency of UploadPart requests Millisecond
    UploadPartCopyE2eLatency Average end-to-end latency of UploadPartCopy requests Millisecond
    UploadPartCopyServerLatency Average server latency of UploadPartCopy requests Millisecond
    MaxUploadPartCopyE2eLatency Maximum end-to-end latency of UploadPartCopy requests Millisecond
    MaxUploadPartCopyServerLatency Maximum server latency of UploadPartCopy requests Millisecond
    GetObjectCount Number of successful GetObject requests Count
    HeadObjectCount Number of successful HeadObject requests Count
    PutObjectCount Number of successful PutObject Requests Count
    PostObjectCount Number of successful PostObject requests Count
    AppendObjectCount Number of successful AppendObject requests Count
    UploadPartCount Number of successful UploadPart requests Count
    UploadPartCopyCount Number of successful UploadPartCopy requests Count
    DeleteObjectCount Number of successful DeleteObject requests Count
    DeleteObjectsCount Number of successful DeleteObjects requests Count
  • Metering metrics

    If you specify Dimensions when you query the following metrics, data at the bucket level is queried. If you do not specify Dimensions, data at the user level is queried.

    Metric Metric name Unit
    MeteringStorageUtilization Storage size Byte
    MeteringGetRequest Number of GET requests Count
    MeteringPutRequest Number of PUT requests Count
    MeteringInternetTX Metered Internet outbound traffic Byte
    MeteringCdnTX Metered CDN outbound traffic Byte
    MeteringSyncRX Metered CRR inbound traffic Byte