plugins

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type FaultInjection
  • func (p *FaultInjection) Name() string
  • func (p *FaultInjection) ParseConf(in []byte) (interface{}, error)
  • func (p *FaultInjection) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)
• type FaultInjectionConf
• type LimitReq
  • func (p *LimitReq) Name() string
  • func (p *LimitReq) ParseConf(in []byte) (interface{}, error)
  • func (p *LimitReq) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)
• type LimitReqConf
• type RegexFilter
• type ResponseRewrite
  • func (p *ResponseRewrite) Name() string
  • func (p *ResponseRewrite) ParseConf(in []byte) (interface{}, error)
  • func (p *ResponseRewrite) ResponseFilter(conf interface{}, w pkgHTTP.Response)
• type ResponseRewriteConf
• type Say
  • func (p *Say) Name() string
  • func (p *Say) ParseConf(in []byte) (interface{}, error)
  • func (p *Say) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)
• type SayConf

Types

type FaultInjection

type FaultInjection struct {
	// Embed the default plugin here,
	// so that we don't need to reimplement all the methods.
	plugin.DefaultPlugin
}

FaultInjection is used in the benchmark

func (*FaultInjection) Name

func (p *FaultInjection) Name() string

func (*FaultInjection) ParseConf

func (p *FaultInjection) ParseConf(in []byte) (interface{}, error)

func (*FaultInjection) RequestFilter

func (p *FaultInjection) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)

type FaultInjectionConf

type FaultInjectionConf struct {
	Body       string `json:"body"`
	HttpStatus int    `json:"http_status"`
	Percentage int    `json:"percentage"`
}

type LimitReq

type LimitReq struct {
	// Embed the default plugin here,
	// so that we don't need to reimplement all the methods.
	plugin.DefaultPlugin
}

LimitReq is a demo for a real world plugin

func (*LimitReq) Name

func (p *LimitReq) Name() string

func (*LimitReq) ParseConf

func (p *LimitReq) ParseConf(in []byte) (interface{}, error)

ParseConf is called when the configuration is changed. And its output is unique per route.

func (*LimitReq) RequestFilter

func (p *LimitReq) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)

RequestFilter is called when a request hits the route

type LimitReqConf

type LimitReqConf struct {
	Burst int     `json:"burst"`
	Rate  float64 `json:"rate"`
	// contains filtered or unexported fields
}

type RegexFilter

type RegexFilter struct {
	Regex   string `json:"regex"`
	Scope   string `json:"scope"`
	Replace string `json:"replace"`
	// contains filtered or unexported fields
}

type ResponseRewrite

type ResponseRewrite struct {
	// Embed the default plugin here,
	// so that we don't need to reimplement all the methods.
	plugin.DefaultPlugin
}

ResponseRewrite is a demo to show how to rewrite response data.

func (*ResponseRewrite) Name

func (p *ResponseRewrite) Name() string

func (*ResponseRewrite) ParseConf

func (p *ResponseRewrite) ParseConf(in []byte) (interface{}, error)

func (*ResponseRewrite) ResponseFilter

func (p *ResponseRewrite) ResponseFilter(conf interface{}, w pkgHTTP.Response)

type ResponseRewriteConf

type ResponseRewriteConf struct {
	Status  int               `json:"status"`
	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
	Filters []RegexFilter     `json:"filters"`
}

type Say

type Say struct {
	// Embed the default plugin here,
	// so that we don't need to reimplement all the methods.
	plugin.DefaultPlugin
}

Say is a demo to show how to return data directly instead of proxying it to the upstream.

func (*Say) Name

func (p *Say) Name() string

func (*Say) ParseConf

func (p *Say) ParseConf(in []byte) (interface{}, error)

func (*Say) RequestFilter

func (p *Say) RequestFilter(conf interface{}, w http.ResponseWriter, r pkgHTTP.Request)

type SayConf

type SayConf struct {
	Body string `json:"body"`
}