Document the new built-in system event `box.wal_error`
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_events/system_events/
SME: @ locker
Details
The new event is broadcast whenever Tarantool fails to commit
a transaction to the write-ahead log (WAL), which usually means
there's a problem with the underlying disk storage. The new event's
payload is a table that currently contains the only field count that
stores the number of WAL errors happened so far or nil if there hasn't
been any WAL errors.
Requested by @locker in https://github.com/tarantool/tarantool/commit/ddf252036e86a1930417660e025d6a8665fb97b4.
Definition of done
- the
box.wal_errorevent is described on the system events page
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 system events page at the linked root document and review how existing events are described. Add the box.wal_error event, including its WAL-commit failure behavior and count payload field, so the event is described on that page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100