0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00

Document the logger option

This commit is contained in:
Loïc Hoguin 2019-10-07 11:43:44 +02:00
parent 0342866c2e
commit 53bc54a860
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
2 changed files with 12 additions and 0 deletions

View file

@ -23,6 +23,7 @@ opts() :: #{
idle_timeout => timeout(),
inactivity_timeout => timeout(),
linger_timeout => timeout(),
logger => module(),
max_empty_lines => non_neg_integer(),
max_header_name_length => non_neg_integer(),
max_header_value_length => non_neg_integer(),
@ -78,6 +79,10 @@ Time in ms that Cowboy will wait when closing the connection. This is
necessary to avoid the TCP reset problem as described in the
https://tools.ietf.org/html/rfc7230#section-6.6[section 6.6 of RFC7230].
logger (error_logger)::
The module that will be used to write log messages.
max_empty_lines (5)::
Maximum number of empty lines before a request.
@ -133,6 +138,7 @@ Ordered list of stream handlers that will handle all stream events.
== Changelog
* *2.7*: The `logger` option was added.
* *2.6*: The `chunked`, `http10_keepalive`, `proxy_header` and `sendfile` options were added.
* *2.5*: The `linger_timeout` option was added.
* *2.2*: The `max_skip_body_length` option was added.

View file

@ -25,6 +25,7 @@ opts() :: #{
inactivity_timeout => timeout(),
initial_connection_window_size => 65535..16#7fffffff,
initial_stream_window_size => 0..16#7fffffff,
logger => module(),
max_concurrent_streams => non_neg_integer() | infinity,
max_connection_buffer_size => non_neg_integer(),
max_connection_window_size => 0..16#7fffffff,
@ -104,6 +105,10 @@ Initial window size in bytes for new streams. This is the total amount
of data (from request bodies for example) that may be buffered
by a single stream before the user code explicitly requests it.
logger (error_logger)::
The module that will be used to write log messages.
max_concurrent_streams (infinity)::
Maximum number of concurrent streams allowed on the connection.
@ -234,6 +239,7 @@ too many `WINDOW_UPDATE` frames.
to protect against various flood scenarios; and
`stream_window_data_threshold` to control how small
the DATA frames that Cowboy sends can get.
* *2.7*: The `logger` option was added.
* *2.6*: The `proxy_header` and `sendfile` options were added.
* *2.4*: Add the options `initial_connection_window_size`,
`initial_stream_window_size`, `max_concurrent_streams`,