Repository navigation
docs: add the UI Capture and capture loss guides; state arm64's 6.4 kernel floor - #923
Merged
Merged
Conversation
…hots How to set up UI capture from the dashboard, the REST API or an AI agent over MCP; the SDK's options and what it records and masks; capture states; reading flows and what an agent's view leaves out; limitations and troubleshooting. Screenshots come from the end-to-end test of the flow. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
Keploy's eBPF capture (keploy record --low-latency, a Kubernetes Sidecar with low_latency_mode, and the DaemonSet agent) warns when an app moves bytes it cannot record: sendfile, splice, io_uring registered buffers, MSG_TRUNC. The new guide quotes the warning, the periodic report and the startup warnings that some losses will go unmarked, explains every field, and gives each cause a section with the setting that avoids it (nginx, Apache, Tomcat, gunicorn, aiohttp, HAProxy, Java, Go). Each section has an explicit heading ID, which the agent's docs field links to (keploy/enterprise#2636), so keep the IDs when the page is edited or a new docs version is cut. The troubleshooting guide points to it. That capture needs fentry/fexit, which arm64 kernels attach only from 6.4 (x86-64 from 5.10). The platform requirements said 5.10 for everything and the Kubernetes quickstart said nothing, so an arm64 node on, for example, Amazon Linux 2's 5.10 or AL2023's 6.1 looked supported for low-latency recording and the DaemonSet. Both now say so (the quickstart's mode table gains a node kernel row), and what to use there instead. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
slayerjain
force-pushed
the
docs/ui-capture
branch
from
October 7, 2026 06:54
6e5b69d to
7b23fe3
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.
Two changes, one commit each.
1. UI Capture guide
A new page, UI Testing → UI Capture (
versioned_docs/version-4.0.0/running-keploy/ui-capture.md), covering:Why: a customer asked how to create the
ui:ingestkey the capture SDK needs. Nothing documented it, and until now nothing in the product let them do it.Accuracy:
tests/projects/ui-testing/ui-capture-e2e.spec.ts, docs mode). They were taken on a local deployment, which the page says.2. Capture loss warnings guide, and arm64's 6.4 kernel floor
A new page, Capture loss warnings (
running-keploy/capture-loss.md), for the warning Keploy's eBPF capture logs when an app moves bytes without copying them through its own memory:--low-latency, a Sidecar withlow_latency_mode, and the DaemonSet.MSG_TRUNC, and a page the hook could not read. Each section gives the setting that avoids it (nginx, Apache, Tomcat, gunicorn, aiohttp, HAProxy, Java, Go).{#sendfile}, …). The agent'sdocsfield links to them (keploy/enterprise#2636), so keep these IDs when the page is edited or the next docs version is cut.Every quoted line, field and level is checked against the agent's code, and every Go claim against the Go 1.27 standard library.
It also fixes a gap that affects users: that capture needs eBPF hooks arm64 kernels support only from 6.4 (x86-64 from 5.10). The platform requirements said 5.10 for everything, and the Kubernetes quickstart said nothing, so an arm64 node on Amazon Linux 2's 5.10 or AL2023's 6.1 looked supported. Both pages now say so, and what to use there instead; the quickstart's mode table gains a node kernel row.
Checks
npm run build: passes,onBrokenLinks: throw, no broken anchors. All seven anchors the agent links render.npm run verify-schema: passes.prettier@2.8.8 --check: clean on every changed file.Merge order