Skip to content

Huawei Cloud OBS

Collect Huawei Cloud OBS Metrics data

Configuration

Install Func

It is recommended to activate the TrueWatch Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed, please proceed with the script installation.

If you need to deploy Func manually, refer to Manual Deployment of Func

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 ReadOnlyAccess)

  1. Log in to the Func console, click 【Script Market】, enter the TrueWatch Script Market, and search for ID: integration_huaweicloud_obs

  2. Click 【Install】, then enter the corresponding parameters: Huawei Cloud AK, SK, and account name

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

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

Verification

  1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task records and logs to see if there are any exceptions
  2. In TrueWatch, 「Infrastructure - Resource Catalog」, check if there is asset information
  3. In TrueWatch, 「Metrics」, check if there is corresponding monitoring data

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: milliseconds ≥ 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 response return for all operations on all buckets within a statistical period. Unit: milliseconds ≥ 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) out of the 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 out of the total requests, calculated as: (client returns 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 request interruptions, calculated as: (client interrupted 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 server response status codes. Server response status codes can be found in HTTP Status Codes. Unit: counts ≥ 0 counts Bucket Interface HTTP Status Codes 1 minute
api_request_count_per_second API Request TPS This metric is used to count the average number of requests per second for specific APIs of all buckets and objects in the bucket for the current tenant within a statistical period. Supported API types can be found in Request APIs. ≥ 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 the statistical period. Unit: bytes/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 the statistical period. Unit: bytes/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 the statistical period. Unit: bytes/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 the statistical period. Unit: bytes/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 the statistical period. Unit: bytes/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 the statistical period. Unit: bytes/s ≥ 0 byte/s User Bucket Domain 1 minute
cdn_bytes CDN Origin Bandwidth This metric is used to count the average size of CDN origin request objects per second within the statistical period, currently only counting public network outbound. Unit: bytes/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 the 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 the 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 the 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 the 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 the 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 the statistical period. Unit: bytes ≥ 0 bytes User Bucket Domain 1 minute
cdn_traffic CDN Origin Traffic This metric is used to count the total traffic of CDN origin requests within the 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 total 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 Objects This metric is used to count the total number of objects of all storage types, where the object count is the sum of folders, current version files, and historical version files in the bucket. Unit: counts ≥ 0 counts User Bucket 30 minutes
object_num_standard_total Total Standard Storage Objects This metric is used to count the total number of objects stored in standard storage, where the object count is the sum of folders, current version files, and historical version files in the bucket. Unit: counts ≥ 0 counts User Bucket 30 minutes
object_num_infrequent_access_total Total Infrequent Access Storage Objects This metric is used to count the total number of objects stored in infrequent access storage, where the object count is the sum of folders, current version files, and historical version files in the bucket. Unit: counts ≥ 0 counts User Bucket 30 minutes
object_num_archive_total Total Archive Storage Objects This metric is used to count the total number of objects stored in archive storage, where the object count is the sum of folders, current version files, and historical version files in the bucket. Unit: counts ≥ 0 counts User Bucket 30 minutes
object_num_deep_archive_total Total Deep Archive Storage Objects This metric is used to count the total number of objects stored in deep archive storage, where the object count is the sum of folders, current version files, and historical version files in the bucket. 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, fields may change with subsequent updates

Note 1: tags.name value is the bucket name, used as a unique identifier ```