SSLO¶

Overview¶

Module Name in API¶

bigip-sslo

Product Name in API¶

local-traffic

Dimensions¶

Dimension	Name in API	Description
Virtual Server	virtual
BIG-IP Blade Number	slot-id	Used for BIG-IP Chassis with multiple blades. A value of 0 means this is a non chassis BIG-IP, any other value tells the serial number of the blade in the chassis
IP Reputation	ip-reputation	The reputation of the client IP
Topology	topology	SSLO Topology Name
Serving Application IP	serving-application-ip
Serving Application	serving-application-name
Serving Application Family	serving-application-family
Service Path	service-path
Client Cipher Name	client-cipher-name
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
URL Category	url-category
Application Service	applicationService
Server Cipher Version	server-cipher-version
Decryption Status	decryption-status
Destination Country	destination-country
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
Server Cipher Name	server-cipher-name
Client Cipher Version	client-cipher-version
Traffic Type	traffic-type
Application	applications
Action	security-action	The action a security module took with this transaction/packet, such as allow or block

MetricSets¶

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

Connection Duration¶

Description¶

Duration of TCP connections from the moment they are established until they are closed, this value is rough estimation and should not be treated as exact duration

Name In API¶

connections-duration

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Connections Duration	avg-value-per-event	ms	Average duration of TCP connections from the moment they are established until they are closed, this value is rough estimation and should not be treated as exact duration

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

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

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

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

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 sum of client-bytes-out

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-sslo",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "client-bytes-out$sum": {
                    "metricSet": "client-bytes-out",
                    "metric": "sum"
            }
    },
    "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 sum of client-bytes-out

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

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

Previous Next