docs(runner): document what the Loki browser tenant holds - #385
Merged
Merged
Conversation
… notes Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
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.
Context
Two runner docs described the browser telemetry path incorrectly, and one operator-facing fact was missing. run-and-deploy.md said the only demo-runtime Loki line is the Tier-1 compile failure, but
emitCollapsedDemoEventinapps/authoring/src/sentry.tsfiles every collapsed report as a handled Faro exception, which lands in Loki. observability-contract.md §6 carried a "scope note, not yet fixed" saying lite vitals are still stored, butlite.tsalready stores a record only fort:"err"andfaro.tsalready setsstoreRecord = falsefor measurements andexample.*events. This PR fixes both and adds a paragraph on what the Lokibrowsertenant actually holds, the consequence (a healthy demo produces no Loki lines until something throws, and drain timing means a new error can wait for the next wake), a safe way to force a probe line, and the Explore gotcha that the Analytics Engine ClickHouse datasource needs Format As = Table.Types of changes
runner/) changeHow was this verified?
Docs only. Every statement was checked against the code:
apps/authoring/src/sentry.ts(collapsed demo events calltelemetry.error),workers/o11y/src/lite.ts(storeRecord = body.t === "err"),workers/o11y/src/normalise/faro.ts(measurement andexample.*paths setstoreRecord = false; logs and other events store a record),workers/o11y/src/box.ts(sleepAfter = "15m"),workers/o11y/src/index.ts(cron wake at oldest inbox key over 1 h or backlog over 64 MB), andpackages/runtime/src/telemetry/inbox.ts(60 s pack interval). The forced-error path toLoki (browser)under{service_name="demos-authoring"}was also observed in production.Checklist
runner/config/frameworks.json(see CONTRIBUTING.md); otherwise it won't appear on demos.handsontable.compnpm build(andpnpm dev) in the affected example/server-example locallyNone of the checklist items apply: no example was added, renamed or changed, only two markdown files under
runner/docs/.Related issue(s):
None.
Note
Low Risk
Documentation-only changes under
runner/docs/; no runtime, ingest, or deploy behavior is modified.Overview
Updates runner observability docs so they match current ingest behavior and give operators clearer Grafana guidance.
In
observability-contract.md, the stale “lite vitals still store a Loki record” note is replaced:POST /telemetry/litenow documents the same rule as Faro—onlyt:"err"gets a Loki record;t:"vital"is hash-only for Analytics Engine dedupe.In
run-and-deploy.md, demo-runtime logging is corrected: collapsed preview errors land in Loki viaemitCollapsedDemoEvent(handled Faro exceptions with fingerprint-shaped messages), not only Tier-1 compile failures. New sections spell out what the Lokibrowsertenant contains (exceptions/logs/non-example.*events vs AE-only measurements/metrics/lite vitals), why a healthy demo may show no Loki lines, how to force a probe line, the AE Explore “Format As = Table” gotcha, and wake/drain latency plus cron backlog wake thresholds.Reviewed by Cursor Bugbot for commit cbba141. Bugbot is set up for automated code reviews on this repo. Configure here.