docs: add query exporter monitoring documentation #112
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the query-exporter service, which provides PostgreSQL database monitoring and metrics exposure for Prometheus integration. The documentation covers metrics available, configuration options, and operational guidance for monitoring the OpenRemote database.
Key changes:
- Added complete query-exporter monitoring documentation covering available metrics (bloat detection, autovacuum, datapoint performance, database health)
- Documented configuration including environment variables, thresholds, and query intervals
- Provided operational guidance including Prometheus integration, troubleshooting, and performance tuning
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| scrape_configs: | ||
| - job_name: 'openremote-postgres' | ||
| static_configs: | ||
| - targets: ['localhost:9560'] |
There was a problem hiding this comment.
The target 'localhost:9560' will only work if Prometheus is running on the same host as the query-exporter service. For Docker deployments (which is the primary deployment method mentioned throughout the documentation), this should use the Docker service name instead. Consider adding a note about using the service name (e.g., 'query-exporter:9560') when Prometheus runs in the same Docker network, or providing examples for both scenarios.
| - **Increase query interval** - Change from 300s to 600s or higher in `config.yaml` | ||
| - **Limit to specific schemas** - Modify queries to target specific schemas only | ||
| - **Schedule off-peak runs** - Use `schedule` option instead of `interval` | ||
| - **Reduce sample size** - Lower the datapoint query sample size (default: 100) |
There was a problem hiding this comment.
The sample size value mentioned here (100) should be documented in the "Query Intervals" section above for consistency. Currently, the query intervals section (lines 61-66) documents time intervals but doesn't mention sample sizes. Consider adding a note about the sample size to that section or creating a "Query Parameters" subsection.
No description provided.