> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vortexiq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PlanetScale on Vortex IQ

> Monitor PlanetScale health, cost and reliability signals, and catch incidents and runaway spend early.

Monitor PlanetScale health, cost and reliability signals, and catch incidents and runaway spend early.

[Connect or manage this source](https://app.vortexiq.ai/workbench/settings/sources) · [How connecting works](/integrations/connector-catalogue) · [Create a workflow](https://app.vortexiq.ai/workbench/flows/create?connector=planetscale)

<CardGroup cols={5}>
  <Card title="25">
    performance signals
  </Card>

  <Card title="7">
    automated checks
  </Card>

  <Card title="0">
    prepared fixes
  </Card>

  <Card title="0">
    proven workflows
  </Card>

  <Card title="9">
    API operations
  </Card>
</CardGroup>

<Tabs>
  <Tab title="Overview">
    ### What you can achieve

    Capabilities are grouped around merchant outcomes, not API terminology.

    <CardGroup cols={2}>
      <Card title="Control risk and change">
        Keep tracking, access and change under governed control.
      </Card>

      <Card title="Run operations">
        Monitor orders, fulfilment, delivery and settlement.
      </Card>

      <Card title="Protect revenue">
        Find failures, leaks and risks before they cost sales.
      </Card>

      <Card title="Catalogue quality">
        Identify missing, inconsistent or outdated product data.
      </Card>

      <Card title="Customer experience">
        Find storefront, speed, accessibility and journey problems.
      </Card>
    </CardGroup>

    ### From connection to verified outcome

    The controlled sequence every capability follows. Nothing changes a connected system without the approval step.

    <Steps>
      <Step title="Connect">
        Authorise the source. Scopes are shown before access is granted.
      </Step>

      <Step title="Monitor">
        Watch the signals against your own baselines, not universal defaults.
      </Step>

      <Step title="Detect">
        Run checks and gather evidence specific to your store.
      </Step>

      <Step title="Recommend">
        Explain what happened, why it matters and the proposed action.
      </Step>

      <Step title="Approve">
        You review scope, risk and reversibility before anything changes.
      </Step>

      <Step title="Execute">
        Apply through governed connector operations.
      </Step>

      <Step title="Verify">
        Confirm the intended result and keep the receipt.
      </Step>
    </Steps>

    No changes are made without the configured approval policy. Read-only operations do not modify the connected system; schedules, access scopes, API usage and data handling remain governed by Vortex IQ controls.
  </Tab>

  <Tab title="Monitor (25)">
    ### Monitor performance

    25 performance signals. Open an outcome to see its signals and how each one alerts. Read-only operations do not modify the connected system.

    <AccordionGroup>
      <Accordion title="Run operations (7 signals)">
        | Signal                         | Alert behaviour    | What it tracks                                                                                                              |
        | ------------------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------- |
        | **Connection Saturation >90%** | Alert band 70 / 90 | Alerts for Connection Saturation >90%.                                                                                      |
        | **Deploy Request Open >24h**   | Merchant rule      | Alerts for Deploy Request Open >24h.                                                                                        |
        | **PlanetScale Health Score**   | Merchant rule      | Composite of query latency, usage-vs-plan burn, deploy-request hygiene and backup recency. \<70 = investigate.              |
        | **Row Reads >90% of Plan Cap** | Merchant rule      | Alerts for Row Reads >90% of Plan Cap.                                                                                      |
        | **Row Reads vs Plan Cap %**    | Merchant rule      | PlanetScale-distinctive - rows read in the billing period / plan row-read cap. >90% = overage charges or throttle imminent. |
        | **Rows Read (24h)**            | Watch only         | PlanetScale-distinctive - rows read is the primary billed metric. Reads, not queries, drive the bill.                       |
        | **Storage Usage %**            | Alert band 70 / 90 | storage\_bytes / plan storage cap from the usage surface.                                                                   |
      </Accordion>

      <Accordion title="Protect revenue (7 signals)">
        | Signal                                           | Alert behaviour    | What it tracks                                                                                                                                |
        | ------------------------------------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
        | **Backup Failures (7d)**                         | Merchant rule      | Backups in state=failed in the last 7 days from the backups API.                                                                              |
        | **Connection Saturation vs Traffic Burst**       | Alert band 70 / 90 | Connection Saturation vs Traffic Burst, broken down by row.                                                                                   |
        | **Deploy Requests Stuck >24h**                   | Merchant rule      | Open deploy requests older than 24h not yet deployed to production - schema-drift / stalled-migration risk.                                   |
        | **Errored Deploy Requests (7d)**                 | Merchant rule      | Deploy requests that errored during apply - failed schema migrations needing attention.                                                       |
        | **Product Table Row Count vs Ecom Catalog Size** | Merchant rule      | PlanetScale-distinctive XC - merchants frequently keep the product / inventory master in PlanetScale; row-count drift vs ecom = sync failure. |
        | **Row-Read Spike vs Ecom Order Rate**            | Merchant rule      | PlanetScale-distinctive XC - a read storm with no order growth burns billed rows for nothing.                                                 |
        | **Slow Queries During Checkout Window**          | Merchant rule      | Slow Queries During Checkout Window, broken down by row.                                                                                      |
      </Accordion>

      <Accordion title="Control risk and change (4 signals)">
        | Signal                                 | Alert behaviour    | What it tracks                                                                                                               |
        | -------------------------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
        | **Connection Saturation %**            | Alert band 70 / 90 | Open connections / branch connection cap. >90% = connection-refused errors imminent.                                         |
        | **Open Deploy Requests**               | Merchant rule      | PlanetScale-distinctive - deploy requests in 'open' state from the deploy-requests API. The Git-like schema-change workflow. |
        | **Query Error Rate %**                 | Alert band 0.1 / 1 | Share of queries returning an error at the vtgate proxy layer in the trailing 5-minute window.                               |
        | **Query Error Rate Spike (>1% in 5m)** | Alert band 0.1 / 1 | Alerts for Query Error Rate Spike (>1% in 5m).                                                                               |
      </Accordion>

      <Accordion title="Customer experience (4 signals)">
        | Signal                       | Alert behaviour      | What it tracks                                                                                                                    |
        | ---------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
        | **Query Latency p95 (ms)**   | Alert band 50 / 200  | p95 query time from Insights. Insights coverage is plan-gated - see grant note.                                                   |
        | **Query Latency p99 (ms)**   | Alert band 100 / 500 | p99 query time from Insights.                                                                                                     |
        | **Slow-Query Rate %**        | Alert band 1 / 5     | Share of executions over the slow threshold from Insights query statistics.                                                       |
        | **Top Queries by Rows Read** | Watch only           | PlanetScale-distinctive - Insights query patterns ranked by rows read. Highest rows-read = highest billed cost; index candidates. |
      </Accordion>

      <Accordion title="Catalogue quality (3 signals)">
        | Signal                                 | Alert behaviour    | What it tracks                                                                          |
        | -------------------------------------- | ------------------ | --------------------------------------------------------------------------------------- |
        | **Active Branches**                    | Watch only         | Count of branches from the branches API - production + dev branches.                    |
        | **Connections In Use**                 | Watch only         | Active connections to the production branch cluster (vtgate).                           |
        | **Last Successful Backup (hours ago)** | Alert band 24 / 72 | Hours since the most recent successful backup (state=success) on the production branch. |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Audit (7)">
    ### Audit risks and opportunities

    A fix status appears only where the action, inputs, approval, verification and recovery controls are mapped. Candidate remediations are never executable. Open a check for the detail.

    <AccordionGroup>
      <Accordion title="Connection pool saturation above 90%">
        **Severity** critical · **Outcome** Customer experience · **Fix status** Report only

        At 90% of the connection pool in use, the database is close to refusing new connections outright. Once it does, every part of the application that needs a fresh database connection, including new customer sessions and checkout, starts failing, not just slowing down.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-CAP-001`
      </Accordion>

      <Accordion title="Disk usage above 90%">
        **Severity** critical · **Outcome** Run operations · **Fix status** Report only

        A database that runs out of disk stops accepting writes entirely, which for most stores means orders, inventory updates and customer records stop being saved, not just that the database gets slower. There is very little runway left at 90%.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-CAP-002`
      </Accordion>

      <Accordion title="Query error rate above 1% in last 5 minutes">
        **Severity** critical · **Outcome** Run operations · **Fix status** Report only

        More than 1 in 100 queries is failing right now. Depending on what those queries do, this can mean orders not saving, pages failing to load product or customer data, or background jobs silently dropping work, and a rate this high in a 5-minute window is an active incident, not background noise.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-ERR-001`
      </Accordion>

      <Accordion title="Last successful backup older than 72 hours">
        **Severity** high · **Outcome** Run operations · **Fix status** Report only

        If something goes wrong with this database right now, the most recent point it can be restored to is over 3 days old. Every order, customer record and inventory change since that backup would be unrecoverable in a real incident, not just delayed.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-BAK-001`
      </Accordion>

      <Accordion title="Replication lag above 10 seconds">
        **Severity** high · **Outcome** Run operations · **Fix status** Report only

        Anything reading from the replica, reports, dashboards, or read traffic split off the primary for capacity, is now up to 10+ seconds stale. If the primary fails while lag is this high, the replica is also that far behind on failover, which is a bigger problem than the staleness alone.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-REP-001`
      </Accordion>

      <Accordion title="Slow-query rate above 5% of total">
        **Severity** high · **Outcome** Customer experience · **Fix status** Report only

        More than 1 in 20 queries is landing in the slow bucket. That is frequent enough to be a pattern, not noise, and it means a meaningful share of every page load or job that touches this database is paying the slow-query cost, not just an unlucky occasional request.

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-PERF-002`
      </Accordion>

      <Accordion title="p95 query latency above 200ms sustained 15m">
        **Severity** high · **Outcome** Customer experience · **Fix status** Report only

        One in twenty queries against this database is taking over 200ms, sustained for at least 15 minutes, not a brief spike. Any storefront page, checkout step or order sync that depends on this database inherits that slowness directly, and a sustained p95 this high is usually already visible to customer

        Vortex IQ detects and explains this; resolution is manual, with evidence and recommended steps.

        Reference: `DB-PERF-001`
      </Accordion>
    </AccordionGroup>

    #### Build your own automated fixes

    Turn any finding into an automated fix with a Vortex IQ workflow: **over 13,000 read and write operations across more than 200 connectors** are available as building blocks, with approval, verification and rollback on every change.
  </Tab>

  <Tab title="Automate">
    ### Automate approved work

    Vortex IQ is integrated with **9 read** and **0 write** operations across organizationdatabasbranches, organizationdatabas, organizationdatabasbranchebackups, organizationdatabasbrancheclusters, organizationdatabasbranchekeyspaces, organizationdatabasdeployrequests on PlanetScale. Combine them with anything from the **over 13,000 operations across more than 200 connectors** to automate the work in your own words.

    Changes follow your configured approval policy: the target, proposed change, affected records, risk, reversibility and verification plan are shown before execution.

    [Create a workflow](https://app.vortexiq.ai/workbench/flows/create?connector=planetscale)

    #### Ready to build your first PlanetScale workflow

    Pick a trigger, add the operations above as steps, and every step that changes data pauses for your approval. Monitoring and audits are live now and can start any workflow you build.

    <Accordion title="Browse the operations you can build with">
      | Resource                            | Read operations | Write operations |
      | ----------------------------------- | --------------- | ---------------- |
      | organizationdatabasbranches         | 2               | 0                |
      | organizationdatabas                 | 1               | 0                |
      | organizationdatabasbranchebackups   | 1               | 0                |
      | organizationdatabasbrancheclusters  | 1               | 0                |
      | organizationdatabasbranchekeyspaces | 1               | 0                |
      | organizationdatabasdeployrequests   | 1               | 0                |
      | organizationdatabasinsights         | 1               | 0                |
      | organizationdatabasusages           | 1               | 0                |

      Signed-in users see the full catalogue in the workflow builder, filtered to the sources they have connected.
    </Accordion>
  </Tab>
</Tabs>
