-
Notifications
You must be signed in to change notification settings - Fork 456
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
feat: support changing IndexPart::metadata_bytes to json in future release #7693
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
koivunej
force-pushed
the
joonas/legacy_metadata_as_json_in_future
branch
from
May 10, 2024 11:44
4e1d86f
to
63e3425
Compare
koivunej
changed the title
fix: support changing IndexPart::metadata_bytes to
fix: support changing IndexPart::metadata_bytes to json in future release
May 10, 2024
::legacy_metadata
in future release
koivunej
changed the title
fix: support changing IndexPart::metadata_bytes to json in future release
feat: support changing IndexPart::metadata_bytes to json in future release
May 10, 2024
3186 tests run: 3047 passed, 0 failed, 139 skipped (full report)Flaky tests (2)Postgres 14Code coverage* (full report)
* collected from Rust tests only The comment gets automatically updated with the latest test results
44d4146 at 2024-06-04T15:23:26.411Z :recycle: |
skyzh
approved these changes
May 13, 2024
koivunej
force-pushed
the
joonas/legacy_metadata_as_json_in_future
branch
from
June 4, 2024 14:28
6970bde
to
906ee84
Compare
We had some discussion perhaps last week if we want to keep the checksum or not in the json. The next PR will include refactoring which makes it trivial to include but, I'd rather not reorder the commits. |
koivunej
commented
Jun 4, 2024
koivunej
added a commit
that referenced
this pull request
Jun 11, 2024
We've stored metadata as bytes within the `index_part.json` for long fixed reasons. #7693 added support for reading out normal json serialization of the `TimelineMetadata`. Change the serialization to only write `TimelineMetadata` as json for going forward, keeping the backward compatibility to reading the metadata as bytes. Because of failure to include `alias = "metadata"` in #7693, one more follow-up is required to make the switch from the old name to `"metadata": <json>`, but that affects only the field name in serialized format. In documentation and naming, an effort is made to add enough warning signs around TimelineMetadata so that it will receive no changes in the future. We can add those fields to `IndexPart` directly instead. Additionally, the path to cleaning up `metadata.rs` is documented in the `metadata.rs` module comment. If we must extend `TimelineMetadata` before that, the duplication suggested in [review comment] is the way to go. [review comment]: #7699 (review)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Currently we serialize the
TimelineMetadata
into bytes to put it intoindex_part.json
. ThisVec<u8>
(hopefully[u8; 512]
) representation was chosen because of problems serializing TimelineId and Lsn between different serializers (bincode, json). After #5335, the serialization of those types became serialization format aware or format agnostic.We've removed the pageserver local
metadata
file writing in #6769.Summary of changes
Allow switching from the current serialization format to plain JSON for the legacy TimelineMetadata format in the future by adding a competitive serialization method to the current one (
crate::tenant::metadata::modern_serde
), which accepts both old bytes and new plain JSON.The benefits of this are that dumping the index_part.json with pretty printing no longer produces more than 500 lines of output, but after enabling it produces lines only proportional to the layer count, like:
This is an alternative to #7663, which still uses the
Vec<u8>
idea, but this time with mixed bincode+json instead of just bincode.In the future, I propose we completely stop using this legacy metadata type and wasting time trying to come up with another version numbering scheme in addition to the informative-only one already found in
index_part.json
, and go ahead with storing metadata or feature flags on theindex_part.json
itself.#7699 is the "one release after" changes which starts to produce metadata in the index_part.json as json.