ASM Bypass

Overview

Module Name in API

bigip-asm-bypass

Product Name in API

device

Dimensions

Dimension Name in API Description
BIG-IP Host Name hostname The hostname given to the BIG-IP
SSG and BIG-IP Blade ssg-hostname-slot  
BIG-IP Service Cluster dsc-name Clusters of BIG-IPs grouped together to have the same config
Service Scaling Group ssg The name of the Service Scaling Group
BIG-IP Blade hostname-slot This is a combination of a BIG-IP hostname and its blade number

MetricSets

ASM Bypass Transactions

Description

Number of transaction going through BIG-IP, but being ignored by ASM module due to high load

Name In API

bypass-transactions

Metrics in the metricSet

Metric Name in API Unit Description
Total ASM Bypass Transactions sum trans  

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/device/metric-query

This example for JSON body in the post, filters by dimension hostname and get the sum of bypass-transactions

{
    "kind": "ap:query:stats:byTime",
    "module": "bigip-asm-bypass",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "bypass-transactions$sum": {
                    "metricSet": "bypass-transactions",
                    "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/device/metric-query

This example for JSON body in the post, gets top entities of type hostname, sorted by sum of bypass-transactions

{
    "kind": "ap:query:stats:byEntities",
    "module": "bigip-asm-bypass",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "hostname",
    "sortMetric": "bypass-transactions$sum",
    "sortOrder": "desc",
    "aggregations": {
            "bypass-transactions$sum": {
                    "metricSet": "bypass-transactions",
                    "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/device/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-asm-bypass",
    "dimension": "hostname",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}