Watchdog
OpenFaaS watchdog¶
The OpenFaaS watchdog is responsible for starting and monitoring functions in OpenFaaS. Any binary can become a function through the use of watchdog.
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.
Classic watchdog¶
The classic watchdog has historically been used for all of the official OpenFaaS templates, but the of-watchdog (mentioned below) is now becoming more popular and templates exist for both watchdogs for the common programming languages in the default templates repository and community template store.
Pictured: technical conceptual diagram of the OpenFaaS watchdog during an invocation
Technical documentation on the classic watchdog is available along with a table with all configuration options.
of-watchdog¶
The of-watchdog project is complementary to the Classic Watchdog mentioned above. It was started in October 2017 and provides an alternative to STDIO for communication between the watchdog and the function.
Status: this component is suitable for use in production and is part of the openfaas GitHub organisation.
Pictured: various modes for the of-watchdog component
This version of the of-watchdog brings new features for high-throughput and enables re-use of expensive resources such as database connection pools or machine-learning models. The primary difference is the ability to keep the function process warm between invocations. The classic watchdog forks one process per request giving the highest level of portability, but the newer version enables a http mode where that same process can be re-used repeatedly to offset the latency of forking.
The http mode of the of-watchdog uses custom templates.