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

chore: added wal/snapshot doc #25856

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: added wal/snapshot doc #25856

wants to merge 1 commit into from

Conversation

praveen-influx
Copy link
Contributor

Moving some of my work notes into a doc (might be handy to understand the wal/snapshotting process)

@praveen-influx praveen-influx requested a review from a team January 17, 2025 15:45
Copy link
Contributor

@hiltontj hiltontj left a comment

Choose a reason for hiding this comment

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

Looking good I just had a couple comments.

│ ┌────────────┐
└───────────────►│clear buffer│ (whatever snapshotted is removed)
└────────────┘
```
Copy link
Contributor

Choose a reason for hiding this comment

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

A useful addition to this diagram would be to show the entry point for writes from user, i.e., where do writes go from the user (wal buffer?), via an arrow. Otherwise, it is not clear on the order of operations. If you could connect the numbers from the steps described below to locations / arrows on the diagram, that would be helpful.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point - I'll try to link the steps to the diagram and add the incoming writes as well.

If going ahead with force snapshotting, pick all the wal periods in the tracker and find the max time from most recent wal period. This will be
used as the `end_time_marker` to evict data from query buffer. Because forcing a snapshot can be triggered when wal buffer is empty (even though
queryable buffer is full), we need to add `Noop` (a no-op WalOp) to the wal file to hold the snapshot details in wal file.

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a header on this diagram, e.g.,

##### Forced snapshot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants