search

drmingdrmer / openraft

An implementation of the Raft distributed consensus protocol using the Tokio framework.
https://datafuselabs.github.io/openraft/
Apache License 2.0
1 stars 1 forks source link

Feature: add absolute timestamp `RaftMetrics::last_quorum_acked` #94

Closed drmingdrmer closed 3 months ago

drmingdrmer commented 3 months ago

RaftMetrics::last_quorum_acked is the absolute timestamp of the most recent time point that is accepted by a quorum via AppendEntries RPC. This field is a wrapped Instant type: SerdeInstant which support serde for Instant. This field is added as a replacement of millis_since_quorum_ack, which is a relative time.

SerdeInstant serialize Instant into a string formatted as "%Y-%m-%dT%H:%M:%S%.9f%z", e.g., "2024-07-24T04:07:32.567025000+0000".

Note: Serialization and deserialization are not perfectly accurate and can be indeterministic, resulting in minor variations each time. These deviations(could be smaller or greater) are typically less than a microsecond (10^-6 seconds).

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance the Raft protocol's metrics handling and error management, introducing better serialization for time-related metrics and refining error documentation. Key updates include the implementation of SerdeInstant for timestamp metrics, deprecation of older fields, and improved logging mechanisms. These modifications aim to increase performance and reliability while maintaining backward compatibility and clarity in error reporting.

Changes

Files Change Summary
openraft/src/core/raft_core.rs Updated RaftMetrics and RaftDataMetrics to use SerdeInstant for last_quorum_acked, enhancing time metrics serialization.
openraft/src/error.rs Removed comments regarding future error subtype enhancements, simplifying error handling.
openraft/src/metrics/mod.rs Introduced serde_instant module and exported SerdeInstant type for improved modularity.
openraft/src/metrics/raft_metrics.rs Added last_quorum_acked field to RaftMetrics and RaftDataMetrics, deprecated millis_since_quorum_ack. Updated documentation and Display implementation.
openraft/src/metrics/serde_instant.rs Implemented SerdeInstant struct for Instant serialization, including conversion and testing functionalities.
openraft/src/metrics/wait_test.rs Added #[allow(deprecated)] to maintain compatibility and initialized last_quorum_acked in metrics.
scripts/check.kdl Removed close_on_exit option from pane definitions to keep output visible after command execution.
tests/tests/fixtures/mod.rs Enhanced set_panic_hook and log_panic for structured logging of panic information.
tests/tests/metrics/t10_leader_last_ack.rs Added leader_last_ack_3_nodes_abs_time test; updated assertions in existing tests for acknowledgment timing validation.

Sequence Diagram(s)

sequenceDiagram
    participant Leader
    participant Quorum
    participant Metrics

    Leader->>Quorum: Sends heartbeat
    Quorum-->>Leader: Acknowledgment received
    Leader->>Metrics: Update last_quorum_acked timestamp
    Metrics-->>Leader: Store updated timestamp

🐰 Hop, hop, let’s give a cheer,
For metrics bright and changes clear!
With SerdeInstant now in sight,
Our Raft’s performance takes to flight!
From bugs and errors, we shall part,
And celebrate with all our heart! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.