-
Notifications
You must be signed in to change notification settings - Fork 468
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WIP changefeed monitoring guide #19296
base: main
Are you sure you want to change the base?
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
f41db60
to
8db2635
Compare
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
8db2635
to
edad6e5
Compare
edad6e5
to
1cd9186
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made some comments - really appreciate all of this!
- [Sink errors over time](#sink-errors) | ||
- [Retry counts](#downstream-delivery) | ||
|
||
## Common troubleshooting scenarios |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
after some thinking - let's remove the common troubleshooting scenario section, including all the subsections (high end to end latency, rangefeed pressure, sink perf issues).
- Scoped by `changefeed_job_id` | ||
- Supported Versions: v23.2.13+, v24.1.6+, v24.2.4+, v24.3.0+ | ||
|
||
## Suggested dashboards |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove this section entirely
- Resource usage during catch-up after restarts. | ||
- Supported Versions: v23.2.3+, v24.1.0+ | ||
|
||
### End-to-end performance metrics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bc we want to limit the verbosity of metrics to readers, let's remove the entire end to end performance metrics section
@rohan-joshi I've removed the requested sections. When we chatted, you mentioned keeping the diagram as is — is that still the case? I suppose the end-to-end component of that could be a source of confusion if we're not calling it out anywhere. Happy to update the diagram, if you think best. Let me know! (p.s. I do think we actually mention most of the end-to-end metrics elsewhere in the cdc docs) |
Fixes DOC-11998
This PR adds a guide for monitoring changefeeds, particularly as a pipeline. Includes recommended metrics, information on potential impact of high values, and suggested dashboards.
Preview
https://deploy-preview-19296--cockroachdb-docs.netlify.app/docs/v25.1/changefeed-monitoring-guide.html