Virtual Servers¶

Overview¶

Summary information of Virtual Servers network activity

Module Name in API¶

bigip-virtual-stat

Product Name in API¶

local-traffic

Dimensions¶

Dimension	Name in API	Description
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
Virtual Server	virtual
Application Service	applicationService
Service Scaling Group	ssg	The name of the Service Scaling Group
Service	service
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
Application	applications

MetricSets¶

Packets In From Client¶

Description¶

Name In API¶

client-packets-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Packets In From Client	sum	packets	Total number of packets that were received from client
Avg Packets In From Client	avg-value-per-sec	pps	Average number of packets that were received from client

Packets Out To Server¶

Description¶

Name In API¶

server-packets-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Packets Out To Server	sum	packets	Total number of packets that were transmitted to server
Avg Packets Out To Server	avg-value-per-sec	pps	Average number of packets that were transmitted to server

Bytes In From Client¶

Description¶

Name In API¶

client-bytes-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Bytes In From Client	sum	bytes	Total number of bytes that were received from client
Avg Bytes In From Client	avg-value-per-sec	Bps	Average number of bytes that were received from client

New Connections¶

Description¶

Name In API¶

server-connections

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Server Side New Connections	sum	conns	Total number of new connections opened at server side
Avg Server Side New Connections	avg-value-per-sec	conns/s	Average rate of new connections opened at server side

Packets In From Server¶

Description¶

Name In API¶

server-packets-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Packets In From Server	sum	packets	Total number of packets that were received from server
Avg Packets In From Server	avg-value-per-sec	pps	Average number of packets that were received from server

HTTP Txns¶

Description¶

Number of transactions

Name In API¶

transactions

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Transaction Count	count	trans	Total number of transactions that passed through the system
Average Transactions	avg-count-per-sec	trans/s	Average number of transactions that passed through the system per second

Bytes Out To Server¶

Description¶

Name In API¶

server-bytes-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Bytes Out To Server	sum	bytes	Total number of bytes that were transmitted to server
Avg Bytes Out To Server	avg-value-per-sec	Bps	Average number of bytes that were transmitted to server

Packets Out To Client¶

Description¶

Name In API¶

client-packets-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Packets Out To Client	sum	packets	Total number of packets that were transmitted to client
Avg Packets Out To Client	avg-value-per-sec	pps	Average number of packets that were transmitted to client

Bytes In From Server¶

Description¶

Name In API¶

server-bytes-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Bytes In From Server	sum	bytes	Total number of bytes that were received from server
Avg Bytes In From Server	avg-value-per-sec	Bps	Average number of bytes that were received from server

Server Side Concurrent Connections¶

Description¶

Name In API¶

server-concurrent-connections

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Avg Server Side Concurrent Connections	avg-value-per-sec	conns	Average number of concurrent connections at server side

Bytes Out To Client¶

Description¶

Name In API¶

client-bytes-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Bytes Out To Client	sum	bytes	Total number of bytes that were transmitted to client
Avg Bytes Out To Client	avg-value-per-sec	Bps	Average number of bytes that were transmitted to client

Client Side New Connections¶

Description¶

Name In API¶

client-connections

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Client Side New Connections	sum	conns	Total number of new connections opened at client side
Avg Client Side New Connections	avg-value-per-sec	conns/s	Average rate of new connections opened at client side

Client Side Concurrent Connections¶

Description¶

Name In API¶

client-concurrent-connections

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Avg Client Side Concurrent Connections	avg-value-per-sec	conns	Average number of concurrent connections at client side

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 hostname and get the sum of client-packets-in

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-virtual-stat",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "client-packets-in$sum": {
                    "metricSet": "client-packets-in",
                    "metric": "sum"
            }
    },
    "dimensionFilter": {
            "type": "eq",
            "dimension": "hostname",
            "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 hostname, sorted by sum of client-packets-in

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-virtual-stat",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "hostname",
    "sortMetric": "client-packets-in$sum",
    "sortOrder": "desc",
    "aggregations": {
            "client-packets-in$sum": {
                    "metricSet": "client-packets-in",
                    "metric": "sum"
            }
    },
    "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 hostname

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

Previous Next