docs(design): distribution model — common library + per-platform custom build - #217
Merged
Merged
Conversation
…orm custom build Add a §1 paragraph and a §7.4 three-tier classification to make ASAP's distribution model unambiguous. Previously the doc said "no drop-in plugin ABI" but didn't distinguish between "custom build" (use upstream's official extension point + ASAP crate, no patches) and "hard fork" (divergent code base maintained against upstream). Three tiers: 1. Drop-in plugin — what ASAP would prefer; no platform supports it for stateful + scheduled plugins. 2. Custom build — ASAP's actual model on all four platforms. Use OCB / build tags / inventory::submit! / linkme. 3. Hard fork — only modified-OTLP needs this; Strategy B eliminates the need on the other three. Goal explicit in §1: Layer 3 (asap-precompute-go / -rs) is THE common data-plane library; Layer 4 adapters are thin glue. Every per-platform distro (sketchcollector / sketchtelegraf / sketchvector / sketchotap) shares the same Layer 3 implementation. This framing matches the Datadog Agent / Elastic Beats / Splunk Universal Forwarder distribution model and avoids re-implementing window scheduling, snapshot caches, and delta encoding per distro. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
zzylol
force-pushed
the
docs/design-distribution-model-clarification
branch
from
May 2, 2026 04:01
a8eedab to
7defe08
Compare
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
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.
Summary
Follow-up to #216 (now merged). Clarifies ASAP's deployment model: the doc previously said "no drop-in plugin ABI" but didn't distinguish between custom build (use upstream's official extension point + ASAP crate, no source patching) and hard fork (maintain a divergent branch). Reviewers reading "fork-or-vendor" were liable to assume the worst.
Changes
§1 Motivation — explicit goal
§7.4 — three-tier classification
Why this framing matters
Layer 3 is the load-bearing reusable artifact. Every per-distro build links the same Layer 3 binary code. Without that goal stated explicitly, the four distros risk re-implementing window scheduling / snapshot caches / delta encoding per platform — the exact fragmentation this framework prevents.
Industry parallel: Datadog Agent, Elastic Beats, Splunk Universal Forwarder. All ship vendor-repackaged distros with first-party plugins compiled in.
Stats
`docs/design-asap-edge-framework.md`: +81 / −13 lines.
Test plan