docs(rfc-0003): reconcile §6.4 — canonicalisation happens at ingest, not Parquet-write time - #174
Conversation
…not Parquet-write time Maintainer-decided 2026-06-10 reconciliation of RFC 0003 to the merged implementation: the miner's ingest_structured encodes the AnyValue the receiver delivered (Ourios canonical body encoding, RFC 0001 §6.1) at ingest; the Parquet writer persists the bytes verbatim (RFC 0005 §3.3). Amends §6.4 with a dated note, rewrites the three-point rationale (inner-field optionality is preserved because the miner receives the decoded tree), and updates the residual write-time claims in §1, §2.2, RFC0003.6, §7.5, and the §9 resolved entry. Doc-only; status unchanged. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 17 minutes and 52 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Pull request overview
Updates RFC 0003 to accurately describe the implemented location of AnyValue canonicalisation (performed once in ourios-miner at ingest) and reconciles remaining references that previously claimed canonicalisation was deferred to Parquet-write time.
Changes:
- Amend §6.4 to state canonicalisation happens at ingest in the miner, preserving historical amendment notes while adding a new dated amendment record.
- Update related references in §§1, 2.2, RFC0003.6, §7.5, and §9 so they no longer imply write-time/storage-layer canonicalisation.
- Preserve historical evaluation text while marking previously reached conclusions as superseded by the merged implementation.
Comments suppressed due to low confidence (1)
docs/rfcs/0003-otlp-receiver.md:972
- Section 7.5(a) currently reads as both “Rejected” and “implemented design,” which is internally contradictory and can confuse readers skimming the alternatives. Consider rephrasing (a) as a historical evaluation that is now implemented, and drop the separate “Superseded … implemented design” line to avoid the contradiction.
**(a) Canonicalise in the miner.** **Rejected** because the
miner's hot path benefits from a constant-time write in the
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
What
Doc-only RFC amendment reconciling RFC 0003 §6.4 with the merged implementation, per the inconsistency flagged on #166/#167 and the maintainer decision of 2026-06-10. No code, no
statuschange.§6.4 claimed structured-body canonicalisation "happens once, at Parquet-write time" / "is deferred to the storage layer." The merged code disagrees:
ourios-miner'sMinerCluster::ingest_structuredencodes theAnyValuethe receiver delivered viaourios_core::otlp::canonical::encode_any_valueat ingest and stores the bytes inMinedRecord.body; the Parquet writer persists them verbatim (RFC 0005 §3.3). RFC 0001 §6.1/§6.2 and RFC 0005 §3.3 were already aligned in #166; §6.4 was the last spot still claiming write-time.Changes (all in
docs/rfcs/0003-otlp-receiver.md)> Amendment 2026-06-10blockquote (mirroring the docs(rfc-0001): pin the structured-body canonical encoding as an ourios-local rule #166 amendment style) noting the prior text predated the implementation. The historical first-amendment blockquote is preserved. The three-point rationale is rewritten; what was already true stays: the receiver never canonicalises, and the miner's step-0 short-circuit dispatches on the discriminator alone before any encode.AnyValue; no transport knowledge needed in the miner). Original evaluation text preserved as the record, with superseded-markers.Untouched because still true: §6.1 step 3, §6.2 ("no separate canonicalisation pass" at the HTTP decode), §6.5 step 2, §6.6 amendment note, RFC0003.7, and the
Body::Stringpass-through paragraph. RFC 0001 / RFC 0005 grepped for residual write-time claims: none found (the "OTLP-canonical severity+scope key" line in RFC 0001 is unrelated and untouched).The preserved-optionality argument
The original write-time rationale was "optionality for a future mine-inner-fields mode." That optionality is not lost by ingest-time encoding: the receiver still hands
Body::Structured(AnyValue)through verbatim, andingest_structuredreceives the decoded tree — exactly where an inner-field-mining mode would hook in. Only the stored form is the canonical bytes; the encode point sits after any future inner-field hook, so no option is foreclosed. Meanwhile "single canonicalisation pass" and "miner hot path unchanged" hold either way (one encode per structured record regardless of which layer pays; step-0 dispatch reads only the discriminator), and moving the code to write-time would reworkMinedRecord, the §6.9 snapshot serialisation, the §6.6 render, and their tests — churn purchased for a mode with no RFC and no named consumer.Invariants / hazards
Touches the spec text around
[§3.3](body reconstruction) and hazard H7 only by describing the implemented behaviour more accurately — thestored_bytes ↔ AnyValueround-trip guarantee and thelossy_flag = falsepromise are restated, not altered. No behaviour, schema, or test changes.Verification
mdbook buildclean (only the known benign mdbook-mermaid version warning).git statusshows onlydocs/rfcs/0003-otlp-receiver.md; doc-only, no cargo checks applicable.docs/rfcs/forwrite[- ]time/storage layer/canonicalis: every remaining hit in RFC 0003 is inside a historical amendment blockquote or an explicitly superseded-record passage.🤖 Generated with Claude Code