Huawei Cloud OBS
Collect Huawei Cloud OBS metrics data
Configuration¶
Install Func¶
It is recommended to activate the Guance integration - extension - DataFlux Func (Automata): all prerequisites are automatically installed, please continue with the script installation
If you want to deploy Func yourself, refer to Deploy Func yourself
Install Script¶
Note: Please prepare the Huawei Cloud AK that meets the requirements in advance (for simplicity, you can directly grant the global read-only permission
Tenant Guest)
Managed Version Activation Script¶
- Log in to the Guance console
- Click the 【Integration】 menu, select 【Cloud Account Management】
- Click 【Add Cloud Account】, select 【Huawei Cloud】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
- Click 【Test】, and click 【Save】 after the test is successful. If the test fails, please check whether the relevant configuration information is correct and test again
- Click 【Cloud Account Management】 to see the added cloud account in the list, click the corresponding cloud account to enter the details page
- Click the 【Integration】 button on the cloud account details page, find
Huawei Cloud OBSunder theNot Installedlist, and click the 【Install】 button to pop up the installation interface for installation.
Manual Activation Script¶
-
Log in to the Func console, click 【Script Market】, enter the Guance script market, search for
integration_huaweicloud_obs -
Click 【Install】, then enter the corresponding parameters: Huawei Cloud AK, SK, and account name
-
Click 【Deploy Startup Script】, the system will automatically create the
Startupscript set and automatically configure the corresponding startup script -
After enabling, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to execute it immediately without waiting for the scheduled time. After a while, you can check the execution task record and corresponding logs
Verification¶
- In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task record and logs to check for any exceptions
- In Guance, check whether there is asset information in 「Infrastructure - Resource Catalog」
- In Guance, check whether there is corresponding monitoring data in 「Metrics」
Metrics¶
Collect Huawei Cloud OBS metrics data, you can collect more metrics through configuration Huawei Cloud OBS Metrics Details
| Metric ID | Metric Name | Metric Description | Value Range | Measurement Object | Monitoring Cycle (Original Metric) |
|---|---|---|---|---|---|
get_request_count |
GET Request Count | This metric is used to count the number of GET requests for all buckets and objects in the bucket. Unit: counts | ≥ 0 counts | Bucket | 1 minute |
put_request_count |
PUT Request Count | This metric is used to count the number of PUT requests for all buckets and objects in the bucket. Unit: counts | ≥ 0 counts | Bucket | 1 minute |
first_byte_latency |
GET Request First Byte Average Latency | This metric is used to count the average time taken from the system receiving a complete GET request to starting to return a response within a statistical period. Unit: ms | ≥ 0 ms | Bucket | 1 minute |
request_count_4xx |
4xx Status Code Count | This metric is used to count the number of requests with a server response status code of 4xx. Unit: counts | ≥ 0 counts | User Bucket Interface | 1 minute |
request_count_5xx |
5xx Status Code Count | This metric is used to count the number of requests with a server response status code of 5xx. Unit: counts | ≥ 0 counts | User Bucket Interface | 1 minute |
total_request_latency |
Total Request Average Latency | This metric is used to count the average time taken from the system receiving a complete request to ending the return of a response for all operations on all buckets within a statistical period. Unit: ms | ≥ 0 ms | User Bucket Interface | 1 minute |
request_count_per_second |
Total TPS | The average number of requests per second within the current statistical period. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
request_count_get_per_second |
GET Request TPS | The average number of GET requests per second within the current statistical period. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
request_count_put_per_second |
PUT Request TPS | The average number of PUT requests per second within the current statistical period. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
request_count_delete_per_second |
DELETE Request TPS | The average number of DELETE requests per second within the current statistical period. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
request_success_rate |
Request Success Rate | This metric is used to measure the availability of the storage service system. The percentage of non-server error requests (returning status code 5xx) to total requests, calculated as: (1-5XX count/total request count)*100% Unit: % | ≥ 0,≤100 | User Bucket Interface Domain | 1 minute |
effective_request_rate |
Effective Request Rate | This metric is used to measure the effectiveness of client requests. The percentage of effective requests to total requests, calculated as: (client returning 2XX, 3XX count/total request count)*100% Unit: % | ≥ 0,≤100 | User Bucket Interface | 1 minute |
request_break_rate |
Request Break Rate | This metric is used to measure the failure rate caused by client interruption of requests, calculated as: (client interruption request count/total request count)*100% Unit: % | ≥ 0,≤100 | User Bucket Interface | 1 minute |
request_code_count |
HTTP Status Code Count | This metric is used to count the number of requests with a server response status code. Server response status codes see HTTP Status Codes. Unit: counts | ≥ 0 counts | Bucket Interface HTTP Status Code | 1 minute |
api_request_count_per_second |
Interface Request TPS | This metric is used to count the average number of requests per second for specific interfaces of all buckets and objects in the bucket for the current tenant within a statistical period. Supported interface types see Request Interfaces. | ≥ 0 counts | Bucket Interface | 1 minute |
request_count_monitor_2XX |
2xx Status Code Count | This metric is used to count the number of requests with a server response status code of 2xx. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
request_count_monitor_3XX |
3xx Status Code Count | This metric is used to count the number of requests with a server response status code of 3xx. Unit: counts | ≥ 0 counts | User Bucket Domain | 1 minute |
download_bytes |
Total Download Bandwidth | This metric is used to count the average total size of downloaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
download_bytes_extranet |
Extranet Download Bandwidth | This metric is used to count the average total size of extranet downloaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
download_bytes_intranet |
Intranet Download Bandwidth | This metric is used to count the average total size of intranet downloaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
upload_bytes |
Total Upload Bandwidth | This metric is used to count the average total size of uploaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
upload_bytes_extranet |
Extranet Upload Bandwidth | This metric is used to count the average total size of extranet uploaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
upload_bytes_intranet |
Intranet Upload Bandwidth | This metric is used to count the average total size of intranet uploaded objects per second within a statistical period. Unit: byte/s | ≥ 0 byte/s | User Bucket Domain | 1 minute |
cdn_bytes |
CDN Back-to-Origin Bandwidth | This metric is used to count the average size of objects requested by CDN back-to-origin per second within a statistical period, currently only counting public network outbound. Unit: byte/s | ≥ 0 byte/s | User Bucket | 1 minute |
download_traffic |
Total Download Traffic | This metric is used to count the total size of downloaded objects within a statistical period. Unit: bytes | ≥ 0 byte/s | User Bucket Domain | 1 minute |
download_traffic_extranet |
Extranet Download Traffic | This metric is used to count the total size of extranet downloaded objects within a statistical period. Unit: bytes | ≥ 0 bytes | User Bucket Domain | 1 minute |
download_traffic_intranet |
Intranet Download Traffic | This metric is used to count the total size of intranet downloaded objects within a statistical period. Unit: bytes | ≥ 0 bytes | User Bucket Domain | 1 minute |
upload_traffic |
Total Upload Traffic | This metric is used to count the total size of uploaded objects within a statistical period. Unit: bytes | ≥ 0 bytes | User Bucket Domain | 1 minute |
upload_traffic_extranet |
Extranet Upload Traffic | This metric is used to count the total size of extranet uploaded objects within a statistical period. Unit: bytes | ≥ 0 bytes | User Bucket Domain | 1 minute |
upload_traffic_intranet |
Intranet Upload Traffic | This metric is used to count the total size of intranet uploaded objects within a statistical period. Unit: bytes | ≥ 0 bytes | User Bucket Domain | 1 minute |
cdn_traffic |
CDN Back-to-Origin Traffic | This metric is used to count the total traffic of CDN back-to-origin requests within a statistical period, currently only counting public network outbound. Unit: bytes | ≥ 0 bytes | User Bucket | 1 minute |
capacity_total |
Total Storage Usage | This metric is used to count the storage space capacity occupied by all data. Unit: bytes | ≥ 0 bytes | User Bucket | 30 minutes |
capacity_standard |
Standard Storage Usage | This metric is used to count the storage space capacity occupied by standard storage data. Unit: bytes | ≥ 0 bytes | User Bucket | 30 minutes |
capacity_infrequent_access |
Infrequent Access Storage Usage | This metric is used to count the storage space capacity occupied by infrequent access storage data. Unit: bytes | ≥ 0 bytes | User Bucket | 30 minutes |
capacity_archive |
Archive Storage Usage | This metric is used to count the storage space capacity occupied by archive storage data. Unit: bytes | ≥ 0 bytes | User Bucket | 30 minutes |
capacity_deep_archive |
Deep Archive Storage Usage | This metric is used to count the storage space capacity occupied by deep archive storage data. Unit: bytes | ≥ 0 bytes | User Bucket | 30 minutes |
object_num_all |
Total Storage Object Count | This metric is used to count the total number of objects of all types of storage, the number of objects is the sum of folders in the bucket, current version files, and historical version files. Unit: counts | ≥ 0 counts | User Bucket | 30 minutes |
object_num_standard_total |
Total Standard Storage Object Count | This metric is used to count the total number of objects stored in standard storage, the number of objects is the sum of folders in the bucket, current version files, and historical version files. Unit: counts | ≥ 0 counts | User Bucket | 30 minutes |
object_num_infrequent_access_total |
Total Infrequent Access Storage Object Count | This metric is used to count the total number of objects stored in infrequent access storage, the number of objects is the sum of folders in the bucket, current version files, and historical version files. Unit: counts | ≥ 0 counts | User Bucket | 30 minutes |
object_num_archive_total |
Total Archive Storage Object Count | This metric is used to count the total number of objects stored in archive storage, the number of objects is the sum of folders in the bucket, current version files, and historical version files. Unit: counts | ≥ 0 counts | User Bucket | 30 minutes |
object_num_deep_archive_total |
Total Deep Archive Storage Object Count | This metric is used to count the total number of objects stored in deep archive storage, the number of objects is the sum of folders in the bucket, current version files, and historical version files. Unit: counts | ≥ 0 counts | User Bucket | 30 minutes |
Objects¶
The collected Huawei Cloud OBS object data structure can be seen in 「Infrastructure - Resource Catalog」
{
"measurement": "huaweicloud_obs",
"tags": {
"name" : "test0-6153",
"RegionId" : "cn-north-4",
"bucket_type": "OBJECT",
"location" : "cn-north-4"
},
"fields": {
"create_date": "2022/06/16 10:51:16",
"message" : "{Instance JSON Data}"
}
}
Some parameter descriptions are as follows
bucket_type (bucket type) value meanings
| Value | Description |
|---|---|
OBJECT |
Object Storage Bucket |
POSIX |
Parallel File System |
Note: The fields in
tags,fieldsmay change with subsequent updatesNote 1: The value of
tags.nameis the bucket name, used as a unique identifier ```