Skip to main content

External monitoring integrations

Use the VeloDB Cloud Metrics API to collect raw VeloDB Cloud metrics in an external monitoring platform.

The Metrics API returns Prometheus text exposition format over HTTPS and requires an X-API-Key header. Any collector that can scrape Prometheus or OpenMetrics endpoints and set this header can use the API. This is protocol-level compatibility; configuration, credential handling, metric naming, pricing, dashboards, and alerting differ by product and require product-specific validation.

Choose an integration​

Choose the option that matches the monitoring platform you use today.

Datadog
Use Datadog Agent's OpenMetrics check to collect selected VeloDB Cloud metrics. This is the currently validated end-to-end integration.
Set up Datadog Agent →
Prometheus-compatible collectors
Scrape the Metrics API directly with a collector that supports Prometheus or OpenMetrics endpoints and custom HTTP headers.
View Metrics API configuration →

Grafana is commonly used as a visualization layer with a compatible metrics collector or data source. Product-specific configuration, credential handling, metric naming, pricing, dashboards, and alerting must be validated for each platform.

Before you start​

  • Confirm that Metrics API Private Preview is enabled for your organization.
  • Choose a warehouse endpoint for warehouse-level metrics, or add a cluster endpoint when you need metrics from a specific cluster.
  • Create and securely store a least-privilege VeloDB Cloud API key.
  • Start with a small, explicit set of metrics and labels. This limits custom-metric cost and tag cardinality in your monitoring platform.

For API details and available metric categories, see Metrics API and Metrics.