{% extends "documentation/base.html" %} {% block doc_content %}

Overrides & Exceptions

Configure override rules to automatically handle known issues, expected warnings, and special backup scenarios.

Overview

Overrides are rules that modify how BackupChecks interprets backup job results. They allow you to handle known issues or expected warnings without manually reviewing every occurrence.

Common use cases:

Accessing Overrides

To manage overrides:

  1. Navigate to Overrides in the main navigation menu
  2. Available to Admin, Operator, and Viewer roles
  3. Viewers can see override rules but cannot create, edit, or delete them
  4. Operators can create and edit overrides, but cannot delete them
  5. Admins have full access to all override operations

Override Levels

Overrides can be created at two levels:

1. Global Override

Applies to all jobs matching specific criteria:

Global overrides are useful for handling issues that affect multiple jobs across multiple customers.

2. Object-Level Override

Applies to a specific job or specific object within a job:

Object-level overrides are more precise and are checked before global overrides.

Override Match Criteria

In addition to level (global or object), overrides can match specific conditions:

Status Match

Match only runs with a specific status:

Most overrides match "Warning" or "Failed" to handle known issues with those statuses.

Error Text Match

Match based on error or warning message content:

Match Type Description Example
Contains Error message contains the specified text (case-insensitive) "Retry" matches "Backup retry succeeded"
Exact Error message exactly matches the specified text "Retry succeeded" only matches that exact phrase
Starts with Error message starts with the specified text "Retry" matches "Retry succeeded" but not "Backup retry"
Ends with Error message ends with the specified text "succeeded" matches "Retry succeeded"

Leave the error text field blank to match any error message (or no error message).

Override Actions

Treat as Success

The primary action for overrides is Treat as success (enabled by default):

This allows you to visually differentiate between:

Override Time Windows

Overrides can be time-limited using the From and Until fields:

From Date (Start Date)

Until Date (End Date)

💡 Retroactive Application:
When you create an override without a start date, it is applied retroactively to existing unreviewed runs. This means jobs that match the override will immediately show the "Treat as success" status in Daily Jobs, even if they ran before the override was created.

Creating Overrides Directly From Run Checks

The fastest way to create an override is from the run you are reviewing. After clicking Mark as Success in the Run Checks modal, a follow-up dialog "Apply override for future runs?" appears with:

Broader overrides created this way are audit-logged with their scope, duration, and source run. This path covers most day-to-day use cases without ever opening the Overrides page.

Creating an Override (Overrides Page)

To create a new override:

  1. Navigate to the Overrides page
  2. Fill in the "Add override" form at the top:
  3. Click Save override
  4. The override is immediately applied to matching job runs
💡 Always Add Comments:
Use the Comment field to document ticket numbers, reasons, or planned resolution dates. This helps other operators understand why the override exists and when it should be removed.

Managing Existing Overrides

The "Existing overrides" table shows all configured overrides with the following columns:

Editing an Override

  1. Click the Edit button on an override row
  2. The "Add override" form is pre-filled with the existing values
  3. Modify any fields
  4. Click Save override to update
  5. Click Cancel edit to discard changes and clear the form

Disabling/Enabling an Override

  1. Click the Disable button on an active override
  2. The override is marked as inactive and stops affecting job runs
  3. Click Enable to reactivate it

Disabling is useful when you want to temporarily stop an override without deleting it (e.g., to test if an issue is resolved).

Deleting an Override (Admin Only)

  1. Click the Delete button on an override row
  2. Confirm the deletion
  3. The override is permanently removed
  4. Existing runs that were affected by the override remain unchanged
⚠️ Deletion is Permanent:
Deleted overrides cannot be recovered. If you're unsure, disable the override instead of deleting it.

Override Evaluation Order

When a job run is evaluated, overrides are checked in the following order:

  1. Object-level overrides: Most specific overrides are checked first (job + object name)
  2. Job-level overrides: Overrides for the specific job (without object name)
  3. Global overrides: Least specific overrides are checked last

The first matching active override is applied. If multiple overrides match, only the most specific one takes effect.

Common Override Scenarios

Scenario 1: Veeam Retry Warnings

A Veeam backup job frequently shows warnings like "Backup retry succeeded". This is acceptable - the job ultimately succeeded.

Solution: Create an object-level override:

Scenario 2: Planned Maintenance Window

A customer is performing server upgrades next week. Backup failures during May 15-17 are expected.

Solution: Create a time-limited override:

After May 18, the override automatically expires and failures will appear normally.

Scenario 3: Known Issue with One VM

One VM in a multi-VM backup job consistently fails with "Snapshot timeout". A ticket has been created with the customer.

Solution: Create an object-specific override:

Other VMs in the same job will still show failures normally.

Scenario 4: Global NAKIVO Replication Warnings

All NAKIVO replication jobs show harmless warnings about "Network latency detected". This is expected for remote sites.

Solution: Create a global override:

Best Practices

Troubleshooting

Override Not Applied to Job Run

If an override doesn't appear to affect a job run:

Override Applying Too Broadly

If an override is affecting more jobs than intended:

Multiple Overrides Conflicting

Only one override is applied per run (the most specific match). If you have both global and object-level overrides that match:

Next Steps

{% endblock %}