Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(faq): Add initial details about penalties #481

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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).
vorburger marked this conversation as resolved.
Show resolved Hide resolved

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:
vorburger marked this conversation as resolved.
Show resolved Hide resolved
- 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.
vorburger marked this conversation as resolved.
Show resolved Hide resolved
- `health_check_failures` are caused by an unexpectedly (not deregistered) unreachable node.
vorburger marked this conversation as resolved.
Show resolved Hide resolved
- 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.
vorburger marked this conversation as resolved.
Show resolved Hide resolved
- 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error rates are expected. Duplicate cache misses are not, this statement isn't general

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! OK, I have removed this phrase, but... if Error rates are expected under normal operations, then why does Node get penalized for it, if there is nothing its operator can do about it?



## Registration

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