Glossary¶
The terms DV Forge uses in the app, the API and this guide, in alphabetical order. Each entry links to the page that covers it in depth.
- Activity
- The timeline on a signature's page: sightings in regressions, triage changes, rule actions, merges and splits, newest first. Each entry names who made the change: a person, an API token, a rule, the root-cause agent, re-bucketing or the system. See Working a signature.
- Agent state
- How the latest root-cause run on a signature went: agent running, agent done or agent failed. It's shown next to the triage status but is separate from it: a finished run never changes the status by itself. See Runs and hypotheses.
- API token
- A secret starting with
dvf_that lets a machine, usually CI, call DV Forge. It belongs to one project and has the scoperead(acts as a viewer) oringest:write(acts as a member). See Projects, roles and tokens. - Assignee
- The one person who owns a signature. Being assigned makes you a watcher, and you're notified unless you assigned yourself. Assignees must be members of the project's organization.
- Attachment
- A file added to a signature, such as a screenshot, waveform capture or note. Up to 10 MB each. Images and PDFs must really be what they claim to be; files a browser would render or run are stored as plain downloads.
- Bucketing
- Grouping failures into signatures by their fingerprint. Each project has its own bucketing settings. See Bucketing settings.
- Bucketing version
- The version of the bucketing engine a signature's key was computed with, shown as "bucketing v3" on the signature page. When DV Forge upgrades the engine, it re-buckets each project; signatures keep their identity, status and history.
- Bug reference
- A key or URL from your bug tracker, up to 512 characters, linked to a signature. Linking one moves an open signature to Tracked.
- Classification
- What kind of problem a signature is: RTL, DV, Infra, Tool or Unclassified. DV Forge guesses it automatically; a person or a triage rule can set it. Rules never override a classification a person chose.
- Closure %
- The share of live signatures that are done: (Resolved + Not a bug + Waived) divided by all live signatures. Live means not merged into another signature and with at least one hit. Shown on the Triage page. See The triage queue.
- Data plane
- An optional service you run in your own network. It receives uploads, keeps raw logs, forwards structured results, redacted excerpts and headlines to DV Forge, and connects out only. See Data planes.
- Duplicate suggestion
- Signatures DV Forge thinks are the same bug, listed under Possible duplicates on a signature's page. Accepting one merges the newer signature into the older. See Merge, split and suggestions.
- External id
- The stable id you give a regression when you upload it, usually the CI build id
(
--external-id). Uploading again with the same id updates the same regression instead of creating another. - Failure
- A simulation job that didn't pass: status
fail,error,timeoutorkilled. Each failure is filed under exactly one signature. See Regressions and failures. - Fingerprint
- The key computed from a failure's headline after masks blank out the parts that vary from run to run. Failures with the same fingerprint, under the same bucketing version, land in the same signature. See also signature key.
- Headline
- The one message a failure is bucketed by: the first message at the highest severity (error or fatal) in its log. When the log has none, DV Forge uses the uploader's one-line failure message, else an error line, else the end of the log. On a project with a data plane, headlines are redacted before DV Forge stores them. See Simulators and log formats.
- Hit
- One failure in a signature. Hits on a signature's page counts them across the whole project; Regressions counts the regressions they came from.
- Hypothesis
- What a finished root-cause run proposes as the cause of a signature. While it waits for a decision, the signature shows Root-cause hypothesis ready; a triager selects Confirm root cause to move it to Root-caused, or a rule on the "A root-cause run finishes with a hypothesis" trigger does it. See Runs and hypotheses.
- Label
- A project-wide tag (name up to 64 characters, optional color) you put on signatures to group them. Rules can add labels, and filters can select on them.
- Landing project
- The project you get when none is selected:
defaultin your oldest organization, else that organization's first project alphabetically. - Live regression
- A regression that's still receiving uploads. A regression is
live,completeoraborted. The CLI completes it at the end of an upload unless you pass--no-complete. See Regressions and failures. - Mask
- A pattern (a case-insensitive regular expression) in a project's bucketing settings. Whatever it matches is blanked out before fingerprinting, so values like addresses or ids don't split one bug into many signatures. Up to 20 masks per project. See Bucketing settings.
- Merge
- Combining one signature into another. The merged signature is hidden from lists, and its failures and future hits count toward the surviving one. Unmerge undoes it. See Merge, split and suggestions.
- Muted
- A parked status: the signature drops out of the default triage queue, either until a time you choose (then it returns to Untriaged) or until someone reopens it.
- Normalized template
- The text every failure in a signature reduced to after normalization, shown under Normalized template on the signature page.
- Not a bug
- A closed status for expected behavior or a test artifact. It counts as done for closure %.
- Open status
- Untriaged, Investigating, Root-caused, Tracked and Regressed: the statuses that are still being worked on. The triage queue shows these by default.
- Organization
- Your company's account. People have one role per organization, and it applies to every project in it. See Projects, roles and tokens.
- Project
- The container for results: regressions, signatures, labels, rules, saved searches and API tokens belong to one project. See Projects, roles and tokens.
- Project ref
- A project's full name,
org-slug/project-slug, passed to the API as?project=and to the CLI as--projectorDVFORGE_PROJECT. - Re-bucketing
- Recomputing every failure's fingerprint in a project, after a change to its masks or an engine upgrade. Signatures follow their bug through a re-bucket, keeping their id, status and root-cause run. See Bucketing settings.
- Recurrence
- A signature's hit that comes after an absence: a complete regression on the same branch ran since its previous sighting without hitting it. Recurrences are counted (the recurred badge and the Recurrences card) and can trigger rules, but they don't change the status. Compare regressed.
- Regressed
- The status DV Forge sets when a Resolved signature is hit in a regression that started after it was resolved. Its assignee and watchers are notified. Only the system sets it; nobody can choose it. Older regressions uploaded late don't count.
- Regression
- One run of your regression suite, uploaded as a unit and identified by its external id. See Regressions and failures.
- Role
- What a person may do in an organization: viewer, member, triager, project_admin or org_admin, each including the ones before it. See Permissions.
- Rule
- A project's triage automation: when a trigger fires for a signature that's in the rule's scope and matches its match filter, the rule runs its actions. Enabled rules run in order. See Triage rules.
- Rule action
- What a rule does to a matching signature: Set status, Assign, Classify, Add label, Link bug (tracks it), Notify or Run the root-cause agent, up to 10 per rule. Rules can't waive a signature or set Regressed, and they reach Tracked only through Link bug. Run the root-cause agent runs at most 10 times per rule in any 24 hours.
- Rule match
- An optional filter (Conditions in the rule editor,
matchin the API), in the filter language, that a signature must match for the rule to act. It can't refer to "me", because rules don't run as a person. - Rule run log
- The record of every time a rule matched a signature: the trigger, and whether each action was applied, skipped (nothing to change, or not allowed) or failed. See Triage rules.
- Rule scope
- Which signatures a rule considers: regressions on certain branches (names or glob patterns, up to 50), signatures in a shared saved search, or both. No scope means everything in the project.
- Rule trigger
- The event that makes a rule look at a signature: A new signature appears, A signature is hit again, A signature comes back after an absence, A resolved signature regresses, A root-cause run finishes with a hypothesis or A regression finishes.
- Run
- One investigation by the root-cause agent, started with Run root-cause, New run or a rule. A run is submitted, running, complete or failed. See Runs and hypotheses.
- Saved search
- A named filter on signatures, private to you or shared with the project. Rules can scope to shared saved searches. See The triage queue.
- Scenario
- A built-in design and failure that the root-cause agent can investigate, listed on the Scenarios page. See Root-cause agent.
- Signature
- A project-wide group of failures with the same fingerprint: one distinct failure across tests, seeds and regressions. Signatures are what you triage. See Signatures.
- Signature key
- A signature's fingerprint, 16 hexadecimal characters, shown in the signature page's header. Signatures created by a split get a key of their own.
- Simulation job
- One test with one seed in a regression, with a status (
pass,fail,error,timeout,killedorskipped) and, optionally, a log. See Regressions and failures. - Split
- Moving the failures whose error line contains some text (case-insensitive, not a regular expression) out of a signature into a new one. Future hits that match follow the split. See Merge, split and suggestions.
- Spool
- A data plane's on-disk queue. If DV Forge is unreachable during an upload, the data plane queues job batches and the completion, answers the CLI with success, and forwards them in order once DV Forge is back. See Data planes.
- Stop processing
- A rule setting: once the rule matches a signature, later rules skip that signature for the same event.
- Triage queue
- The Triage page: signatures in open statuses by default, with summary counts, filters, saved searches and bulk actions. See The triage queue.
- Triage status
- Where a signature is in its lifecycle: Untriaged, Investigating, Root-caused, Tracked, Resolved, Regressed, Muted, Not a bug or Waived. See Triage.
- Waiver
- The Waived status: a failure accepted for sign-off, with a required reason, an approver with the project_admin role, and an optional expiry, after which the signature returns to Untriaged. It counts as done for closure %. Rules can't waive.
- Watcher
- Someone who hears about a signature: they're notified when it regresses, when a root-cause run on it finishes or fails, and when a rule notifies watchers. Select Watch on a signature to watch it; commenting or being assigned also makes you a watcher. See Notifications.