Alibaba Cloud OSS¶

Alibaba Cloud OSS metrics display, including number of requests, availability, network traffic, request ratio, etc.

Configuration¶

Install Func¶

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

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

Enable Script¶

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

Hosted Edition Enable Script¶

Log in to Guance console
Click on the 【Integration】 menu and select 【Cloud Account Management】
Click 【Add Cloud Account】, choose 【Alibaba Cloud】, and fill in the required information on the interface. If cloud account information has been configured before, skip this step.
Click 【Test】, if the test is successful, click 【Save】. If the test fails, check whether the relevant configuration information is correct and retest.
In the 【Cloud Account Management】 list, you can see the added cloud account, click the corresponding cloud account to enter the details page.
Click the 【Integration】 button on the cloud account details page. Under the Not Installed list, find Alibaba Cloud OSS, click the 【Install】 button, and install it from the pop-up installation interface.

Manual Enable Script¶

Log in to the Func console, click 【Script Market】, enter the official script market, and search for guance_aliyun_oss
After clicking 【Install】, input the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.
Click 【Deploy Start Script】, the system will automatically create a Startup script set and automatically configure the corresponding start script.
After enabling, you can see the corresponding automatic trigger configuration under 「Management / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. Wait a moment, you can view the execution task records and corresponding logs.

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

Configure Custom Cloud Object Metrics

Verification¶

In 「Management / Automatic Trigger Configuration」, confirm whether the corresponding tasks have the corresponding automatic trigger configuration, and you can also view the corresponding task records and logs to check for any anomalies.
In Guance, 「Infrastructure / Custom」, check if there is asset information.
In Guance, 「Metrics」, check if there are corresponding monitoring data.

Metrics¶

After configuring Alibaba Cloud-OSS, the default metric sets are as follows. You can collect more metrics through configuration. Alibaba Cloud Cloud Monitoring Metric Details

Metric Id	Metric Name	Dimensions	Statistics	Unit
AppendObjectCount	AppendObject successful requests	userId,BucketName	Value	Count
AuthorizationErrorCount	Client authorization error request total	userId,BucketName	Value	Count
AuthorizationErrorRate	Client authorization error request ratio	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	userId,BucketName	Value	Count
ClientOtherErrorRate	Client other error request ratio	userId,BucketName	Value	%
ClientTimeoutErrorRate	Client timeout error request ratio	userId,BucketName	Value	%
CopyObjectCount	CopyObject successful requests	userId,BucketName	Value	Count
GetObjectCount	GetObject successful requests	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 requests	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 delay	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 ratio	userId,BucketName	Value	%
PostObjectCount	PostObject successful requests	userId,BucketName	Value	Count
RedirectRate	Redirect request ratio	userId,BucketName	Value	%
RequestValidRate	Valid request rate	userId,BucketName	Value	%
ResourceNotFoundErrorCount	Client resource not found error request total	userId,BucketName	Value	Count
ResourceNotFoundErrorRate	Client resource not found error request ratio	userId,BucketName	Value	%
ServerErrorRate	Server error request ratio	userId,BucketName	Value	%
SuccessCount	Successful request total	userId,BucketName	Value	Count
SuccessRate	Successful request ratio	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 requests	userId,BucketName	Value	Count
UploadPartCopyCount	UploadPartCopy successful requests	userId,BucketName	Value	Count

Objects¶

The collected Alibaba Cloud OSS object data structure can be viewed in 「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}"
  }
}