openfaas-logs-walkthrough.md

1. Install openfaas using these images

• Replace the gateway with theaxer/gateway:loggerhandler
• Replace your provider with theaxer/faas-netes:loggerhandler or theaxer/swarm:loggerhandler

Export the base url to your gateway, e.g.

export gateway=http://localhost:31112

2. deploy a function, e.g. Alex's echo fn we use to load testing

git clone [email protected]:alexellis/echo-fn.git
cd echo-fn
faas-cli deploy --gateway $gateway

3. generate some logs

echo "$SECONDS" | faas-cli invoke go-echo --gateway=$gateway

or

hey -c 2 -q 10 -n 100000 $gateway/function/go-echo

4. ask the api for the function logs

curl -H "Connection: keep-alive" "$gateway/system/logs?name=go-echo&follow=true"

Notes:

The request is read from the GET parameters, as described below

type Request struct {
	// Name is the function name and is required
	Name string `json:"name"`
	// Instance is the optional container name, that allows you to request logs from a specific function instance
	Instance string `json:"instance"`
	// Since is the optional datetime value to start the logs from
	Since *time.Time `json:"since"`
	// Limit sets the maximum number of log messages to return, <=0 means unlimited
	Limit int `json:"limit"`
	// Follow is allows the user to request a stream of logs
	Follow bool `json:"follow"`
	// Pattern is an optional regexp value to filter the log messages
	Pattern *string `json:"pattern"`
	// Invert allows you to control if the Pattern should be matched or negated
	Invert bool `json:"invert"`
}