You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: cleanup and consistency improvements across README, CONTRIBUTING, and component docs
- Remove orphaned scratch design doc TMP_MON_PREVIEWS.md (1518 lines,
duplicate changelog entries, not referenced; replaced by
preview-infra/RUNBOOK.md).
- Fix broken markdown in README.md: remove broken centered-div wrap
that left code blocks center-aligned, drop duplicated "Use cases"
section, fix unterminated backtick, consolidate Links/Support, and
drop decorative emoji from H2 headers for consistency with the top
half of the document.
- Fix stale repo URL in cli/README.md (postgres_ai -> postgresai).
- Fix invalid check ID in QUALITY_ENGINEERING_GUIDE example summary
(U001 -> H002, D004 -> F004) and correct CLI command reference
(postgresai monitoring -> postgresai mon).
- Fix stray "SQL" delimiter outside heredoc and reschedule mismatch
("every 20 minutes" did not match the daily cron) in
workload_examples/single_index_analysis.md.
- Normalize curly quotes to ASCII in CONTRIBUTING.md and
components/index_pilot docs, tighten Recommendations wording.
- Minor SECURITY.md heading casing and grammar fixes.
- Trim trailing blank lines in pgai/README.md, postgres_ai_helm/README.md,
components/index_pilot/CONTRIBUTING.md.
https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -113,7 +113,7 @@ That means edits to:
113
113
-`config/pgwatch-*/metrics.yml`
114
114
-`config/scripts/*.sh`
115
115
116
-
can be picked up locally (see “Applying config changes” below).
116
+
can be picked up locally (see "Applying config changes" below).
117
117
118
118
#### 1) Choose what Postgres you want to monitor
119
119
@@ -290,7 +290,7 @@ Then attach:
290
290
### Troubleshooting
291
291
292
292
-**Compose says `PGAI_TAG is required`**: set it in `.env` (see above).
293
-
-**Host reporter can’t connect to sink-postgres**: make sure the stack is up and `sink-postgres` is bound to `127.0.0.1:55433` (it is in `docker-compose.override.yml`).
293
+
-**Host reporter can't connect to sink-postgres**: make sure the stack is up and `sink-postgres` is bound to `127.0.0.1:55433` (it is in `docker-compose.override.yml`).
294
294
-**Need to regenerate pgwatch sources after editing `instances.yml`**:
Copy file name to clipboardExpand all lines: README.md
+42-64Lines changed: 42 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -206,49 +206,20 @@ npx postgresai checkup --json postgresql://... | claude -p "find issues and sugg
206
206
## Tips
207
207
208
208
-**Short alias:**`npx pgai checkup` works too
209
-
-**Can I use it without registration on console.postgres.ai?** Yes, both express checkup and full-fledged monitoring are open-source and can be used without any connection to console.postgres.ai. In instructions above, just skip `npx postgresai auth` and:
209
+
-**Can I use it without registration on console.postgres.ai?** Yes, both express checkup and full-fledged monitoring are open-source and can be used without any connection to console.postgres.ai. In the instructions above, just skip `npx postgresai auth` and:
210
210
- Express checkup: use `--no-upload`
211
-
- Full monitoring: omit --api-key`
212
-
-**Managed version:** Express checkup finds problems. The managed version at [console.postgres.ai](https://console.postgres.ai) also explains how to fix them and provides an Issues workflow to track fixes
-**Managed version:** Express checkup finds problems. The managed version at [console.postgres.ai](https://console.postgres.ai) also explains how to fix them and provides an Issues workflow to track fixes.
To upgrade postgres_ai monitoring to a newer version:
263
234
@@ -322,7 +293,7 @@ postgresai mon health
322
293
323
294
Check Grafana dashboards at http://localhost:3000 to confirm metrics are being collected.
324
295
325
-
## ☸️ Kubernetes deployment
296
+
## Kubernetes deployment
326
297
327
298
Deploy postgres_ai monitoring to Kubernetes using helm:
328
299
@@ -372,7 +343,7 @@ This automatically:
372
343
- Triggers GitLab CI/CD to package and publish the chart
373
344
- Creates a GitLab release with the packaged chart
374
345
375
-
## 📋 Checkup reports
346
+
## Checkup reports
376
347
377
348
postgres_ai monitoring generates automated health check reports based on [postgres-checkup](https://gitlab.com/postgres-ai/postgres-checkup). Each report has a unique check ID and title:
378
349
@@ -434,36 +405,34 @@ postgres_ai monitoring generates automated health check reports based on [postgr
434
405
|----------|-------|
435
406
| N001 | Wait events grouped by type and query |
436
407
437
-
## 🌐 Access points
408
+
## Access points
438
409
439
-
After running local-install:
410
+
After running `local-install`:
440
411
441
-
-**🚀 MAIN: Grafana Dashboard**:http://localhost:3000 (login: `monitoring`; password is shown at the end of local-install)
412
+
-**Grafana dashboard:**http://localhost:3000 (login: `monitoring`; password is shown at the end of `local-install`)
- Query plan analysis and automated recommendations
464
433
- Enhanced AI integration capabilities
465
434
466
-
## 🧪 Testing
435
+
## Testing
467
436
468
437
Python-based report generation lives under `reporter/` and now ships with a pytest suite.
469
438
@@ -511,27 +480,36 @@ pytest tests/reporter -m unit --cov=reporter --cov-report=html
511
480
512
481
View the coverage report by opening `htmlcov/index.html` in your browser.
513
482
514
-
## 🤝 Contributing
483
+
## Contributing
484
+
485
+
We welcome contributions from Postgres experts. See [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup, and the [GitLab repository](https://gitlab.com/postgres-ai/postgresai) for:
515
486
516
-
We welcome contributions from Postgres experts! Please check our [GitLab repository](https://gitlab.com/postgres-ai/postgresai) for:
517
487
- Code standards and review process
518
488
- Dashboard design principles
519
489
- Testing requirements for monitoring components
520
490
521
-
## 📄 License
491
+
## License
522
492
523
-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
493
+
This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.
494
+
495
+
## About PostgresAI
496
+
497
+
`postgresai` is developed by [PostgresAI](https://postgres.ai), bringing years of Postgres expertise into automated monitoring and analysis tools. We provide enterprise consulting and advanced Postgres solutions for fast-growing companies.
postgres_ai monitoring is developed by [PostgresAI](https://postgres.ai), bringing years of Postgres expertise into automated monitoring and analysis tools. We provide enterprise consulting and advanced Postgres solutions for fast-growing companies.
Copy file name to clipboardExpand all lines: SECURITY.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,14 +13,14 @@ If you discover a security vulnerability in this project, please report it to **
13
13
14
14
### When should I NOT report a vulnerability?
15
15
16
-
- Your issue is not securityrelated.
16
+
- Your issue is not security-related.
17
17
18
-
## Security Vulnerability Response
18
+
## Security vulnerability response
19
19
20
20
Each report is acknowledged and analyzed by the project maintainers and the security team within 3 working days.
21
21
22
-
The reporter will be kept updated at every stage of the issue's analysis and resolution (triage → fix → release).
22
+
The reporter is kept updated at every stage of the issue's analysis and resolution (triage → fix → release).
23
23
24
-
## Public Disclosure Timing
24
+
## Public disclosure timing
25
25
26
26
A public disclosure date is negotiated by the maintainers (security@postgres.ai) and the bug submitter. We prefer to fully disclose the bug as soon as possible once user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. We expect the timeframe between a report and public disclosure to typically be in the order of 7 days.
0 commit comments