Apache Atlas dashboard tour

The Apache Atlas dashboard provides a unified metadata management interface to perform entity searches, manage classifications, and visualize lineage graphs.

The Atlas user interface is a metadata dashboard with the following parts:

  • Search panel on the left.
  • Detail panel on the right where search results are displayed. You can drill into a specific entity to view its details. Each detail page contains a header section and a series of tabbed panels, all of which are oriented to the metadata for that entity type.
Figure 1. Filtered search results

Searching

The Search panel contains the following tabs for searching:
  • Search

    Select from existing lists of metadata types to narrow the search results. Switching to the Advanced search allows you to enter specific Atlas DSL search queries. Both Basic and Advanced searches can be saved for easy reuse in Favorite Searches.

  • Classifications

    Access predefined searches based on classifications

  • Glossary

    Search using predefined glossary terms

Figure 2. Search panel

Classifications

In the Classification option, selecting a classification displays all the entities that are marked with that classification. Locate a specific classification using the search box or browse the classification hierarchy that you defined during classification creation. The Classification tab displays all related assets, including processes.

Figure 3. Searching with classifications
Figure 4. Classification tab

Glossary

In the Glossary option, selecting a term displays all the entities that are marked with that term. Locate a specific term using the search box or browse terms by glossary. Use the category view to browse the hierarchy of your organization’s business glossary. Selecting a category displays its assigned terms in the display pane. When you select one of those terms, Atlas displays the associated entities.

When you run a search and Atlas returns results, you see a paged-list of entities that match the search criteria. From here, you can go back to the search options and further refine your search or use controls to change how the search results are presented.

Figure 5. Glossary tab

Search results

When Atlas returns search results, the user interface displays a paginated list of entities that match the search criteria. You can return to search options to further refine your search or use the available controls to change the search result presentation.

Figure 6. Search results
  1. View the search criteria set in the Search panel.
  2. By selecting the checkboxes, remove the following entity types from the result list:
    • Sub-entities
    • Sub-classifications
    • Entities marked as deleted (historical entities)
  3. Control which attributes of the entities are shown in the columns.
  4. Download the selected search results as a CSV file.
  5. By selecting the checkboxes, mark multiple entities for export or for applying classifications or terms.
  6. Add classifications by clicking the icon. By clicking the icon, view the rest of the classifications, that did not fit the screen.
  7. Add terms by clicking the icon. By clicking the icon, view the rest of the terms, that did not fit the screen.

Viewing entity details

When you click a link for an entity in the search results, Atlas opens an entity detail page that includes the metadata collected for the entity. The detail page organizes the entity content in the following tabs:

Starting with Cloudera Runtime 7.1.9 SP2, the first load of an entity detail page omits large embedded relationship payloads so the page opens faster and stays responsive for entities with very large relationship graphs. Relationship and schema rows load when you open the Relationships or Schema tab. Before 7.1.9 SP2, relationship data could be included in the initial response, which could slow or block the UI for those entities.

  • Properties Includes the system metadata collected for this entity and any user-defined properties. It also contains a list of labels applied to the entity. Use values from any of the string data type properties to find this entity using free-text search.
  • Lineage Displays a lineage graph for each entity. For data asset entities, the lineage graph is displayed when the entity functioned as an input or an output for an operation. For process entities, the lineage graph displays all input and output entities used by or produced by the operation.
  • Relationships Lists the other entities associated with the current entity. You can view the related entities as a list or as a graph and use this tab to navigate among entities. The input and output relationship types include the entities that make up the lineage. Starting with Cloudera Runtime 7.1.9 SP2, you can switch between Table mode (a card per relationship type) and Graph mode (the lineage-style graph). Each card displays a count, optional sort controls, an option to include deleted relationships, and loads related entities in pages as you scroll so large graphs stay usable.
    Figure 7. Relationships displayed in card mode
    Figure 8. Relationships displayed in graph mode
    Click the graph nodes to display the connected entities.

    Before 7.1.9 SP2, the tab relies on relationship data from the initial entity response, which can fail to render for large relationship graphs (for example, a Hive table with more than 10,000 column relationships). In addition, the searchRelatedEntities API always applies default alphabetical sorting, increasing response times for large result sets. Approximate relationship counts can be inaccurate when deleted entities are excluded, and attributes referencing multiple entity types (for example, hive_db.tables containing both hive_table and hbase_table) return entities of only a single type instead of all related entities.

  • Classifications Displays the classifications associated with this entity and are also displayed in the top section of the detail page. This tab allows you to add, update, or remove classifications from the entity.
  • Audits Records the changes that occur to entity metadata. It displays when and how Atlas updated the entity's metadata, including the following changes:
    • Classifications added or removed
    • Entity attributes updated
    • Labels added, updated, or removed
    • Relationships added, updated, or removed
    • Glossary terms added or removed
  • Schema Is only displayed when the current entity is a table and lists columns in that table. Use this tab to drill into a specific column or to add classifications to columns without opening the individual column detail page. Starting with Cloudera Runtime 7.1.9 SP2, column rows load when you open this tab, using the same on-demand relationship loading pattern as the Relationships tab.
Figure 9. Entity details