pginsights Extension
Overview
PlanetScale Insights plugin that provides query performance monitoring and analysis capabilities. This extension is always enabled for PlanetScale databases and integrates with the Query Insights feature.
Dashboard Configuration
This extension is always enabled for PlanetScale databases and requires activation via the PlanetScale Dashboard. While the extension itself is always active, some of its parameters can be configured through the dashboard.
To configure pginsights parameters:
- From the PlanetScale organization dashboard, select the desired database
- Navigate to the Cluster configuration page from the menu on the left
- Choose the branch whose extensions you'd like to configure in the "Branch" dropdown
- Select the Extensions tab
- Configure pginsights parameters
- Click Queue extension changes to apply the configuration
- Once you're ready to apply the changes, click "Apply changes"
Parameters
pginsights.raw_queries
- Type: Boolean
- Default:
false - Description: Send full query text for slow, large, or failed queries (may include sensitive data).
- Documentation: Raw Query Collection
pginsights.normalize_schema_names
- Type: Boolean
- Default:
false - Description: Merge queries patterns that differ only by schema name.
- Documentation: Schema Name Normalization
Usage
The pginsights extension is automatically installed and enabled for all PlanetScale databases. You don't need to manually create the extension - it's always active and collecting query insights.
The extension integrates with PlanetScale's Query Insights dashboard to provide:
- Query performance metrics
- Slow query identification
- Query pattern analysis
- Resource usage tracking
External Documentation
For more information about Query Insights and how to use the collected data, see the Query Insights documentation.
Need help?
Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.