Advanced Health Metrics and Monitoring Endpoints

The standard DataHub health check endpoint (`/health`) only returns a simple "GOOD" status response, which confirms service availability but doesn't provide detailed visibility into DataHub's operational health, component status, or performance metrics needed for comprehensive monitoring and alerting.

You Might Be Asking:

• Are there additional health check endpoints beyond the basic /health endpoint?
• How can I get detailed metrics about DataHub's internal components?
• What's the recommended way to integrate DataHub health metrics into external monitoring systems?
• Are there plans to expose richer operational insights?

DataHub currently provides a basic health check endpoint for service availability. For more comprehensive monitoring:

1. Basic Health Check:
   • Endpoint: /health
   • Returns: Simple "GOOD" or error status
   • Use case: Basic uptime monitoring
2. For Additional Metrics: DataHub does not currently expose a comprehensive metrics endpoint beyond the basic health check. For detailed operational monitoring, consider:
   • Monitor application logs for error patterns
   • Use APM (Application Performance Monitoring) tools at the infrastructure level
   • Monitor database and search index health separately
   • Track ingestion job success rates and durations through the DataHub UI or API
   • Use Kubernetes/container metrics if deployed in a containerized environment

3. GraphQL API for Operational Data: Use GraphQL queries to retrieve operational information:

   
   Query recent ingestion executions
   
   query {
     listIngestionSources {
       ingestionSources {
         urn
         name
         executions {
           result {
             status
           }
         }
       }
     }
   }
   

• Enhanced health and metrics endpoints are not currently available in the product
• Feature requests for comprehensive health metrics can be submitted through the DataHub community
• For managed DataHub (Acryl Data), contact support for monitoring capabilities specific to managed instances

• DataHub API Documentation

• 5209