kubevela/docs/examples/velaql-views/usage.md

Usage

You can use velaQL with a syntax similar to promeQL.

The syntax format of velaQL is as follows:

view{parameter1=value1}.statusKey

1. view represents different query views, we have built a few views: component-pod-view,pod-view,resource-view
2. parameter1=value1 represents query configuration items
3. statusKey represents the aggregate result of the query, default is status

component-pod-view

describe

List the pods created by specified component

parameter

parameter: {
  name:          string // application name
  namespace:     string // application namespace
  componentName: string // component name 
  cluster?:      string // cluster name(Optional)
}

statusKey

status

query result

// query successful
status: {
	podList: [{
		clusterName:    string 
		revision:       string
		publishVersion: string
		podName:        string
		status:         string
		podIP:          string
		hostIP:         string
		nodeName:       string
	}]
}

// query failed
status: {
  error: string
}

demo

component-pod-view{name=demo,namespace=default,cluster=prod,componentName=web}.status

pod-view

describe

Query the pods detail infomation

parameter

parameter: {
	name:      string // pod name
	namespace: string // pod namespace
	cluster?:  string // cluster name(Optional)
}

statusKey

status

query result

// query successful
status: {
	containers: [ {
		name:  string
		image: string
		status: {
			state:        string
			restartCount: string
		}
		resource: {
			limits: {
				cpu:    string
				memory: string
			}
			requests: {
				cpu:    string
				memory: string
			}
		}
		usageResource: {
			cpu:    string
			memory: string
		}
	}]
	events: [...corev1.Event]
}

// query failed
status: {
  error: string
}

demo

pod-view{name=demo,namespace=default,cluster=prod}.status

resource-view

describe

List resources

parameter

parameter: {
	type:      "ns" | "secret" | "configMap" | "pvc" | "storageClass"
	namespace: *"" | string // Optional
	cluster:   *"" | string // Optional
}

statusKey

status

query result

// query successful
status: {
	list: [...k8sObject]
}

// query failed
status: {
	error: string
}

demo

resource-view{type=ns,cluster=prod}.status