Skip to content

docs(querier): finish #177's doc sweep — Ourios-canonical, not OTLP-canonical #333

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.

Sign up for GitHub

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

Merged
jensholdgaard merged 2 commits into from
Jul 2, 2026
Merged

docs(querier): finish #177's doc sweep — Ourios-canonical, not OTLP-canonical #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
215217e
docs(querier): finish #177's doc sweep — the codec is Ourios-canonica…
jensholdgaard Jul 2, 2026
f084efa
docs: complete the repo-wide Ourios-canonical sweep (miner + parquet)
jensholdgaard Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions crates/ourios-miner/src/cluster.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1738,7 +1738,7 @@ impl MinerCluster {
// per RFC §6.1 ("Always false when body_kind =
// Structured").
//
// `body` carries the RFC 0005 §3.3 OTLP-canonical-JSON
// `body` carries the RFC 0005 §3.3 Ourios-canonical-JSON
// encoding of the `AnyValue` — the bytes the writer
// stores in the §3.2 `body` column for structured rows.
// Two interlocking invariants prevent any fallback path
Expand Down Expand Up @@ -4391,13 +4391,10 @@ mod tests {
assert_eq!(rec.template_version, 1);
// RFC §6.1: Structured records always carry
// `lossy_flag = false`. The producer populates `body`
// with a stored representation of the structured value
// so `reconstruct()` returns what we stored, satisfying
// §3.3. Today that representation is the AnyValue's
// `Debug` form — an interim placeholder. The follow-up
// PR replaces it with OTLP-canonical JSON without
// changing the schema field or `lossy_flag`. See
// `ingest_structured` for the rationale.
// with the Ourios-canonical JSON encoding of the
// structured value (`ingest_structured` →
// `canonical::encode_any_value`), so `reconstruct()`
// returns what we stored, satisfying §3.3.
assert!(rec.separators.is_empty());
assert!(rec.params.is_empty());
assert!(
Expand Down
4 changes: 2 additions & 2 deletions crates/ourios-parquet/src/record_batch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
//! the declared schema.
//!
//! **`AnyValue` → canonical JSON.** RFC 0005 §3.3 mandates
//! OTLP-canonical JSON for the `attributes`,
//! Ourios-canonical JSON for the `attributes`,
//! `resource_attributes`, and (when `body_kind = Structured`)
//! `body` columns. Encoding goes through
//! [`ourios_core::otlp::canonical`], which wraps
Expand Down Expand Up @@ -345,7 +345,7 @@ impl Builders {

self.body_kind.append_value(body_kind_ordinal(r.body_kind)?);
// RFC 0005 §3.3: when `body_kind = Structured`, the
// body column carries OTLP-canonical JSON — the bytes
// body column carries Ourios-canonical JSON — the bytes
// the miner has already encoded via
// `ourios_core::otlp::canonical::encode_any_value` (the
// miner's `ingest_structured` writes them into
Expand Down
4 changes: 2 additions & 2 deletions crates/ourios-querier/src/compile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
//!
//! `service`, `resource.<k>`, and `attr.<k>` have **no dedicated column** in
//! the RFC 0005 schema: resource/log attributes are stored as a single
//! OTLP-canonical-JSON `Utf8` column (`resource_attributes` / `attributes`).
//! Ourios-canonical-JSON `Utf8` column (`resource_attributes` / `attributes`).
//! They compile to a substring/`LIKE` match against that JSON column using a
Comment thread
jensholdgaard marked this conversation as resolved.
//! needle built from the canonical `{"key":…,"value":{"stringValue":…}}`
//! shape — honest about the storage, not a column that doesn't exist. This is
Expand Down Expand Up @@ -595,7 +595,7 @@ fn field_name(field: &Field) -> String {
}

/// Compile an attribute equality (`service`/`resource.k`/`attr.k`) to a
/// substring `LIKE` over the OTLP-canonical-JSON column. Only `==`/`!=` on a
/// substring `LIKE` over the Ourios-canonical-JSON column. Only `==`/`!=` on a
/// string value is supported in this slice; the canonical encoding stores
/// string values as `{"key":"<k>","value":{"stringValue":"<v>"}}`, so an
/// exact key+string-value pair is matched by that JSON fragment as a `LIKE`
Expand Down
Loading