Open Bug 2077147 Opened 1 month ago Updated 2 days ago

Document flows in the Glean book

Categories

(Data Platform and Tools :: Glean: SDK, enhancement, P2)

enhancement

Tracking

(Not tracked)

People

(Reporter: travis_, Assigned: travis_)

References

(Blocks 1 open bug)

Details

Attachments

(1 external file)

  • A flows.yaml reference page: every field, the validation rules, and what each warning means.
  • Which tasks are worth modeling as a flow: bounded tasks with a clear start and outcome, not routine interactions.
  • Testing a flow without an API: check membership with testGetValue on a member event, check termination through glean.flow_end, and check that an unrelated event has no flows entry.
  • How to test an event defined in a separately built library, which is how a real cross-library reference is told apart from a typo.
  • Cost: what matters is instances per session. A flow opened per page load or per tab noticeably increases how often the events ping is sent.
  • Analysis guidance from the "Reading Flow Data" section of the proposal, or a link to wherever it's published: computing duration from tagged events, not flow_end; spotting conflated instances; instances with no entry event; and the two different ways to count instances.
  • The flows_enabled remote settings override, and the warning about disabling a flow's boundary events through metrics_enabled.
Blocks: 2077127
Assignee: nobody → tlong
Priority: P3 → P2

(via GitHub webhook, authenticated as shared-secret)

You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: