diff options
| author | Jan Uhlig <[email protected]> | 2024-10-02 12:22:10 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2024-11-12 14:56:59 +0100 |
| commit | 53a8db10195f9aae640b238fa3d571bf0136a55a (patch) | |
| tree | 6b2ec1f0b3275615e51ce06f5909dd234d47f5f8 /doc/src/guide | |
| parent | e5649ba630c5be25a0c9c9f20c78f8f9f72e363e (diff) | |
| download | ranch-53a8db10195f9aae640b238fa3d571bf0136a55a.tar.gz ranch-53a8db10195f9aae640b238fa3d571bf0136a55a.tar.bz2 ranch-53a8db10195f9aae640b238fa3d571bf0136a55a.zip | |
Fix alarm setting typo
The setting `threshold` was misspelled as `treshold`.
Diffstat (limited to 'doc/src/guide')
| -rw-r--r-- | doc/src/guide/listeners.asciidoc | 6 | ||||
| -rw-r--r-- | doc/src/guide/migrating_from_2.0.asciidoc | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/src/guide/listeners.asciidoc b/doc/src/guide/listeners.asciidoc index 9ee2d98..c30cb5c 100644 --- a/doc/src/guide/listeners.asciidoc +++ b/doc/src/guide/listeners.asciidoc @@ -332,14 +332,14 @@ processes. The `alarms` transport option allows you to configure alarms which will be triggered when the number of connections tracked -by one connection supervisor reaches or exceeds the defined treshold. +by one connection supervisor reaches or exceeds the defined threshold. The `alarms` transport option takes a map with alarm names as keys and alarm options as values. Any term is allowed as an alarm name. -Alarm options include the alarm type and a treshold that, when reached, +Alarm options include the alarm type and a threshold that, when reached, triggers the given callback. A cooldown prevents the alarm from being triggered too often. @@ -350,7 +350,7 @@ triggered too often. Alarms = #{ my_alarm => #{ type => num_connections, - treshold => 100, + threshold => 100, callback => fun(Ref, Name, ConnSup, ConnPids]) -> logger:warning("Warning (~s): " "Supervisor ~s of listener ~s " diff --git a/doc/src/guide/migrating_from_2.0.asciidoc b/doc/src/guide/migrating_from_2.0.asciidoc index fb2c69d..498a581 100644 --- a/doc/src/guide/migrating_from_2.0.asciidoc +++ b/doc/src/guide/migrating_from_2.0.asciidoc @@ -18,7 +18,7 @@ for Erlang/OTP 21 has been removed. * Alarms can now be configured. The only alarm currently available is `num_connections`. When the number of - connections goes over a configurable treshold Ranch + connections goes over a configurable threshold Ranch will call the given callback. This can be used to programmatically shut down idle connections to make up space for new connections, for example. |