Feedback: Backup and Restore Monitoring - document backup and restore logging
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- prometheus
- Domain
- documentation
Research direction
Start with the backup-and-restore-monitoring.html page named in the issue and review its existing Prometheus metrics section. Research the relevant backup and restore logging channel and useful messages, then document both on that page. Done means the page explains where these logs appear and which messages users should monitor.
Written by the indexing model from the issue text.
Description
Page: https://cockroachlabs.com/docs/v25.2/backup-and-restore-monitoring.html
What is the reason for your feedback?
[X] Missing the information I need
[ ] Too complicated
[ ] Out of date
[ ] Something is broken
[ ] Other
Additional details
This page talks about Prometheus metrics. It would be helpful if it also covered
- Where backup/restore logs are writen (e.g. which logging channel)
- What are useful log messages to monitor
Jira issue: DOC-14401
- Dominant language
- HTML
- Stars
- 212
- Forks
- 478
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cockroachdb/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cockroachdb/docs#23467 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cockroachdb/docs#23456 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cockroachdb/docs#23454 ·
-
Difficulty 2/5 1-2 days Newbie friendliness 68/100
cockroachdb/docs#23445 · 1 comment ·
-
sql-diagram-validation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
cockroachdb/docs#23444 · 4 comments ·
All issues in cockroachdb/docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
alphagov/govuk-frontend-docs#668 ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
lesson-submission needs-ac pending-review
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Ikalus1988/MisakaNet#2868 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
bancolombia/scaffold-clean-architecture#1001 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
navikt/esyfo-narmesteleder#615 ·
Maintainers usually reply within 1 day