You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@warble.apache.org by hu...@apache.org on 2018/06/28 23:11:59 UTC
[incubator-warble-server] branch master updated (d89c91a -> 3f8740d)
This is an automated email from the ASF dual-hosted git repository.
humbedooh pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-warble-server.git.
from d89c91a regen JS
new 362570c some ideas on node task registry design
new 3f8740d add in more ideas, tweak headers
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/source/design-nodedb.rst | 84 +++++++++++++++++++++++++++++++++++++++++++
docs/source/index.rst | 1 +
2 files changed, 85 insertions(+)
create mode 100644 docs/source/design-nodedb.rst
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@warble.apache.org
For additional commands, e-mail: commits-help@warble.apache.org
[incubator-warble-server] 02/02: add in more ideas, tweak headers
Posted by hu...@apache.org.
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 <hu...@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
[incubator-warble-server] 01/02: some ideas on node task registry
design
Posted by hu...@apache.org.
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 362570c5f713e7c695809a8115b482e7030696a9
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Thu Jun 28 17:56:26 2018 -0500
some ideas on node task registry design
---
docs/source/design-nodedb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++
docs/source/index.rst | 1 +
2 files changed, 54 insertions(+)
diff --git a/docs/source/design-nodedb.rst b/docs/source/design-nodedb.rst
new file mode 100644
index 0000000..969f74e
--- /dev/null
+++ b/docs/source/design-nodedb.rst
@@ -0,0 +1,53 @@
+Node Task Registry Design
+=========================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+****************************
+Node Task Registry 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
+perform requires an associated task, but may be performed by multiple
+nodes. Thus, testing whether your main web site works on port 80
+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
+Each task is assigned a task category, which helps you separate tasks into
+easily recognizable groups and access definitions.
+
+Each task category has a distinct alerting and escalation path, meaning
+you can assign different teams to different categories, and have alerts
+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
+Users can be assigned the following access levels to categories, on a
+per-user basis:
+
+1. Read-only access: The user can read and analyze test results, but
+ cannot edit or remove tasks, nor see the specific payload details (thus,
+ if you add a test with credentials, users with read-only access cannot
+ see the credentials)
+
+2. Read/write access: The user can read, modify, and remove existing
+ tests. They can also add new tests to the category.
+
+3. Admin access: The user can, besides permissions listed above, also modify or
+ 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
+you create at setup) can freely access and modify any aspect of the
+tasks/categories.
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 2375041..7a05a17 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -8,6 +8,7 @@ Welcome to Apache Warble's documentation!
setup
design-general
+ design-nodedb
Indices and tables
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@warble.apache.org
For additional commands, e-mail: commits-help@warble.apache.org