Link Search Menu Expand Document

Scan output in Soda Cloud

Last modified on 26-Jan-23

Soda Cloud displays the check results that each scan executed in the Checks Results dashboard.

There two methods through which a check result appears on the dashboard.

  • When you define checks in a checks YAML file and use Soda Core to run a scan, the check results manifest in the Checks Results dashboard in Soda Cloud.
  • Any time Soda Cloud runs a scheduled scan of your data as part of an agreement, it displays the check results in the Checks Results dashboard.

Log in to view the Checks Results dashboard; each row in the table represents the result of a check, and the icon indicates whether the test passed, warned, or failed.

check-results

Check results
Scan failed
Sending scan results to Soda Cloud
    Troubleshoot
Run an ad hoc scan
Go further

Check results

As a result of a scan, each check results in one of three default states:

  • pass: the values in the dataset match or fall within the thresholds you specified
  • fail: the values in the dataset do not match or fall within the thresholds you specified
  • error: the syntax of the check is invalid

A fourth state, warn, is something you can explicitly configure for individual checks. See Add alert configurations.

The scan results appear in your command-line interface (CLI) and, if you have connected Soda Core to a Soda Cloud account, in the Check Results dashboard in the Soda Cloud web application.

Soda Core 3.0.xx
Scan summary:
1/1 check PASSED: 
    dim_customer in adventureworks
      row_count > 0 [PASSED]
All is good. No failures. No warnings. No errors.
Sending results to Soda Cloud

monitor-results-incidents

Scan failed

Check results indicate whether check passed, warned, or failed during the scan. However, if a scan itself failed to complete successfully, Soda Cloud displays a warning message in the Datasets dashboard under the dataset for which scans have failed. Soda Cloud does not send an email or Slack notification when a scan fails, only when checks fail.

scan-failed


Sending scan results to Soda Cloud

Soda Core use a secure API to connect to Soda Cloud. When it completes a scan, Soda Core:

  1. securely gains access to Soda Cloud
  2. pushes the results of any checks you configured in the checks YAML file to Soda Cloud

scan-with-cloud

Troubleshoot

Problem: When running a programmatic scan or a scan from the command-line, I get an error that reads Error while executing Soda Cloud command response code: 400.

Solution: While there may be several reasons Soda returns a 400 error, you can address the following which may resolve the issue:

  • Upgrade to the latest version of Soda Core.
  • Confirm that all the checks in your checks YAML file identify a dataset against which to execute. For example, the following syntax yields a 400 error because the checks: does not identify a dataset.
checks:
    - schema:
        warn:
            when schema changes: any


Run an ad hoc scan

If you wish to run a scan immediately to see the check results for the checks you included in your agreement, you can run an ad hoc scan within the scan definition.

  1. In Soda Cloud, navigate to your avatar > Scans & Data, then access the Scan Definitions tab.
  2. In the list of scan definitions, click the one that you associated with the agreement you just defined.
  3. In the Scan Defintion page, click Run scan to immediately execute all agreements that use this scan definition.

Go further

Was this documentation helpful?

What could we do to improve this page?


Last modified on 26-Jan-23