config.storage/etcd: connection alerts
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool-ee/pull/1663
Product: Tarantool Enterprise
Since: 3.7
Root documenst:
- https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#config-etcd
- https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#config-storage
- (maybe) https://www.tarantool.io/en/doc/latest/platform/configuration/configuration_etcd/
SME: @mandesero @georgiy-belyanin
Details
When connectivity to config.etcd or config.storage is lost, Tarantool set a named connection alert.
The alert is reported as warn for a short outage and escalates to error after the reconnect threshold is exceeded.
For etcd, the escalation timeout is reconnect_timeout * reconnect_max_attempts seconds.
With default values, this is 1 * 10 = 10 seconds.
For config storage (tkv), the escalation timeout is reconnect_after * 5 seconds.
For example, with reconnect_after = 1, the alert becomes error after 5 seconds.
The alert is dropped automatically when connectivity is restored.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the configuration_reference sections for config.etcd and config.storage, then check the configuration_etcd page for the appropriate placement. Document the named connection alerts, warn-to-error escalation thresholds, and automatic removal after connectivity is restored, using the linked configuration values and defaults as examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100