proposalbot 392c14c1f9 Changes to wafd_umn from docs/doc-exports#694 (WAF Dedicated UMN 20230329 versio
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2023-04-20 07:55:56 +00:00

24 KiB

original_name

waf_01_1372.html

Monitored Metrics

Introduction

This topic describes metrics reported by dedicated WAF to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of the monitored object and alarms generated for dedicated WAF. You can also query them on the Cloud Eye console.

namespaces

SYS.WAF

Note

A namespace is an abstract collection of resources and objects. Multiple namespaces can be created in a single cluster with the data isolated from each other. This enables namespaces to share the same cluster services without affecting each other.

Metrics for Dedicated WAF Instances

Table 1 Metrics for dedicated waf instances
Metric ID Metric Name Description Value Range Monitored Object Monitoring Interval (Raw Data)
cpu_util CPU Usage

CPU usage of the monitored object

Unit: percentage (%)

Collection method: 100% minus idle CPU usage percentage

0% to 100%

Value type: Float

Dedicated WAF instances 1 minute
mem_util Memory Usage

Memory usage of the monitored object

Unit: percentage (%)

Collection method: 100% minus idle memory percentage

0% to 100%

Value type: Float

Dedicated WAF instances 1 minute
disk_util Disk Usage

Disk usage of the monitored object

Unit: percentage (%)

Collection method: 100% minus idle disk space percentage

0% to 100%

Value type: Float

Dedicated WAF instances 1 minute
disk_avail_size Available Disk Space

Available disk space of the monitored object

Unit: byte, KB, MB, GB, TB or PB

Collection mode: size of free disk space

>= 0 bytes

Value type: Float

Dedicated WAF instances 1 minute
disk_read_bytes_rate Disk Read Rate

Number of bytes the monitored object reads from the disk per second

Unit: byte/s, KB/s, MB/s, or GB/s

Collection mode: number of bytes read from the disk per second

>= 0 byte/s

Value type: Float

Dedicated WAF instances 1 minute
disk_write_bytes_rate Disk Write Rate

Number of bytes the monitored object writes into the disk per second

Unit: byte/s, KB/s, MB/s, or GB/s

Collection mode: number of bytes written into the disk per second

>= 0 byte/s

Value type: Float

Dedicated WAF instances 1 minute
disk_read_requests_rate Disk Read Requests

Number of requests the monitored object reads from the disk per second

Unit: Requests/s

Collection mode: number of read requests processed by the disk per second

>= 0 request/s

Value type: Float

Dedicated WAF instances 1 minute
disk_write_requests_rate Disk Write Requests

Number of requests the monitored object writes into the disk per second

Unit: Requests/s

Collection method: Number of write requests processed by the disk per second

>= 0 request/s

Value type: Float

Dedicated WAF instances 1 minute
network_incoming_bytes_rate Incoming Traffic

Incoming traffic per second on the monitored object

Unit:

byte/s, KB/s, MB/s, or GB/s

Collection method: Incoming traffic over the NIC per second

>= 0 byte/s

Value type: Float

Dedicated WAF instances 1 minute
network_outgoing_bytes_rate Outgoing Traffic

Outgoing traffic per second on the monitored object

Unit:

byte/s, KB/s, MB/s, or GB/s

Collection method: Outgoing traffic over the NIC per second

>= 0 byte/s

Value type: Float

Dedicated WAF instances 1 minute
network_incoming_packets_rate Incoming Packet Rate

Incoming packets per second on the monitored object

Unit:

packet/s

Collection method: Incoming packets over the NIC per second

>= 0 packet/s

Value type: Int

Dedicated WAF instances 1 minute
network_outgoing_packets_rate Outgoing Packet Rate

Outgoing packets per second on the monitored object

Unit:

packet/s

Collection method: Outgoing packets over the NIC per second

>= 0 packet/s

Value type: Int

Dedicated WAF instances 1 minute
concurrent_connections Concurrent Connections

Number of concurrent connections being processed

Unit: count

Collection method: Number of concurrent connections in the system

>=0 count

Value type: Int

Dedicated WAF instances 1 minute
active_connections Active Connections

Number of active connections

Unit: count

Collection method: Number of active connections in the system

>=0 count

Value type: Int

Dedicated WAF instances 1 minute
latest_policy_sync_time Latest Rule Synchronization

Time elapsed for the WAF to synchronize the latest custom rules

Unit: ms

Collection method: Time elapsed for synchronizing to the last policies

>=0 ms

Value type: Int

Dedicated WAF instances 1 minute

Dimensions

Key Value
instance_id ID of the dedicated WAF instance
waf_instance_id ID of the website protected with WAF

Example of Raw Data Format of Monitored Metrics

[
    {
        "metric": {
             // Namespace
            "namespace": "SYS.WAF",
            "dimensions": [
                {
                    // Dimension name, for example, protected website
                    "name": "waf_instance_id",
                    // ID of the monitored object in this dimension, for example, ID of the protected website
                    "value": "082db2f542e0438aa520035b3e99cd99"
                }
            ],
           //Metric ID
            "metric_name": "waf_http_2xx"
        },
        // Time to live, which is predefined for the metric
        "ttl": 172800,
         // Metric value
        "value": 0.0,
       // Metric unit
        "unit": "Count",
         // Metric value type
        "type": "float",
        // Collection time for the metric
        "collect_time": 1637677359778
    }
]