You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-25Lines changed: 26 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -155,31 +155,32 @@ Environmental variables:
155
155
156
156
> Note: timeouts should be specified as Golang durations i.e. `1m` or `20s`.
157
157
158
-
| Option |Usage|
159
-
| ----------------------|-----|
160
-
|`fprocess` / `function_process`| Process to execute a server in `http` mode or to be executed for each request in the other modes. For non `http` mode the process must accept input via STDIN and print output via STDOUT. Also known as "function process". |
161
-
|`mode`| The mode which of-watchdog operates in, Default `streaming`[see doc](#3-streaming-fork-modestreaming---default). Options are [http](#1-http-modehttp), [serialising fork](#2-serializing-fork-modeserializing), [streaming fork](#3-streaming-fork-modestreaming---default), [static](#4-static-modestatic)|
162
-
|`read_timeout`|HTTP timeout for reading the payload from the client caller (in seconds)|
163
-
|`write_timeout`| HTTP timeout for writing a response body from your function (in seconds) |
164
-
|`exec_timeout`| Exec timeout for process exec'd for each incoming request (in seconds). Disabled if set to 0.|
165
-
|`max_inflight`|Limit the maximum number of requests in flight, and return a HTTP status 429 when exceeded|
166
-
|`prefix_logs`| When set to `true` the watchdog will add a prefix of "Date Time" + "stderr/stdout" to every line read from the function process. Default `true`|
167
-
|`log_buffer_size`| The amount of bytes to read from stderr/stdout for log lines. When exceeded, the user will see an "bufio.Scanner: token too long" error. The default value is `bufio.MaxScanTokenSize`|
168
-
|`healthcheck_interval`|Interval (in seconds) for HTTP healthcheck by container orchestrator i.e. kubelet. Used for graceful shutdowns.|
169
-
|`port`| Specify an alternative TCP port for testing. Default: `8080`|
170
-
|`content_type`|Force a specific Content-Type response for all responses - only in forking/serializing modes.|
171
-
|`suppress_lock`| When set to `false` the watchdog will attempt to write a lockfile to `/tmp/.lock` for healthchecks. Default `false`|
172
-
|`http_upstream_url`|`http` mode only - where to forward requests i.e. `127.0.0.1:5000`|
173
-
|`upstream_url`| alias for `http_upstream_url`|
174
-
|`http_buffer_req_body`|`http` mode only - buffers request body in memory before forwarding upstream to your template's `upstream_url`. Use if your upstream HTTP server does not accept `Transfer-Encoding: chunked`, for example WSGI tends to require this setting. Default: `false`|
175
-
|`buffer_http`|deprecated alias for `http_buffer_req_body`, will be removed in future version |
176
-
|`static_path`| Absolute or relative path to the directory that will be served if `mode="static"`|
177
-
|`ready_path`| When non-empty, requests to `/_/ready` will invoke the function handler with this path. This can be used to provide custom readiness logic. When `max_inflight` is set, the concurrency limit is checked first before proxying the request to the function.|
|`buffer_http`| (Deprecated) Alias for `http_buffer_req_body`, will be removed in future version|
161
+
|`content_type`| Force a specific Content-Type response for all responses - only in forking/serializing modes. |
162
+
|`exec_timeout`|Exec timeout for process exec'd for each incoming request (in seconds). Disabled if set to 0.|
163
+
|`fprocess` / `function_process`| Process to execute a server in `http` mode or to be executed for each request in the other modes. For non `http` mode the process must accept input via STDIN and print output via STDOUT. Also known as "function process".|
164
+
|`healthcheck_interval`| Interval (in seconds) for HTTP healthcheck by container orchestrator i.e. kubelet. Used for graceful shutdowns. |
165
+
|`http_buffer_req_body`|`http` mode only - buffers request body in memory before forwarding upstream to your template's `upstream_url`. Use if your upstream HTTP server does not accept `Transfer-Encoding: chunked`, for example WSGI tends to require this setting. Default: `false`|
166
+
|`http_upstream_url`|`http` mode only - where to forward requests i.e. `http://127.0.0.1:5000`|
167
+
|`log_buffer_size`| The amount of bytes to read from stderr/stdout for log lines. When exceeded, the user will see an "bufio.Scanner: token too long" error. The default value is `bufio.MaxScanTokenSize`|
168
+
|`max_inflight`|Limit the maximum number of requests in flight, and return a HTTP status 429 when exceeded |
169
+
|`mode`| The mode which of-watchdog operates in, Default`streaming`[see doc](#3-streaming-fork-modestreaming---default). Options are [http](#1-http-modehttp), [serialising fork](#2-serializing-fork-modeserializing), [streaming fork](#3-streaming-fork-modestreaming---default), [static](#4-static-modestatic)|
170
+
|`port`|Specify an alternative TCP port for testing. Default: `8080`|
171
+
|`prefix_logs`| When set to `true` the watchdog will add a prefix of "Date Time" + "stderr/stdout" to every line read from the function process. Default `true`|
172
+
|`read_timeout`|HTTP timeout for reading the payload from the client caller (in seconds) |
173
+
|`ready_path`| When non-empty, requests to `/_/ready` will invoke the function handler with this path. This can be used to provide custom readiness logic. When `max_inflight` is set, the concurrency limit is checked first before proxying the request to the function.|
174
+
|`static_path`| Absolute or relative path to the directory that will be served if `mode="static"`|
175
+
|`suppress_lock`|When set to `false` the watchdog will attempt to write a lockfile to `/tmp/.lock` for healthchecks. Default `false`|
176
+
|`upstream_url`| Alias for `http_upstream_url`|
177
+
|`write_timeout`| HTTP timeout for writing a response body from your function (in seconds) |
178
178
179
179
Unsupported options from the [Classic Watchdog](https://github.com/openfaas/classic-watchdog):
|`write_debug`| In the classic watchdog, this prints the response body out to the console |
184
-
|`read_debug`| In the classic watchdog, this prints the request body out to the console |
185
-
|`combined_output`| In the classic watchdog, this returns STDOUT and STDERR in the function's HTTP response, when off it only returns STDOUT and prints STDERR to the logs of the watchdog |
|`write_debug`| In the classic watchdog, this prints the response body out to the console |
184
+
|`read_debug`| In the classic watchdog, this prints the request body out to the console |
185
+
|`combined_output`| In the classic watchdog, this returns STDOUT and STDERR in the function's HTTP response, when off it only returns STDOUT and prints STDERR to the logs of the watchdog |
0 commit comments