---
description: "Add Assertion Notes in DataHub Cloud Observe to document context, root causes, and resolutions for data quality assertion failures."
---

import FeatureAvailability from '@site/src/components/FeatureAvailability';

# Assertion Notes

<FeatureAvailability saasOnly />

> The **Assertion Notes** feature is available as part of the **DataHub Cloud Observe** module of DataHub Cloud.
> If you are interested in learning more about **DataHub Cloud Observe** or trying it out, please [visit our website](https://datahub.com/products/data-observability/).

## Introduction

The Assertion notes feature aims to solve two key use cases:

1. Surfacing useful tips for engineers to troubleshoot and resolve data quality failures
2. Documenting the purpose of a given check, and implications of its failure; for instance, some checks may circuit-break pipelines.

### For Troubleshooting

As you scale your data quality coverage across a large data landscape, you will often find that the engineers who are troubleshooting and resolving an assertion failure are not the same people who created the check.
Oftentimes, it's useful to provide troubleshooting instructions or notes with context about how to resolve the problem when a check fails.

- If the check was manually set up, it may be worthwhile for the creator to add notes for future on-call engineers
- If it was an AI check, whoever is first to investigate the failure may want to document what they did to fix it.

### For Documenting

Adding notes to Assertions is useful for documenting your Assertions. This is particularly relevant for Custom SQL checks, where understanding the logic from the query statements can be difficult. By adding documentation in the notes tab, others can understand exactly what is being monitored and how to resolve issues in event of failure.

<iframe width="516" height="342" src="https://www.loom.com/embed/a6cb07d33e8440acafacea381912f904?sid=32918cd5-9ebf-4aa0-90bc-37fae84d1841" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
