From 096bede3f0205aa20ff2ec275291d4018af076ee Mon Sep 17 00:00:00 2001
From: Alex Ellis <alexellis2@gmail.com>
Date: Mon, 25 Sep 2017 08:40:59 +0100
Subject: [PATCH] Update troubleshooting to add timeouts

---
 guide/troubleshooting.md | 129 ++++++++++++++++++++++-----------------
 1 file changed, 74 insertions(+), 55 deletions(-)

diff --git a/guide/troubleshooting.md b/guide/troubleshooting.md
index 72d46f7b..c87cabc8 100644
--- a/guide/troubleshooting.md
+++ b/guide/troubleshooting.md
@@ -1,62 +1,13 @@
 # Troubleshooting guide
 
-## Watchdog
+## Healthcheck
 
-### Debug your function without deploying it
+Most problems reported via GitHub or Slack stem from a configuration problem or issue with a function. Here is a checklist of things you can try before digging deeper:
 
-Here's an example of how you can deploy a function without using an orchestrator - it's useful for testing:
-
-```
-$ docker run --name debug-alpine \
-  -p 8081:8080 -ti functions/alpine:latest sh
-# fprocess=date fwatchdog &
-```
-
-Now you can access the function with one of the supported HTTP methods such as GET/POST etc:
-
-```
-$ curl -4 localhost:8081
-```
-
-### Edit your function without rebuilding it
-
-You can bind-mount code straight into your function and work with it locally, until you are ready to re-build. This is a common flow with containers, but should be used sparingly.
-
-Within the CLI directory for instance:
-
-Build the samples:
-
-```
-$ git clone https://github.com/alexellis/faas-cli && \
-  cd faas-cli
-$ faas-cli -action build -f ./samples.yml
-```
-
-Now work with the Python-hello sample, with the code mounted live:
-
-```
-$ docker run -v `pwd`/sample/url-ping/:/root/function/ \
-  --name debug-alpine -p 8081:8080 -ti alexellis/faas-url-ping sh
-$ touch ./function/__init__.py
-# fwatchdog
-```
-
-Now you can start editing the code in the sample/url-ping folder and it will reload live for every request.
-
-```
-$ curl localhost:8081 -d "https://www.google.com"
-Handle this -> https://www.google.com
-https://www.google.com => 200
-```
-
-Now you can edit handler.py and you'll see the change immediately:
-
-```
-$ echo "def handle(req):" > sample/url-ping/handler.py
-$ echo '    print("Nothing to see here")' >> sample/url-ping/handler.py
-$ curl localhost:8081 -d "https://www.google.com"
-Nothing to see here
-```
+Checklist:
+* [ ] All core services are deployed: i.e. gateway
+* [ ] Check functions are deployed and started
+* [ ] Check request isn't timing out at the gateway or the function level
 
 ## Docker Swarm
 
@@ -117,3 +68,71 @@ $ kubectl describe deploy/<function>
 ```
 $ kubectl delete -f faas.yml,monitoring.yml,rbac.yml
 ```
+
+## Timeouts
+
+Default timeouts are configured at the HTTP level for the gateway and watchdog. You can also enforce a hard-timeout for your function.
+
+For watchdog configuration see the [README](https://github.com/openfaas/faas/tree/master/watchdog).
+
+For the gateway set the following environmental variables:
+
+* read_timeout, write_timeout - the default for both is "8" - seconds.
+
+## Watchdog
+
+### Debug your function without deploying it
+
+Here's an example of how you can deploy a function without using an orchestrator - it's useful for testing:
+
+```
+$ docker run --name debug-alpine \
+  -p 8081:8080 -ti functions/alpine:latest sh
+# fprocess=date fwatchdog &
+```
+
+Now you can access the function with one of the supported HTTP methods such as GET/POST etc:
+
+```
+$ curl -4 localhost:8081
+```
+
+### Edit your function without rebuilding it
+
+You can bind-mount code straight into your function and work with it locally, until you are ready to re-build. This is a common flow with containers, but should be used sparingly.
+
+Within the CLI directory for instance:
+
+Build the samples:
+
+```
+$ git clone https://github.com/alexellis/faas-cli && \
+  cd faas-cli
+$ faas-cli -action build -f ./samples.yml
+```
+
+Now work with the Python-hello sample, with the code mounted live:
+
+```
+$ docker run -v `pwd`/sample/url-ping/:/root/function/ \
+  --name debug-alpine -p 8081:8080 -ti alexellis/faas-url-ping sh
+$ touch ./function/__init__.py
+# fwatchdog
+```
+
+Now you can start editing the code in the sample/url-ping folder and it will reload live for every request.
+
+```
+$ curl localhost:8081 -d "https://www.google.com"
+Handle this -> https://www.google.com
+https://www.google.com => 200
+```
+
+Now you can edit handler.py and you'll see the change immediately:
+
+```
+$ echo "def handle(req):" > sample/url-ping/handler.py
+$ echo '    print("Nothing to see here")' >> sample/url-ping/handler.py
+$ curl localhost:8081 -d "https://www.google.com"
+Nothing to see here
+```