-
Notifications
You must be signed in to change notification settings - Fork 4
fix: Table-wide edge batching in the OpenGraph convert source - BED-9372 #70
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
Open
ktstrader
wants to merge
3
commits into
main
Choose a base branch
from
fix/BED-9372-table-wide-edge-batching
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # BED-9372 destination memory & part-size review | ||
|
|
||
| Satisfies acceptance criteria lines 235-237: end-to-end peak memory and part | ||
| sizes are reviewed against the destination's 1,000-item batch, and the result | ||
| is shown to stay bounded independently of total table cardinality without | ||
| creating unsupported upload artifacts. | ||
|
|
||
| ## Method | ||
|
|
||
| Four runs of `benchmarks/opengraph_batching_benchmark.py`, one-edge shape, | ||
| 4 input files, DLT 1.26.0, single load worker. Table-wide = the fix | ||
| (`batch_size=150`); baseline = pre-fix per-row wrapping (`batch_size=1`). Each | ||
| `opengraph_file` callback receives a DLT batch of up to 1,000 wrapper items and | ||
| flattens their relationship lists into one in-memory `edges` list, then writes | ||
| one JSON part. | ||
|
|
||
| ## Results | ||
|
|
||
| | Scale | Mode | Edge wrappers | Callbacks / Parts | Max rel/callback | Max bytes/callback | Peak RSS | Wall | | ||
| |------:|------|-------------:|------------------:|-----------------:|-------------------:|---------:|-----:| | ||
| | 100k | table-wide | 667 | 1 / 1 | 100,000 | 17.8 MB | 255 MB | 6.5s | | ||
| | 100k | baseline | 100,000 | 100 / 100 | 1,000 | 178 KB | 130 MB | 18.2s | | ||
| | 1M | table-wide | 6,667 | 7 / 7 | 150,000 | 27.0 MB | 1,257 MB | 41.7s | | ||
| | 1M | baseline | 1,000,000 | 1,000 / 1,000 | 1,000 | 180 KB | 132 MB | 111.8s | | ||
|
|
||
| All runs: `inner_relationships` = row count exactly, `normalized_dlt_items` = | ||
| edge wrappers, 0 warnings. | ||
|
|
||
| ## Per-callback / part bound | ||
|
|
||
| The maximum relationships in a single destination callback is bounded by | ||
|
|
||
| destination_batch_size (1,000 items) x source batch_size (150 edges) | ||
| = 150,000 relationships | ||
|
|
||
| This is confirmed empirically: the per-callback maximum is 100,000 at 100k rows | ||
| (the whole table is one sub-1,000-item callback) and rises only to **150,000** | ||
| at 1M rows — it does **not** track total cardinality. Max bytes/callback caps | ||
| at ~27 MB for a 150-edge-per-wrapper one-edge table and would not grow if the | ||
| table were 10M or 100M rows: a callback still holds at most 1,000 wrappers. | ||
|
|
||
| The written JSON part mirrors the callback, so max part size is bounded the | ||
| same way (27 MB uncompressed here). No part approaches a size that BloodHound / | ||
| OpenHound ingest cannot accept, and no new upload artifact is introduced — the | ||
| destination still emits one JSON part per callback exactly as before the fix. | ||
|
|
||
| ## Peak RSS | ||
|
|
||
| Peak RSS for the table-wide runs (255 MB -> 1.26 GB from 100k -> 1M) is **not** | ||
| caused by unbounded destination accumulation — that is capped at 150,000 | ||
| relationships / 27 MB per callback as shown above. It is DLT's extract/normalize | ||
| staging of the larger intermediate load files for the whole table. The baseline | ||
| runs stay flat (~130 MB) because each item is a tiny one-edge wrapper, so DLT's | ||
| per-item buffering is cheaper even though it produces 150x more items. | ||
|
|
||
| The RSS growth is therefore an extract/normalize characteristic of DLT's | ||
| file-staging pipeline, orthogonal to the batching fix and to the destination | ||
| callback bound. It is a known scaling cost of running the whole table through | ||
| one extract, not an unbounded destination leak. | ||
|
|
||
| ## Conclusion | ||
|
|
||
| - Destination per-callback and per-part memory is bounded by | ||
| `1,000 x batch_size` relationships (150,000 / ~27 MB here), **independent of | ||
| total table cardinality** — criterion lines 236-237 satisfied. | ||
| - No unsupported upload artifact is created; part count drops | ||
| (`ceil(N/batch_size)` callbacks vs `N`), part size stays well within ingest | ||
| limits, and the file layout is unchanged. | ||
| - Peak process RSS scales with DLT's whole-table extract/normalize staging, not | ||
| with the destination callback; if a hard RSS ceiling is later required, the | ||
| bounded lever is coordinating `batch_size` down or DLT's extract/normalize | ||
| file rotation — the destination itself is already bounded. | ||
|
|
||
| No coordinated source/destination batch-size change is required to keep the | ||
| destination bounded. `batch_size=150` with the destination's 1,000-item batch | ||
| keeps the per-callback maximum at 150,000 relationships / ~27 MB regardless of | ||
| table size. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| """Generic synthetic assets and input generation for the BED-9372 benchmark. | ||
|
|
||
| These assets are deliberately extension-agnostic (not Okta/SAML-specific) so the | ||
| benchmark exercises the shared opengraph source, per the ticket requirement to | ||
| use generic synthetic assets plus at least one non-Okta high-cardinality shape. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import gzip | ||
| import json | ||
| import math | ||
| from dataclasses import dataclass, field | ||
| from pathlib import Path | ||
|
|
||
| from openhound.core.asset import BaseAsset | ||
| from openhound.core.models.entries_dataclass import ( | ||
| Edge, | ||
| EdgePath, | ||
| Node as DNode, | ||
| NodeProperties as DNodeProperties, | ||
| ) | ||
|
|
||
|
|
||
| def _edge(idx: int, k: int = 0) -> Edge: | ||
| return Edge( | ||
| kind="BENCH_Relationship", | ||
| start=EdgePath(match_by="id", value=f"start-{idx}-{k}"), | ||
| end=EdgePath(match_by="id", value=f"end-{idx}-{k}"), | ||
| ) | ||
|
|
||
|
|
||
| class OneEdgeAsset(BaseAsset): | ||
| """High-cardinality zero-or-one-edge shape (e.g. membership/grant rows).""" | ||
|
|
||
| idx: int | ||
|
|
||
| @property | ||
| def as_node(self): | ||
| return None | ||
|
|
||
| @property | ||
| def edges(self): | ||
| return [_edge(self.idx)] | ||
|
|
||
|
|
||
| class MultiEdgeAsset(BaseAsset): | ||
| """A row emitting several edges, to stress inner-relationship growth.""" | ||
|
|
||
| idx: int | ||
| n: int | ||
|
|
||
| @property | ||
| def as_node(self): | ||
| return None | ||
|
|
||
| @property | ||
| def edges(self): | ||
| return [_edge(self.idx, k) for k in range(self.n)] | ||
|
|
||
|
|
||
| @dataclass | ||
| class _BenchNode(DNode): | ||
| id: str = field(default="") | ||
|
|
||
| def __post_init__(self): | ||
| self.id = f"node-{self.properties.name}" | ||
|
|
||
|
|
||
| class NodeAndEdgeAsset(BaseAsset): | ||
| """Node-bearing row that also emits one containment/ownership edge.""" | ||
|
|
||
| idx: int | ||
|
|
||
| @property | ||
| def as_node(self): | ||
| return _BenchNode( | ||
| kinds=["BENCH_Node"], | ||
| properties=DNodeProperties( | ||
| name=f"n{self.idx}", | ||
| displayname=f"Node {self.idx}", | ||
| environmentid="bench-env", | ||
| ), | ||
| ) | ||
|
|
||
| @property | ||
| def edges(self): | ||
| return [ | ||
| Edge( | ||
| kind="BENCH_Relationship", | ||
| start=EdgePath(match_by="id", value=f"node-n{self.idx}"), | ||
| end=EdgePath(match_by="id", value=f"end-{self.idx}-0"), | ||
| ) | ||
| ] | ||
|
|
||
|
|
||
| def _single_edge_row(idx: int, epr: int) -> dict: | ||
| """Row builder for shapes that emit exactly one edge per row. | ||
|
|
||
| These shapes cannot vary the edge count, so reject any edges_per_row other | ||
| than 1 rather than silently discarding it. | ||
| """ | ||
| if epr != 1: | ||
| raise ValueError( | ||
| f"edges_per_row={epr} is unsupported for single-edge shapes; use 1" | ||
| ) | ||
| return {"idx": idx} | ||
|
|
||
|
|
||
| # Maps a shape name to (asset model, row builder). The row builder returns the | ||
| # raw dict that read_jsonl will feed back into the model. | ||
| ASSET_SHAPES: dict[str, tuple[type[BaseAsset], object]] = { | ||
| "one_edge": (OneEdgeAsset, _single_edge_row), | ||
| "multi_edge": (MultiEdgeAsset, lambda idx, epr: {"idx": idx, "n": epr}), | ||
| "node_and_edge": (NodeAndEdgeAsset, _single_edge_row), | ||
| } | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
|
|
||
| def model_for_shape(shape: str) -> type[BaseAsset]: | ||
| return ASSET_SHAPES[shape][0] | ||
|
|
||
|
|
||
| def _write_gz(path: Path, rows: list[dict]) -> None: | ||
| path.parent.mkdir(parents=True, exist_ok=True) | ||
| with gzip.open(path, "wt", encoding="utf-8") as fh: | ||
| for row in rows: | ||
| fh.write(json.dumps(row) + "\n") | ||
|
|
||
|
|
||
| def write_synthetic_input( | ||
| input_dir: Path, shape: str, rows: int, edges_per_row: int, files: int | ||
| ) -> str: | ||
| """Write `rows` synthetic rows for `shape` across `files` .jsonl.gz files. | ||
|
|
||
| Returns the table (subdirectory) name used by the opengraph file_glob. | ||
| """ | ||
| model, row_builder = ASSET_SHAPES[shape] | ||
| table = model.__name__.lower() | ||
| per_file = math.ceil(rows / files) | ||
| written = 0 | ||
| for f in range(files): | ||
| count = min(per_file, rows - written) | ||
| if count <= 0: | ||
| break | ||
| batch = [row_builder(written + i, edges_per_row) for i in range(count)] | ||
| written += count | ||
| _write_gz(input_dir / table / f"part-{f:04d}.jsonl.gz", batch) | ||
| return table | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Provide the required edge properties.
src/openhound/sources/opengraph/entries.py:Edgedeclarespropertiesas a required field. This constructor omits it, so everynode_and_edgerow fails validation before the benchmark can serialize the record. Pass an appropriateEdgePropertiesvalue or use the existing project helper.🤖 Prompt for AI Agents