how-to-guides

No menu items for this category

Custom Metrics

Custom metrics in OpenMetadata enhance profiling capabilities by enabling users to define and compute unique business metrics using custom SQL queries. These metrics can be added at both the table and column levels, allowing tailored analysis specific to organizational needs. Once defined, custom metrics are incorporated into the profiler workflow, and their computed values are displayed alongside system metrics in the table and column profiles. This feature provides a flexible way to track specific data insights, empowering users to gain deeper visibility into their datasets.

  • Navigate to the Database and switch to the Data Observability tab. Click on Table Profile, and on the right-hand side, select the Add option to access the custom metric feature.
Click Add Custom Metric

Click Add Custom Metric

  • Enter a meaningful name for the custom metric and input the required SQL query based on your data requirements.
Input SQL query

Input SQL query

  • Once the custom metric is defined, run the Profiler Agent in the Database Services.
Run Ingestion

Run Ingestion

  • After running the profiler agent, return to the same dataset to view the computed custom metric within the table profile.
View Custom Metric

View Custom Metric

  • Navigate to the Database and switch to the Data Observability tab. Click on Column Profile, and on the right-hand side, select the Add option to access the custom metric feature.
Click Add Custom Metric

Click Add Custom Metric

  • After clicking on Custom Metric, provide a name, select column name, and define the SQL query.
Run Profiler Agent

Run Profiler Agent

  • Save and run the profiler workflow to generate the metric.
Run Profiler Agent

Run Profiler Agent

  • After running the profiler agent, return to the same dataset to view the computed custom metric in the column profile.
View Custom Metric

View Custom Metric