18347675334
88%
main: 88%

Ran 08 Oct 2025 02:21PM UTC

Jobs 1

Files 197

Run time 1min

Badge

Embed ▾

Committed 08 Oct 2025 02:01PM UTC coverage: 91.015% (-0.06%) from 91.079%

Build # 18347675334

Build Type

push

github

Committed by

drmingdrmer

Commit Message

docs: improve API documentation and add FAQ troubleshooting section

Enhanced documentation for core API types:
- Raft: Add architecture overview, lifecycle documentation, and usage examples
- RaftMetrics: Document metric groupings and leader-specific metrics
- Config: Add summary with timing constraints and validation example
- RaftTypeConfig: Document usage with declare_raft_types! macro

Added FAQ troubleshooting section with 7 entries from real GitHub issues:

Proper API Usage:
- Panic: assertion failed is_following (RaftNetwork misconfiguration)
- ForwardToLeader with missing leader_id (membership change edge case)
- Holding Raft::metrics() reference blocks RaftCore (#1238)
- Error logs after raft.shutdown() completes (#1357)

Performance & Configuration:
- Slow replication with RocksDB (#1170)
- Frequent leader elections (election timeout too small)
- Excessive NetworkError logs (use Unreachable for backoff)

Rustdoc fixes:
- Remove private RaftCore references from public documentation
- Wrap bare URLs in angle brackets for proper autolinks
- Fix redundant explicit links in RaftMetrics

Run Details

11366 of 12488 relevant lines covered (91.02%)

103010.53 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
1	88.02	-0.14%	openraft/src/core/raft_core.rs
1	82.09	0.0%	openraft/src/metrics/serde_instant.rs
1	80.8	-0.4%	openraft/src/replication/mod.rs
9	85.92	-8.45%	openraft/src/core/heartbeat/worker.rs

Jobs

ID	Job ID	Ran	Files	Coverage
1	18347675334.1	08 Oct 2025 02:21PM UTC	197	91.02	GitHub Action Run

databendlabs / openraft / 18347675334
88%
main: 88%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18347675334

databendlabs / openraft / 18347675334 88% main: 88%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18347675334

databendlabs / openraft / 18347675334
88%
main: 88%

README BADGES
x