Atlan Instance Health Checks

What this pack contains

Fifteen tests that read an Atlan tenant and tell you whether it is working and well governed. They run on a data source built from the Atlan Data Source Template. Eleven are standard tests. Four are template tests that create one child test for every Atlan connection or data domain in the data source's catalog, so a new connection in Atlan gets its own freshness, owner and description checks after the next metadata ingestion.

Every test works the same way. It counts the issues it finds, returns that count, and passes at zero. A failing test prints the list of issues in its result and, where the runtime supports it, attaches the list as a CSV file, so you see the stale connection, the table with no owner or the dashboard still reading a deprecated table rather than only a number. Thresholds sit in a PARAMETERS block at the top of each script.

Every test name in Validatar starts with Atlan -, for example Atlan - No failed crawler runs. Child tests add the object's table name, such as Atlan - Metadata extraction current: Snowflake PROD [1700000001], and are placed in a folder named after their template test.

The standard tests are linked to the Ingestion Summary table of the Atlan object type they judge, and the child tests to the connection or domain table they check. The Validatar catalog for the Atlan data source therefore shows coverage and trust by object type and by object.

The last test watches the integration itself. If the publish step stops, Atlan keeps showing old scores, and this test is how you find out.

A check the integration's Atlan credentials may not run shows as Error, with a message naming what could not be read, rather than passing. A check with nothing to judge, such as owner coverage on a BI connection with no tables, passes with a note.

Where to get it

Marketplace: Atlan Instance Health Checks

Prerequisites

• An Atlan data source created from the Atlan Data Source Template, with Ingest Technical Metadata run at least once. The template tests select their objects from its Connection and Data Domain schemas.
• Atlan credentials whose personas cover the connections you want checked. API tokens not expiring soon and Owners are active users list API tokens and users, which needs an Atlan admin.
• pyatlan 11.4 in the Python that runs Validatar scripts, as described in the Atlan Data Source Template article.
• To try the pack without Atlan, turn on Demo Mode on the data source. The built-in sample tenant makes 12 of the 27 results fail on purpose, so you can see what a failing result looks like. Demo mode needs no pyatlan install.

Import

1. Ingest the Atlan data source's metadata first. The template tests need its catalog, and the standard tests link to its Ingestion Summary tables.
2. Create a folder for the pack in the target project, for example Atlan Instance Health Checks. The tests are imported straight into the folder you choose.
3. Open Marketplace in Validatar, find Atlan Instance Health Checks, choose Get, then Import Directly.
4. Choose the target project when prompted. The pack is project content, so Validatar asks which project to put it in.
5. Map the pack's data source Atlan to your Atlan data source, and choose the folder from step 2.
6. Choose Review Changes. The review lists the 15 tests to add. Choose Import.
7. Open each of the four template tests and generate their child tests, so they pick up the connections and data domains in your catalog. See Materializing Child Tests.
8. Run the folder, or add it to a job. Daily is a sensible schedule.

To import from a file instead, download the pack from the marketplace listing and import it on the project's Import page.

Adjusting a test

Each script starts with its thresholds. For example, the extraction check:

# Atlan Instance Health Check: Metadata extraction current
# Runs once per Atlan connection (child of a template test).
# PARAMETERS --------------------------------------------------------
MAX_AGE_DAYS = 7           # oldest acceptable crawl
# -------------------------------------------------------------------
dataframe = health_frame(
    atlan_check_extraction(atlan_client(), r"""{{table.name}}""", max_age_days=MAX_AGE_DAYS),
    "metadata_extraction")

Change a value and save. For a template test, change it on the template test and generate the child tests again. The checking logic lives in the Atlan template, so a newer template version improves every test without re-importing the pack.

When the template's Publish Target is External DQ (preview) only, nothing is written to the Validatar custom metadata set, so set REQUIRE_VALUES to False on the feed test.

What the demo tenant shows

With Demo Mode on, the sample tenant is a fictional company with four connections and these deliberate problems:

Everything else passes, including Validatar feed into Atlan is current, because two sample tables carry Validatar values published less than a day earlier. With the template tests' child tests (one per connection or domain) a demo run gives 27 results: 15 pass and 12 fail by design. The sample's Snowflake SAMPLE_DW connection passes every check; it is the one the Atlan Metadata and Lineage Scripts use in their own demo.

Troubleshooting

Related

• Atlan Data Source Template
• Atlan Integration
• Atlan Custom Metadata for Validatar
• Atlan Metadata and Lineage Scripts
• Materializing Child Tests
• Quality Dimensions

Note: These tests are built from Atlan's documentation and its official Python SDK, and have been run in Validatar against the built-in sample Atlan tenant. They have not yet been run against a live Atlan tenant, so thresholds and some checks may change after that validation.