PlanetScale Integration
Monitor VTGate query metrics, branch deployment events, and connection pool health across your PlanetScale databases. Correlate schema migrations with query performance changes automatically.
How It Works
Connect via PlanetScale API
Generate a PlanetScale service token with read access to your organization metrics. TigerOps connects to the PlanetScale Insights API and pulls VTGate query latency, error rates, and rows-read per branch.
Enable Connection Pool Metrics
TigerOps collects per-branch connection pool utilization, active connection counts, and pool wait times from the PlanetScale metrics endpoint — no agent installation required.
Track Branch Deploy Events
TigerOps listens to PlanetScale webhook events for deploy requests, schema migrations, and branch promotions. Each deployment event is correlated with query latency changes in your metrics timeline.
Set Query and Pool Alerts
Define p99 query latency SLOs and connection pool saturation thresholds per database branch. TigerOps fires alerts when deploy events coincide with latency regressions or error rate increases.
What You Get Out of the Box
VTGate Query Latency Tracking
p50, p95, and p99 VTGate query execution latency per statement type and database branch. TigerOps detects latency regressions following schema migrations or branch promotions automatically.
Connection Pool Monitoring
Active connections, idle connections, pool wait time, and connection acquisition failures per PlanetScale branch. Alert before connection exhaustion affects application availability.
Branch Deployment Correlation
PlanetScale branch deploy events are overlaid on all metric charts. Instantly see whether a schema migration or data migration caused a query latency spike or rows-read increase.
Rows Read & Rows Written Efficiency
Track rows-read-per-query and rows-written-per-query ratios to identify full-table scan patterns and inefficient bulk writes. Surface the exact queries responsible for high row-read amplification.
Error Rate & Timeout Monitoring
Per-branch VTGate error rates broken down by error type (timeout, connection refused, query error). TigerOps correlates error spikes with PlanetScale infrastructure events and deploy history.
AI Schema Migration Impact Analysis
TigerOps AI analyzes query performance before and after each PlanetScale branch promotion, identifying which query patterns regressed, which indexes are missing, and what the estimated production impact will be.
TigerOps Config for PlanetScale
Connect TigerOps to your PlanetScale organization using a service token — no agent installation required.
# TigerOps PlanetScale integration config
# Place at /etc/tigerops/conf.d/planetscale.yaml
integrations:
- name: planetscale
type: planetscale
config:
# PlanetScale service token (read-only organization scope)
service_token_id: "${PLANETSCALE_TOKEN_ID}"
service_token: "${PLANETSCALE_TOKEN}"
organization: my-org
# Databases to monitor (empty = all databases)
databases:
- my-app-db
- analytics-db
# Branch monitoring
branches:
# Branches to monitor (empty = production branch only)
include:
- main
- staging
# Collect per-branch comparison metrics
cross_branch_comparison: true
# Metrics to collect
metrics:
query_latency: true # VTGate p50/p95/p99 latency
rows_read: true # Rows read per query
rows_written: true # Rows written per statement
connections: true # Connection pool utilization
errors: true # Error rates by type
# Webhook for deploy event correlation
webhook:
enabled: true
# Register this URL in PlanetScale organization settings
url: https://ingest.atatus.net/webhooks/planetscale
signing_secret: "${PLANETSCALE_WEBHOOK_SECRET}"
poll_interval: 60s
remote_write:
endpoint: https://ingest.atatus.net/api/v1/write
bearer_token: "${TIGEROPS_API_KEY}"Common Questions
Does TigerOps require agent installation on PlanetScale infrastructure?
No. TigerOps connects entirely through the PlanetScale API and Insights endpoints using a service token. There is nothing to install inside PlanetScale infrastructure — the integration is fully API-based.
Can TigerOps monitor multiple PlanetScale database branches simultaneously?
Yes. TigerOps discovers all branches in your PlanetScale organization and collects metrics per branch. You can scope dashboards to a single branch (e.g., production) or compare query latency across branches during a staged rollout.
How does the branch deploy event correlation work?
TigerOps subscribes to PlanetScale webhooks for deploy_request.completed events. Each event is stored as an annotation in your metrics timeline. When you open a latency alert, the nearest deploy event is automatically surfaced as a potential contributing factor.
What PlanetScale plan is required to use TigerOps?
TigerOps works with PlanetScale Scaler Pro and Enterprise plans, which expose the Insights API and usage metrics endpoints. The free Hobby plan has limited metrics API access. Contact TigerOps support for details on your specific plan.
Does TigerOps support PlanetScale's read-only regions?
Yes. TigerOps collects per-region query latency and connection pool metrics for all PlanetScale read-only regions. You can compare read replica latency across regions and detect when a specific region is degraded.
Know the Impact of Every PlanetScale Deploy
VTGate query metrics, branch deploy correlation, and AI schema migration impact analysis. No agent needed.