BADoS Virtual Servers Health¶

Overview¶

Module Name in API¶

bigip-bados-vip-health

Product Name in API¶

local-traffic

Dimensions¶

Dimension	Name in API	Description
Virtual Server	virtual
DOS Profile	dos-profile-name	Name of the DoS profile used in the BIG-IP
Hostname + dos Profile	hostname-profile
Service Scaling Group	ssg	The name of the Service Scaling Group
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
Application Service	applicationService
BIG-IP Blade	hostname-slot	This is a combination of a BIG-IP hostname and its blade number
BADOS Protected Virtual Server Unique Identifier	bados-virtual-identifier	Virtual server full name connected to a device name, assigned DOS profile and cluster name, if one exists
Virtual Server Unique Name	unique-virtual-name	Virtual server full name connected to a device or cluster name
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
Application	applications

MetricSets¶

Server Stress Level¶

Description¶

This is the BADoS view of how stressed the service is, values less than 100 reflect normal activity

Name In API¶

bados-stress-level

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Server Stress Level	avg-value-per-event		The average server stress level as detected by BADoS

Transactions Queue Size¶

Description¶

Number of transactions that sent through the BIG-IP to the server, but no response was yet for them

Name In API¶

transactions-queue

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Transactions Queue Size	avg-value-per-event	trans	The average number of transactions pending in queue to be served by the server

Examples¶

By Time Query¶

A query by time returns a series of data points in time, based on optional filters, time range, and time granularity. This query kind is identified by the keyword: “ap:query:stats:byTime”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query

This example for JSON body in the post, filters by dimension virtual and get the avg-value-per-event of bados-stress-level

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-bados-vip-health",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "bados-stress-level$avg-value-per-event": {
                    "metricSet": "bados-stress-level",
                    "metric": "avg-value-per-event"
            }
    },
    "dimensionFilter": {
            "type": "eq",
            "dimension": "virtual",
            "value": "value to filter by"
    }
}

By Entities Query¶

A query by entities returns a sort set of entities, based on optional filters, time range, and choosen metric to sort by. This query kind is identified by the keyword: “ap:query:stats:byEntities”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query

This example for JSON body in the post, gets top entities of type virtual, sorted by avg-value-per-event of bados-stress-level

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-bados-vip-health",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "virtual",
    "sortMetric": "bados-stress-level$avg-value-per-event",
    "sortOrder": "desc",
    "aggregations": {
            "bados-stress-level$avg-value-per-event": {
                    "metricSet": "bados-stress-level",
                    "metric": "avg-value-per-event"
            }
    },
    "limit": 5
}

Entities Count Query¶

An entities count query returns the distinct count of entities, based on optional filters, time range, and choosen entity type. This query kind is identified by the keyword: “ap:query:stats:entitiesCount”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/local-traffic/metric-query

This example for JSON body in the post, gets the distinct count of entities of type virtual

{
    "kind": "ap:query:stats:entitiesCount",
    "module": "bigip-bados-vip-health",
    "dimension": "virtual",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}

Previous Next