Skip to main content

Set Up Data Insights Ingestion

Admin users can set up a data insights ingestion pipeline right from the OpenMetadata UI.
  • Navigate to Settings > Features > Applications. If the data insights application does not show up, click Browse Apps.
Applications page with Show Disabled and Browse Apps
  • Select the Data Insights application.
Data Insights application page with the Install button
  • Click Install. The wizard has three steps: Details, Configure, and Schedule. Click Next to move between them.
Install Data Insights wizard Details step
  • On the Configure step, adjust the settings according to your specific requirements, then click Next. The step has the following settings:
    • Batch Size: The maximum number of events processed at a time. The default is 100.
    • Recreate DataInsights DataAssets Index: Turn on to recreate the DataAssets index on DataInsights. Use it if you changed a Custom Property Type and are facing errors. Recreating the index deletes your DataAssets, so you need a backfill afterward.
    • backfillConfiguration: Turn on Enabled to backfill the configured dates, then set the Start Date and End Date.
    • Module Configuration: Each module has an Enabled switch that controls whether its insights are populated when the application runs. The modules are Data Assets Module, App Analytics Module, and Cost Analysis Insights Module.
    • Data Assets Module: Set the Entities to include and the Data Retention (Days). Insights older than the retention period are deleted.
Configure step with Batch Size, Recreate DataInsights DataAssets Index, backfill settings, and Start Date and End Date Configure step with the Data Assets Module and App Analytics Module settings Configure step with the App Analytics Module and Cost Analysis Insights Module settings
  • Choose a schedule execution time for your workflow. The schedule time is displayed in UTC. Run this workflow overnight or when activity on the platform is at its lowest to ensure accurate data. It is scheduled to run daily. Click Install.
Set Up Data Insights Ingestion Schedule This will successfully install the Data Insights application. Click on Configure to view the details. The application page has the Schedule, Configuration, and Recent Runs tabs, and you can change the same settings on the Configuration tab. Data Insights application page with the Configuration tab
  • Click on Run now to setup the ingestion pipeline.
Run the Data Insights Pipeline
  • You can also Edit the ingestion schedule. The ingestion pipeline can also be run on demand by again clicking on Run now. You can view the Recent Runs tab for details on when the ingestion was last run.
Recent Runs of the Data Insights Pipeline Navigate to the Insights page. You should see your Data Insights Reports. Note that if you have just deployed OpenMetadata, App Analytics data might not be present. App Analytics data is fetched from the previous day (UTC).

Key Performance Indicators (KPI)

Define the KPIs and set goals for documentation, and ownership.