Skip to content

Commit d275fa7

Browse files
committed
Update watchdog docs
Make it clearer that concurrent requests are supported and that streaming use-cases are supported via the of-watchdog. Signed-off-by: Alex Ellis (VMware) <[email protected]>
1 parent 10db95c commit d275fa7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/architecture/watchdog.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
## OpenFaaS watchdog
22

3-
The OpenFaaS watchdog is responsible for starting and monitoring functions in OpenFaaS. Any binary can become a function through use of the watchdog.
3+
The OpenFaaS watchdog is responsible for starting and monitoring functions in OpenFaaS. Any binary can become a function through the use of watchdog.
4+
5+
The watchdog becomes an "init process" with an embedded HTTP server written in Golang, it can support concurrent requests, timeouts and healthchecks. The newer of-watchdog mentioned below is similar, but ideal for streaming use-cases or when an expensive resource needs to be maintained between requests such as a database connection, ML model or other data.
46

57
## Classic watchdog
68

@@ -22,6 +24,7 @@ of-watchdog is our next-generation watchdog which is in incubation within our [o
2224

2325
*Pictured: various modes for the of-watchdog component*
2426

25-
This brings version of the watchdog brings new features for high-throughput systems. The primary difference is the ability to keep a process warm between invocations. The classic watchdog forks one process per request and the new version enables a mode where that same process can be re-used repeatedly to reduce latency.
27+
This version of the of-watchdog brings new features for high-throughput systems. The primary difference is the ability to keep a process warm between invocations. The classic watchdog forks one process per request giving the highest level of portability, but the newer version enables a mode where that same process can be re-used repeatedly to offset the latency of forking.
2628

2729
* [Read more on the of-watchdog](https://github.com/openfaas-incubator/of-watchdog)
30+

0 commit comments

Comments
 (0)