Skip to content

Alibaba Cloud OSS

Alibaba Cloud OSS Metrics Display, including request counts, availability, network traffic, request proportions, etc.

Configuration

Install Func

It is recommended to enable Guance integration - extension - hosted Func

If you deploy Func yourself, refer to Self-deployed Func

Enable Script

Note: Please prepare an Alibaba Cloud AK that meets the requirements in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess)

Hosted Version Enable Script

  1. Log in to the Guance console
  2. Click on the 【Manage】 menu and select 【Cloud Account Management】
  3. Click 【Add Cloud Account】, choose 【Alibaba Cloud】, fill in the required information on the interface; if cloud account information has been configured before, ignore this step.
  4. Click 【Test】, after a successful test click 【Save】, if the test fails, check whether the related configuration information is correct and retest.
  5. Click on the 【Cloud Account Management】 list to see the added cloud account, click on the corresponding cloud account to enter the details page.
  6. Click the 【Integration】 button on the cloud account detail page, find Alibaba Cloud OSS under the Not Installed list, click the 【Install】 button, and install it via the installation interface that pops up.

Manual Enable Script

  1. Log in to the Func console, click 【Script Market】, go to the official script market, search for guance_aliyun_oss

  2. After clicking 【Install】, input the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

  3. Click 【Deploy Startup Script】, the system will automatically create a Startup script set and automatically configure the corresponding startup script.

  4. After enabling, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

We collect some configurations by default, see the metrics section for details.

Configure Custom Cloud Object Metrics

Verification

  1. In 「Management / Automatic Trigger Configuration」 confirm whether the corresponding task has an automatic trigger configuration, and at the same time, check the task records and logs for any anomalies.
  2. In Guance, 「Infrastructure / Custom」 check if there are any asset information entries.
  3. In Guance, 「Metrics」 check if there are corresponding monitoring data.

Metrics

After configuring Alibaba Cloud-OSS, the default metric set is as follows, more metrics can be collected through configuration Alibaba Cloud Monitoring Metric Details

Metric Id Metric Name Dimensions Statistics Unit
AppendObjectCount AppendObject Successful Request Count userId,BucketName Value Count
AuthorizationErrorCount Client Authorization Error Request Total Count userId,BucketName Value Count
AuthorizationErrorRate Client Authorization Error Request Proportion userId,BucketName Value %
Availability Availability userId,BucketName Value %
CdnRecv CDN Inbound Traffic userId,BucketName Value bytes
CdnSend CDN Outbound Traffic userId,BucketName Value bytes
ClientOtherErrorCount Client Other Error Request Total Count userId,BucketName Value Count
ClientOtherErrorRate Client Other Error Request Proportion userId,BucketName Value %
ClientTimeoutErrorRate Client Timeout Error Request Proportion userId,BucketName Value %
CopyObjectCount CopyObject Successful Request Count userId,BucketName Value Count
GetObjectCount GetObject Successful Request Count userId,BucketName Value Frequency
GetObjectE2eLatency GetObject Request Average E2E Latency userId,BucketName Value Milliseconds
GetObjectServerLatency GetObject Request Average Server Latency userId,BucketName Value Milliseconds
HeadObjectCount HeadObject Successful Request Count userId,BucketName Value Count
InternetRecv Public Network Inbound Traffic userId,BucketName Value bytes
InternetRecvBandwidth Public Network Inbound Bandwidth userId,BucketName Value bps
InternetSend Public Network Outbound Traffic userId,BucketName Value bytes
InternetSendBandwidth Public Network Outbound Bandwidth userId,BucketName Value bps
IntranetRecv Internal Network Inbound Traffic userId,BucketName Value bytes
IntranetRecvBandwidth Internal Network Inbound Bandwidth userId,BucketName Value bps
IntranetSend Internal Network Outbound Traffic userId,BucketName Value bytes
IntranetSendBandwidth Internal Network Outbound Bandwidth userId,BucketName Value bps
MaxAppendObjectE2eLatency AppendObject Request Maximum E2E Latency userId,BucketName Value Milliseconds
MaxAppendObjectServerLatency AppendObject Request Maximum Server Latency userId,BucketName Value Milliseconds
MaxCopyObjectE2eLatency CopyObject Request Maximum E2E Latency userId,BucketName Value ms
MaxCopyObjectServerLatency CopyObject Request Maximum Server Latency userId,BucketName Value ms
MaxHeadObjectE2eLatency HeadObject Request Maximum E2E Latency userId,BucketName Value Milliseconds
MaxHeadObjectServerLatency HeadObject Request Maximum Server Latency userId,BucketName Value Milliseconds
MaxPostObjectE2eLatency PostObject Request Maximum E2E Latency userId,BucketName Value Milliseconds
MaxPostObjectServerLatency PostObject Request Maximum Server Latency userId,BucketName Value Milliseconds
MaxUploadPartE2eLatency UploadPart Request Maximum E2E Latency userId,BucketName Value Milliseconds
MaxUploadPartServerLatency UploadPart Request Maximum Server Latency userId,BucketName Value Milliseconds
NetworkErrorRate Network Error Request Proportion userId,BucketName Value %
PostObjectCount PostObject Successful Request Count userId,BucketName Value Count
RedirectRate Redirect Request Proportion userId,BucketName Value %
RequestValidRate Valid Request Rate userId,BucketName Value %
ResourceNotFoundErrorCount Client Resource Not Exist Error Request Total Count userId,BucketName Value Count
ResourceNotFoundErrorRate Client Resource Not Exist Error Request Proportion userId,BucketName Value %
ServerErrorRate Server Error Request Proportion userId,BucketName Value %
SuccessCount Successful Request Total Count userId,BucketName Value Count
SuccessRate Successful Request Proportion userId,BucketName Value %
SyncRecv Cross-region Replication Inbound Traffic userId,BucketName Value bytes
SyncSend Cross-region Replication Outbound Traffic userId,BucketName Value bytes
TotalRequestCount Total Request Count userId,BucketName Value Count
UploadPartCopyCount UploadPartCopy Successful Request Count userId,BucketName Value Count

Objects

The structure of collected Alibaba Cloud OSS object data can be viewed from 「Infrastructure - Custom」

{
  "measurement": "aliyun_oss",
  "tags": {
    "name"         : "ack-backup-hangzhou",
    "RegionId"     : "oss-cn-hangzhou",
    "storage_class": "IA",
    "location"     : "oss-cn-hangzhou",
    "grant"        : "private"
  },
  "fields": {
    "extranet_endpoint": "oss-cn-hangzhou.aliyuncs.com",
    "intranet_endpoint": "oss-cn-hangzhou-internal.aliyuncs.com",
    "creation_date"    : 1638415082,
    "message"          : "{JSON instance data}"
  }
}

Feedback

Is this page helpful? ×