diff options
| author | Loïc Hoguin <[email protected]> | 2021-09-07 13:54:24 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2021-09-07 13:54:24 +0200 |
| commit | 57f4bae7793b1472676f3a99e8c0d475e71fc82b (patch) | |
| tree | e563a6ce6bc6d8bdd2a94a2749da53a401759630 /doc | |
| parent | 0277ef97335099cfb64d10b5382c87486b27717a (diff) | |
| download | ranch-57f4bae7793b1472676f3a99e8c0d475e71fc82b.tar.gz ranch-57f4bae7793b1472676f3a99e8c0d475e71fc82b.tar.bz2 ranch-57f4bae7793b1472676f3a99e8c0d475e71fc82b.zip | |
Tweak the alarms documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/guide/listeners.asciidoc | 10 | ||||
| -rw-r--r-- | doc/src/manual/ranch.asciidoc | 8 |
2 files changed, 9 insertions, 9 deletions
diff --git a/doc/src/guide/listeners.asciidoc b/doc/src/guide/listeners.asciidoc index 65ade28..9ee2d98 100644 --- a/doc/src/guide/listeners.asciidoc +++ b/doc/src/guide/listeners.asciidoc @@ -331,8 +331,8 @@ processes. === Setting connection count alarms The `alarms` transport option allows you to configure alarms -which will be triggered when the number of connections under a connection -supervisor reaches or exceeds the defined treshold. +which will be triggered when the number of connections tracked +by one connection supervisor reaches or exceeds the defined treshold. The `alarms` transport option takes a map with alarm names as keys and alarm options as values. @@ -343,7 +343,7 @@ Alarm options include the alarm type and a treshold that, when reached, triggers the given callback. A cooldown prevents the alarm from being triggered too often. -.Setting an alarm to log warnings when the number of connections exceed 100 +.Log warnings when the number of connections exceeds 100 [source,erlang] ---- @@ -366,8 +366,8 @@ Alarms = #{ ---- In the example code, an alarm named `my_alarm` is defined, which will -call the given function when the number of connections under a -connection supervisor reaches or exceeds 100. When the number of +call the given function when the number of connections tracked +by the connection supervisor reaches or exceeds 100. When the number of connections is still (or again) above 100 after the default cooldown period of 5 seconds, the alarm will trigger again. diff --git a/doc/src/manual/ranch.asciidoc b/doc/src/manual/ranch.asciidoc index af006a2..14add7d 100644 --- a/doc/src/manual/ranch.asciidoc +++ b/doc/src/manual/ranch.asciidoc @@ -117,8 +117,8 @@ None of the options are required. alarms (#{}):: -Alarms to call a function when the number of connections under a -connection supervisor reaches or exceeds a defined treshold. +Alarms to call a function when the number of connections tracked +by one connection supervisor reaches or exceeds a defined treshold. + The map keys are the alarm names, which can be any `term`. The associated values are the respective alarm options, again in a map @@ -131,8 +131,8 @@ Must be set to `num_connections`. treshold::: Treshold value, which must be a `non_neg_integer`. When the -number of connections under a connection supervisor reaches -or exceeds this value, The alarm will trigger and call +number of connections tracked by a single connection supervisor +reaches or exceeds this value, The alarm will trigger and call the function defined in the `callback` key (see below). callback::: |