Skip to content

Commit

Permalink
docs(faq): Add initial details about penalties
Browse files Browse the repository at this point in the history
Ad discussed on Slack, and related to cronian-tech/saturn-moonlet#3.

Signed-off-by: Michael Vorburger ⛑️ <[email protected]>
  • Loading branch information
vorburger authored Aug 28, 2023
1 parent 4292ce7 commit 4566810
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,21 @@ These are the current penalties that affect both DNS weight and earned FIL:
- Fraudulent logging (e.g. self-dealing)
- Multi-noding (Running multiple nodes on the same host)

These are visibile e.g. by hovering over the _Weight_ of a Node on https://dashboard.saturn.tech, or on the _Penalty_ graph of the [Moonlet](https://github.com/31z4/saturn-moonlet).

Here are more details about each kind of penalty, with information what could cause it, and how to remedy if your Node encounters them:

- `error_ratio` is caused by errors as shown in the log of L1 Node container, scuh as:
- Node refusing to connect with a client multiple times.
- `dup_cache_miss_ratio` is caused if a computed error ratio for consecutive duplicate cache misses goes over a threshold.
- `health_check_failures` are caused by an unexpectedly (not deregistered) unreachable node.
- This penalty starts with each health check failure event, and then gradually decreases over ~6h.
- Fix this by resolving the root cause of the node unavailability.
- Note the [deregister my node](#how-can-i-manually-deregister-my-node) section.

None of these are "expected" under normal operation, and all are something that you want to keep down.


## Registration

### My Node fails to register with error ETIMEDOUT/EHOSTUNREACH
Expand Down

0 comments on commit 4566810

Please sign in to comment.