VQL for Kubernetes Efficiency Reports

If you need help constructing a VQL query, navigate to the Kubernetes Efficiency Reports page and click New Report. From the top left, open the Filters menu. Create a filter and click the View as VQL button at the top of the Filters menu to see a filter’s VQL representation. You can copy this syntax to use within your API calls. You can also edit VQL directly and click Apply to update the filter.

Kubernetes Efficiency Reports VQL Schema

VQL for Kubernetes Efficiency Reports comprises one namespace, kubernetes, which represents the available filters on Kubernetes Efficiency Reports in the Vantage console. To reference a filter, use the following syntax: namespace.field (e.g., kubernetes.category). The following fields are available within the kubernetes namespace.

Namespace	Field	Description	VQL Example
`kubernetes`	`namespace`	Kubernetes namespace	Namespace example
`kubernetes`	`cluster_id`	Cluster identifier	Cluster ID example
`kubernetes`	`category`	Efficiency category, such as cpu	Category example
`kubernetes`	`labels`	Kubernetes label key and value, selected with `->>`	Labels example
`kubernetes`	`pod`	Pod name	Pod example
`kubernetes`	`region`	Cluster region	Region example

Keywords

VQL includes a set of keywords to create complex filter conditions. These keywords function similar to their SQL equivalents.

Keyword	Description	VQL Sample	Explanation
`AND`	Logical AND operator	`(kubernetes.namespace = 'kube-system') AND (kubernetes.labels->>'app' = 'vantage-agent')`	This example filters for a specific namespace and label, where both conditions must be true.
`OR`	Logical OR operator	`(kubernetes.namespace = 'gpu-operator') OR (kubernetes.namespace = 'vantage-dev')`	This example looks for results in two different namespaces. At least one condition must be true.
`!=`	Is not	`(kubernetes.cluster_id != 'dev-eks-gpu-0')`	This example looks for results that are in any cluster except for `dev-eks-gpu-0`.
`IN` and `NOT IN`	Used to compare against an array/list	`(kubernetes.labels->>'app.kubernetes.io/component' IN ('csi-driver','gpu-operator','metrics'))`	This example searches for results with the `app.kubernetes.io/component` key and multiple values. This same query also works for `NOT IN` where the results are anything matching the label key except for those particular values: `(kubernetes.labels->>'app.kubernetes.io/component' NOT IN ('csi-driver','gpu-operator','metrics'))`.
`LIKE` and `NOT LIKE`	Performs string comparisons	`(kubernetes.labels->>'app' LIKE '%test%')`	This example selects data where the `app` label value contains `test`, such as `test-app`. This same query also works for `NOT LIKE` where data does not contain a particular string: `(kubernetes.labels->>'app' NOT LIKE '%test%')`.
`->>`	This operator is used only when constructing queries related to labels	`(kubernetes.labels->>'container' = 'kube-prometheus-stack-48.4.0')`	This example looks for results with the label name of `container` and value of `kube-prometheus-stack-48.4.0`.

With these operators and keywords, you can construct complex filter conditions in VQL.

Syntax

VQL resembles the WHERE clause of a SQL query. Use ->> to select a Kubernetes label:

kubernetes.cluster_id IN ('production-1', 'production-2') AND kubernetes.namespace = 'payments' AND kubernetes.labels->>'app' = 'api'

Use single quotes around string values.

VQL Examples

The following examples cover common use cases for VQL.

Multiple Namespaces

Filter for one or the other namespace.

(kubernetes.namespace = 'kube-system') OR (kubernetes.namespace = 'default')

Results from a List of Clusters

Filter for a list of different clusters.

(kubernetes.cluster_id IN ('dev-eks-gpu-0','dev-eks-UVmPe9YN'))

Costs by Category

Costs for a specific category, like cpu.

(kubernetes.category = 'cpu')

Filter by Label

Filter based on a specific Kubernetes label, such as app, with the value rollouts-demo.

(kubernetes.labels->>'app' = 'rollouts-demo')

Filter by Pod

Filter for a specific pod.

(kubernetes.pod = 'my-pod-name')

Filter by Region

Filter for clusters in multiple regions.

kubernetes.region IN ('us-east-1', 'us-west-2')

Multiple Filters

Complex filter that shows combining two different statements using OR with multiple criteria.

((kubernetes.cluster_id IN ('dev-eks-gpu-0','dev-eks-UVmPe9YN')) AND (kubernetes.category = 'cpu')) OR ((kubernetes.cluster_id IN ('dev-eks-gpu-0','dev-eks-UVmPe9YN')) AND (kubernetes.category = 'gpu'))

Real-World Examples

Find CPU costs for production API workloads:

kubernetes.cluster_id IN ('production-1', 'production-2') AND kubernetes.category = 'cpu' AND kubernetes.labels->>'app' = 'api'

Find platform workloads running outside the primary region:

kubernetes.namespace = 'platform' AND kubernetes.region != 'us-east-1' AND kubernetes.labels->>'team' = 'platform'

Troubleshooting

Wrap string values in single quotes, not double quotes.
Use kubernetes.labels->>'KEY' to filter a label; kubernetes.labels.KEY is not valid VQL.
Keep complete conditions together when mixing AND and OR; use parentheses to separate each branch.
Use the cluster, region, category, and label values shown by View as VQL.

Get Started

Account & Security

AI, Terraform, & Developer Tools

Provider Integrations

App Integrations

Revenue & Finance Integrations

Cost Reporting Features

Financial Planning Features

VQL for Kubernetes Efficiency Reports

Kubernetes Efficiency Reports VQL Schema

Keywords

Syntax

VQL Examples

Multiple Namespaces

Results from a List of Clusters

Costs by Category

Filter by Label

Filter by Pod

Filter by Region

Multiple Filters

Real-World Examples

Troubleshooting

​Kubernetes Efficiency Reports VQL Schema

​Keywords

​Syntax

​VQL Examples

​Multiple Namespaces

​Results from a List of Clusters

​Costs by Category

​Filter by Label

​Filter by Pod

​Filter by Region

​Multiple Filters

​Real-World Examples

​Troubleshooting

Kubernetes Efficiency Reports VQL Schema

Keywords

Syntax

VQL Examples

Multiple Namespaces

Results from a List of Clusters

Costs by Category

Filter by Label

Filter by Pod

Filter by Region

Multiple Filters

Real-World Examples

Troubleshooting