Wasm 插件介绍和开发自定义插件

apiVersion: v1
kind: Namespace
metadata:
  name: higress-course
---
apiVersion: v1
kind: Service
metadata:
  name: echo-server
  namespace: higress-course
spec:
  selector:
    app: echo-server
  ports:
    - protocol: TCP
      port: 8080
      targetPort: 3000
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: echo-server
  namespace: higress-course
  labels:
    app: echo-server
spec:
  replicas: 1
  selector:
    matchLabels:
      app: echo-server
  template:
    metadata:
      labels:
        app: echo-server
    spec:
      containers:
        - name: echo-server
          image: higress-registry.cn-hangzhou.cr.aliyuncs.com/higress/echo-server:1.3.0
          env:
            - name: POD_NAME
              valueFrom:
                fieldRef:
                  fieldPath: metadata.name
            - name: NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace
          resources:
            requests:
              cpu: 10m
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ingress-foo
  namespace: higress-course
spec:
  ingressClassName: higress
  rules:
    - host: "foo.com"
      http:
        paths:
          - pathType: Prefix
            path: "/"
            backend:
              service:
                name: echo-server
                port:
                  number: 8080
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ingress-bar
  namespace: higress-course
spec:
  ingressClassName: higress
  rules:
    - host: "bar.com"
      http:
        paths:
          - pathType: Prefix
            path: "/"
            backend:
              service:
                name: echo-server
                port:
                  number: 8080
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ingress-baz
  namespace: higress-course
spec:
  ingressClassName: higress
  rules:
    - host: "baz.com"
      http:
        paths:
          - pathType: Prefix
            path: "/"
            backend:
              service:
                name: echo-server
                port:
                  number: 8080

apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: custom-response
  namespace: higress-system
spec:
  priority: 200
  # 配置会全局生效，但如果被下面规则匹配到，则会改为执行命中规则的配置
  defaultConfig:
    headers:
      - key1=value1
    "body": "{\"hello\":\"foo\"}"
  matchRules:
    # 域名级生效配置
    - domain:
        - bar.com
      config:
        headers:
          - key2=value2
        "body": "{\"hello\":\"bar\"}"
    # 路由级生效配置
    - ingress:
        - higress-course/ingress-baz
      # higress-course 命名空间下名为 ingress-baz 的 ingress 会应用下面这个配置
      config:
        headers:
          - key3=value3
        "body": "{\"hello\":\"baz\"}"
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/custom-response:1.0.0

package main

import (
  "github.com/alibaba/higress/plugins/wasm-go/pkg/wrapper"
  "github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
  "github.com/tidwall/gjson"
)

func main() {
  wrapper.SetCtx(
    // 插件名称
    "easy-logger",
    // 设置自定义函数解析插件配置
    wrapper.ParseConfigBy(parseConfig),
    // 设置自定义函数处理请求头
    wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
    // 设置自定义函数处理请求体
    wrapper.ProcessRequestBodyBy(onHttpRequestBody),
    // 设置自定义函数处理响应头
    wrapper.ProcessResponseHeadersBy(onHttpResponseHeaders),
    // 设置自定义函数处理响应体
    wrapper.ProcessResponseBodyBy(onHttpResponseBody),
    // 设置自定义函数处理流式请求体
    //wrapper.ProcessStreamingRequestBodyBy(onHttpStreamingRequestBody),
    // 设置自定义函数处理流式响应体
    //wrapper.ProcessStreamingResponseBodyBy(onHttpStreamingResponseBody),
  )
}

// 自定义插件配置
type LoggerConfig struct {
  // 是否打印请求
  request bool
  // 是否打印响应
  response bool
  // 打印响应状态码，* 表示打印所有状态响应，500,502,503 表示打印 HTTP 500、502、503 状态响应，默认是 *
  responseStatusCodes string
}

func parseConfig(json gjson.Result, config *LoggerConfig, log wrapper.Log) error {
  log.Debugf("parseConfig()")
  config.request = json.Get("request").Bool()
  config.response = json.Get("response").Bool()
  config.responseStatusCodes = json.Get("responseStatusCodes").String()
  if config.responseStatusCodes == "" {
    config.responseStatusCodes = "*"
  }
  log.Debugf("parse config:%v", config)
  return nil
}

func onHttpRequestHeaders(ctx wrapper.HttpContext, config LoggerConfig, log wrapper.Log) types.Action {
  log.Debugf("onHttpRequestHeaders()")
  return types.ActionContinue
}

func onHttpRequestBody(ctx wrapper.HttpContext, config LoggerConfig, body []byte, log wrapper.Log) types.Action {
  log.Debugf("onHttpRequestBody()")
  return types.ActionContinue
}

func onHttpResponseBody(ctx wrapper.HttpContext, config LoggerConfig, body []byte, log wrapper.Log) types.Action {
  log.Debugf("onHttpResponseBody()")
  return types.ActionContinue
}

func onHttpResponseHeaders(ctx wrapper.HttpContext, config LoggerConfig, log wrapper.Log) types.Action {
  log.Debugf("onHttpResponseHeaders()")
  return types.ActionContinue
}

admin:
  address:
    socket_address:
      protocol: TCP
      address: 0.0.0.0
      port_value: 9901
static_resources:
  listeners:
    - name: listener_0
      address:
        socket_address:
          protocol: TCP
          address: 0.0.0.0
          port_value: 10000
      filter_chains:
        - filters:
            - name: envoy.filters.network.http_connection_manager
              typed_config:
                "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
                scheme_header_transformation:
                  scheme_to_overwrite: https
                stat_prefix: ingress_http
                route_config:
                  name: local_route
                  virtual_hosts:
                    - name: local_service
                      domains: ["*"]
                      routes:
                        - match:
                            prefix: "/"
                          route:
                            cluster: echo-server
                http_filters:
                  - name: wasmdemo
                    typed_config:
                      "@type": type.googleapis.com/udpa.type.v1.TypedStruct
                      type_url: type.googleapis.com/envoy.extensions.filters.http.wasm.v3.Wasm
                      value:
                        config:
                          name: wasmdemo
                          vm_config:
                            runtime: envoy.wasm.runtime.v8
                            code:
                              local:
                                filename: /etc/envoy/plugin.wasm
                          configuration:
                            "@type": "type.googleapis.com/google.protobuf.StringValue"
                            value: |-
                              {
                                "request": true,
                                "response": true,
                                "responseStatusCodes": "200,500,502,503"
                              }
                  - name: envoy.filters.http.router
                    typed_config:
                      "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
  clusters:
    - name: echo-server
      connect_timeout: 30s
      type: LOGICAL_DNS
      dns_lookup_family: V4_ONLY
      lb_policy: ROUND_ROBIN
      load_assignment:
        cluster_name: echo-server
        endpoints:
          - lb_endpoints:
              - endpoint:
                  address:
                    socket_address:
                      address: echo-server
                      port_value: 3000

  configuration:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: |-
      {
        "request": true,
        "response": true,
        "responseStatusCodes": "200,500,502,503"
      }

version: '3.9'
services:
  envoy:
    image: higress-registry.cn-hangzhou.cr.aliyuncs.com/higress/gateway:v1.4.1
    entrypoint: /usr/local/bin/envoy
    # 注意这里对 Wasm 开启了 debug 级别日志，在生产环境部署时请使用默认的 info 级别
    # 如果需要将 Envoy 的日志级别调整为 debug，将 --log-level 参数设置为 debug
    command: -c /etc/envoy/envoy.yaml --log-level info --log-path /etc/envoy/envoy.log --component-log-level wasm:debug
    depends_on:
      - echo-server
    networks:
      - wasmtest
    ports:
      - "10000:10000"
      - "9901:9901"
    volumes:
      - ./envoy.yaml:/etc/envoy/envoy.yaml
      - ./build/plugin.wasm:/etc/envoy/plugin.wasm
      - ./envoy.log:/etc/envoy/envoy.log
  echo-server:
    image: higress-registry.cn-hangzhou.cr.aliyuncs.com/higress/echo-server:1.3.0
    networks:
      - wasmtest
    ports:
      - "3000:3000"
networks:
  wasmtest: {}

ARG BUILDER=higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/wasm-go-builder:go1.19-tinygo0.28.1-oras1.0.0
FROM $BUILDER as builder

ARG GOPROXY
ENV GOPROXY=${GOPROXY}

ARG EXTRA_TAGS=""
ENV EXTRA_TAGS=${EXTRA_TAGS}

WORKDIR /workspace
COPY . .
RUN go mod tidy
RUN tinygo build -o /main.wasm -scheduler=none -gc=custom -tags="custommalloc nottinygc_finalizer $EXTRA_TAGS" -target=wasi ./main.go

FROM scratch as output
COPY --from=builder /main.wasm plugin.wasm

package main

import (
  "fmt"
  "strings"

  "github.com/alibaba/higress/plugins/wasm-go/pkg/wrapper"
  "github.com/google/uuid"
  "github.com/higress-group/proxy-wasm-go-sdk/proxywasm"
  "github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
  "github.com/tidwall/gjson"
)

func main() {
  wrapper.SetCtx(
    // 插件名称
    "easy-logger",
    // 设置自定义函数解析插件配置
    wrapper.ParseConfigBy(parseConfig),
    // 设置自定义函数处理请求头
    wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
    // 设置自定义函数处理请求体
    wrapper.ProcessRequestBodyBy(onHttpRequestBody),
    // 设置自定义函数处理响应头
    wrapper.ProcessResponseHeadersBy(onHttpResponseHeaders),
    // 设置自定义函数处理响应体
    wrapper.ProcessResponseBodyBy(onHttpResponseBody),
    // 设置自定义函数处理流式请求体
    //wrapper.ProcessStreamingRequestBodyBy(onHttpStreamingRequestBody),
    // 设置自定义函数处理流式响应体
    //wrapper.ProcessStreamingResponseBodyBy(onHttpStreamingResponseBody),
  )
}

// 自定义插件配置
type LoggerConfig struct {
  // 是否打印请求
  request bool
  // 是否打印响应
  response bool
  // 打印响应状态码，* 表示打印所有状态响应，500,502,503 表示打印 HTTP 500、502、503 状态响应，默认是 *
  responseStatusCodes string
}

func parseConfig(json gjson.Result, config *LoggerConfig, log wrapper.Log) error {
  log.Debugf("parseConfig()")
  config.request = json.Get("request").Bool()
  config.response = json.Get("response").Bool()
  config.responseStatusCodes = json.Get("responseStatusCodes").String()
  if config.responseStatusCodes == "" {
    config.responseStatusCodes = "*"
  }
  log.Debugf("parse config:%+v", config)
  return nil
}

func onHttpRequestHeaders(ctx wrapper.HttpContext, config LoggerConfig, log wrapper.Log) types.Action {
  log.Debugf("onHttpRequestHeaders()")
  requestId := uuid.New().String()
  ctx.SetContext("requestId", requestId)
  if !config.request {
    return types.ActionContinue
  }
  // 获取并打印请求头
  headers, _ := proxywasm.GetHttpRequestHeaders()
  var build strings.Builder
  build.WriteString("\n===========request headers===============\n")
  build.WriteString(fmt.Sprintf("requestId:%s\n", requestId))
  for _, values := range headers {
    build.WriteString(fmt.Sprintf("%s:%s\n", values[0], values[1]))
  }
  log.Infof(build.String())
  // 继续处理请求
  return types.ActionContinue
}

func onHttpRequestBody(ctx wrapper.HttpContext, config LoggerConfig, body []byte, log wrapper.Log) types.Action {
  log.Debugf("onHttpRequestBody()")
  // 打印请求体
  if config.request {
    var build strings.Builder
    build.WriteString("\n===========request body===============\n")
    requestId := ctx.GetContext("requestId").(string)
    build.WriteString(fmt.Sprintf("requestId:%s\n", requestId))
    build.WriteString(fmt.Sprintf("body:%s\n", string(body)))
    log.Infof(build.String())
  }
  return types.ActionContinue
}

func onHttpResponseHeaders(ctx wrapper.HttpContext, config LoggerConfig, log wrapper.Log) types.Action {
  log.Debugf("onHttpResponseHeaders()")
  // 添加自定义响应头
  proxywasm.AddHttpResponseHeader("x-easy-logger", "1.0.0")
  if !config.response {
    return types.ActionContinue
  }
  // 获取响应状态码
  statusCode, _ := proxywasm.GetHttpResponseHeader(":status")
  logResponseBody := false
  // 根据响应状态码决定是否打印响应体
  if config.responseStatusCodes == "*" || strings.Contains(config.responseStatusCodes, statusCode) {
    logResponseBody = true
  }
  // 将是否记录响应体的信息存储在上下文中，在 onHttpResponseBody 阶段获取上下文判断是否打印响应体
  ctx.SetContext("logResponseBody", logResponseBody)
  // 获取响应头
  headers, _ := proxywasm.GetHttpResponseHeaders()
  // 打印响应头
  var build strings.Builder
  build.WriteString("\n===========response headers===============\n")
  requestId := ctx.GetContext("requestId").(string)
  build.WriteString(fmt.Sprintf("requestId:%s\n", requestId))
  for _, values := range headers {
    build.WriteString(fmt.Sprintf("%s:%s\n", values[0], values[1]))
  }
  log.Infof(build.String())
  return types.ActionContinue
}

func onHttpResponseBody(ctx wrapper.HttpContext, config LoggerConfig, body []byte, log wrapper.Log) types.Action {
  log.Debugf("onHttpResponseBody()")
  // 获取在 onHttpRequestHeaders 阶段设置的上下文
  logResponseBody, ok := ctx.GetContext("logResponseBody").(bool)
  if !ok {
    return types.ActionContinue
  }
  // 打印响应体
  if logResponseBody {
    var build strings.Builder
    build.WriteString("\n===========response body===============\n")
    requestId := ctx.GetContext("requestId").(string)
    build.WriteString(fmt.Sprintf("requestId:%s\n", requestId))
    build.WriteString(fmt.Sprintf("body:%s\n", string(body)))
    log.Infof(build.String())
  }
  return types.ActionContinue
}

apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: easy-logger
  namespace: higress-system
spec:
  priority: 300
  matchRules:
    # 域名级生效配置
    - domain:
        - foo.com
      config:
        request: true
        response: true
        responseStatusCodes: "200,500,502,503"
  url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/easy-logger:1.0.0