warble-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From humbed...@apache.org
Subject [incubator-warble-server] 02/02: add in more ideas, tweak headers
Date Thu, 28 Jun 2018 23:12:01 GMT
This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-warble-server.git

commit 3f8740de50a4191fcf3a7638cf7a7caf2221e082
Author: Daniel Gruno <humbedooh@apache.org>
AuthorDate: Thu Jun 28 18:11:44 2018 -0500

    add in more ideas, tweak headers
---
 docs/source/design-nodedb.rst | 41 ++++++++++++++++++++++++++++++++++++-----
 1 file changed, 36 insertions(+), 5 deletions(-)

diff --git a/docs/source/design-nodedb.rst b/docs/source/design-nodedb.rst
index 969f74e..698b870 100644
--- a/docs/source/design-nodedb.rst
+++ b/docs/source/design-nodedb.rst
@@ -7,10 +7,12 @@ Node Task Registry Design
 
 
 ****************************
-Node Task Registry Design
+Node Tasks
 ****************************
 
-##### Basic Task Design
+#####################
+Basic Task Design
+#####################
 Warble Nodes can have one or more (or all) tasks assigned to it. Each
 task consists of a target to test, as well as what to test and how to go
 about that, encapsulated in a payload object. Each check you wish to
@@ -20,7 +22,34 @@ requires a task, as does a test for https on port 443, as they are
 technically two distinct targets. Specific tasks may have optional tests
 built into them,for instance a SSL certificate check on a https site.
 
-##### Task Categories
+#####################
+Task status
+#####################
+A task can be either enabled, disabled, or muted. Disabling a task
+prevents it from running on nodes, whereas muting a task will still
+cause nodes to perform it, but alerting will be silenced. Muting can be
+used for when you still need to monitor a situation, but you don't need
+to be reminded whenever the test results changes.
+
+#####################
+Task sensitivity
+#####################
+A task can also have a specific sensitivity set. Sensitivity denotes
+how failures are treated, and when to alert about state changes:
+
+- `low`: Alerting only happens if all currently active nodes agree that the test has failed,
e.g. the service is down completely.
+- `default`: Alerting happens if a majority of nodes agree that the test has failed. This
is the default behavior and balances out the need for speedy alerting versus the need for
fewer false positives.
+- `high`: Alerting happens if more than one node sees failures. While more sensitive than
the default, it still removes a fair bit of false positives by requiring confirmation of a
reported failure by at least one other node.
+- `twitchy`: Alerting happens if one or more nodes register failure. This may be useful for
services that have guaranteed service level agreements.
+
+It should be noted that if you run a setup of Warble with only one, or
+very few nodes attached, the sensitivity levels may differ very little
+in terms of when alerting happens, as the definition of quorum changes
+based on how many active nodes you have at any given time.
+
+*******************
+Task Categories
+*******************
 Each task is assigned a task category, which helps you separate tasks into
 easily recognizable groups and access definitions.
 
@@ -30,7 +59,9 @@ go to that team, independent of other task categories. This can be
 useful for having front-end issues go to a specific team, while back-end 
 issues go to another team.
 
-##### Task Category Access
+#####################
+Task Category Access
+#####################
 Users can be assigned the following access levels to categories, on a
 per-user basis:
 
@@ -46,7 +77,7 @@ per-user basis:
    remove the category altogether or change its alerting options. This access
    level should generally be reserved for power users only.
 
-It should be noted that _super users_ on the system (such as the account
+It should be noted that `super users` on the system (such as the account
 you create at setup) can freely access and modify any aspect of the
 tasks/categories.
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@warble.apache.org
For additional commands, e-mail: commits-help@warble.apache.org


Mime
View raw message