ASM Transactions

Overview

Module Name in API

bigip-asm-transactions

Product Name in API

local-traffic

Dimensions

Dimension Name in API Description
Country country Client Country
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
Client Device ID device-id  
Mobile App Version client-mobile-app-version The version of the mobile application
BIG-IP Host Name hostname The hostname given to the BIG-IP
Network Protocol protocol  
Mobile Device Indication client-is-mobile-device Tells whether the client used a mobile device or not
Application Service applicationService  
Mobile App Name client-mobile-app-name The name of the mobile application
Violation Rating asm-violation-rating Severity rating of the violations
Action security-action The action a security module took with this transaction/packet, such as allow or block
Severity severity The severity of the violations
Method method The HTTP method used in the request
Client IP client-ip  
ASM Policy Name asm-policy-name  
URL url  
User Name client-user-name  
Session ID client-session-id ID that represents the client session
Mobile App Type client-mobile-app-type The type of the mobile application
Response Code Family response-code-families The HTTP response code, categorized to 1xx, 2xx, 3xx, 4xx, 5xx
BIG-IP Service Cluster dsc-name Clusters of BIG-IPs grouped together to have the same config
Application applications  

MetricSets

Transactions

Description

Number of transactions

Name In API

transactions

Metrics in the metricSet

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

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 country and get the count of transactions

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-asm-transactions",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "transactions$count": {
                    "metricSet": "transactions",
                    "metric": "count"
            }
    },
    "dimensionFilter": {
            "type": "eq",
            "dimension": "country",
            "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 country, sorted by count of transactions

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-asm-transactions",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "country",
    "sortMetric": "transactions$count",
    "sortOrder": "desc",
    "aggregations": {
            "transactions$count": {
                    "metricSet": "transactions",
                    "metric": "count"
            }
    },
    "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 country

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