Docs/Issues
#

Issues

export const meta = { title: 'Issues', description: 'Reference for how Canary tracks, organizes, and helps you investigate issues found during automated testing.', tags: ['reference', 'issues'], };

Issues are problems discovered by Canary during automated testing. Each issue represents a potential bug, broken functionality, or user experience problem found on your web application.

01Issue Lifecycle

Issues follow a simple workflow:

  1. Open - Newly discovered issue awaiting review
  2. Fixed - The issue has been addressed in your application
  3. Verified - Canary has confirmed the fix works
  4. Closed - Marked as not-a-bug or won't fix

When Canary creates a new issue, it can also automatically create a follow-up task. This happens at issue creation time, so your team can move directly from a new finding into investigation without creating a separate task by hand. In triage views, the task appears as part of the issue's follow-up context so you can open the issue, review the evidence, and jump straight into the linked tasking workflow.

The follow-up task is part of Canary's tasking system, so you can use it to track next steps, assign investigation work, and continue from discovery to resolution in one flow. For more about working with tasks, see /docs/reference/tasks.

Issue with automatically created follow-up task

When you resolve an issue by moving it to Fixed, Verified, or Closed, Canary automatically removes any related follow-up task. This keeps follow-up work aligned with the issue status and prevents stale outstanding tasks from lingering after the issue is no longer active.

You can also archive issues to remove them from the default view without deleting them.

02Severity Levels

Issues are automatically assigned a severity based on their impact:

SeverityDescription
CriticalApplication crashes, data loss, or security vulnerabilities
HighMajor functionality broken, blocking user workflows
MediumPartial functionality issues, workarounds available
LowMinor cosmetic issues, edge cases

03Issue Categories (Labels)

Admins can create custom categories to organize issues by team, feature area, or type. Categories help route issues to the right people and track patterns.

To manage categories, go to Settings > Issue Labels.

Evidence & Reproduction

Each issue includes evidence to help you understand and reproduce it:

  • Screenshots - Visual capture of the full visible UI state at the moment feedback or a failure was captured, including overlays such as modals and drawers when they were on screen
  • Browser traces - Network requests, console logs, and timing data
  • Steps to reproduce - The exact actions that triggered the issue
  • Environment details - Browser, viewport, and test configuration
  • Follow-up task - An automatically created task when issue follow-up is enabled, so you can move from evidence review into investigation immediately

Review the evidence first. Check the screenshot to confirm the exact screen state Canary captured, including any open modal, drawer, or other overlay that may have affected the user's path when the issue was reported.

Issue feedback screenshot showing a modal overlay

Then use the linked follow-up task to capture ownership, track investigation, and document what happens next. This helps you keep reproduction details and investigation work connected in the same workflow.

05Reviewing issue details

Open an issue to review its evidence, reproduction steps, and linked pages in one place. Use the captured URL as a starting point, then compare it with the screenshot and steps to understand the exact app state Canary recorded.

If the captured issue URL is relative, open the linked page directly from the issue detail view. Canary resolves relative links correctly, so the page still opens in the right place without requiring you to rebuild the full URL yourself.

When you navigate from the issue to the linked page, use the issue evidence to confirm you are back in the same flow. Check the screenshot, visible overlays, and reproduction steps before you continue investigating.

06Comments

Use comments to capture investigation details, ask questions, and coordinate next steps directly on the issue.

Write comments in the richer editor so you can draft longer updates more comfortably and format your notes before posting.

Issue comment editor with mention suggestions

Type @ in a comment to mention a teammate. Canary suggests matching members as you type, highlights mentions clearly in the thread, and sends an email notification to each mentioned teammate.

Rendered @mention in an issue comment thread

Use mentions when you need input from a specific teammate, want to pull an owner into triage, or need to flag a follow-up directly from the issue discussion.

07Filtering Issues

Use the filters at the top of the issues page to narrow down:

  • Severity - Filter by critical, high, medium, or low
  • Status - Show open, fixed, verified, or all issues
  • Property - Filter by which property (website) the issue was found on
  • Category - Filter by custom labels
  • Credential - Filter by which login context was used
  • Date range - Filter by when the issue was last seen
  • Search - Full-text search across issue titles and descriptions

Use links in the issues list or issue detail view to open the affected page quickly. Open the linked page when you want to verify the current app state, compare it with the recorded evidence, or continue investigation from the exact location Canary captured.

If the issue shows a relative URL, use the link as-is. Canary resolves relative links correctly from both the issues list and the issue detail view, so the destination page can still open correctly even when the captured URL is not a full absolute address.

After the linked page opens, use your browser back button or return to the issue to keep triage moving. This helps reduce confusion when you move between the source page and the issue evidence during investigation.

09Bulk Actions

Select multiple issues to perform bulk actions:

  • Archive - Remove from default view
  • Export - Download as CSV for reporting

10Jira Integration

If you've connected Jira, you can create tickets directly from issues. The Jira ticket will be linked to the Canary issue and kept in sync.

See Jira Integration for setup instructions.

11Collaboration and triage

Use issue comments and follow-up tasks together to keep triage decisions visible in one place. Review the evidence, leave context in the thread, and mention the teammates who need to weigh in before you move work forward.

For active investigation, open the linked follow-up task from the issue and use the comment thread to capture decisions, handoffs, and status updates. When you resolve the issue, Canary automatically removes the related follow-up task so your team does not have to clean up completed investigation work separately.

12Best Practices

  1. Triage regularly - Review new issues daily to catch problems early and act on automatically created follow-up tasks while context is fresh
  2. Use follow-up tasks for investigation - Move from the issue into the linked task to assign work, track investigation, and keep next steps visible
  3. Use categories - Organize issues by team or feature for better routing
  4. Verify fixes - Run tests after deploying fixes to confirm resolution
  5. Archive, don't delete - Keep a record of past issues for trend analysis