Skip to content
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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WIP changefeed monitoring guide #19296

wants to merge 2 commits into from

Conversation

kathancox
Copy link
Contributor

@kathancox kathancox commented Jan 10, 2025

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

Copy link

github-actions bot commented Jan 10, 2025

Copy link

netlify bot commented Jan 10, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 11197d9
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/679d25239f424f00089d078f

Copy link

netlify bot commented Jan 10, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 11197d9
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/679d2523477ce10008f632a1

@kathancox kathancox force-pushed the cdc-monitoring-guide branch from f41db60 to 8db2635 Compare January 10, 2025 21:21
Copy link

netlify bot commented Jan 10, 2025

Netlify Preview

Name Link
🔨 Latest commit f41db60
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67818e9fe862350008649ae2
😎 Deploy Preview https://deploy-preview-19296--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 10, 2025

Netlify Preview

Name Link
🔨 Latest commit 11197d9
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/679d2523c12f2900085e960e
😎 Deploy Preview https://deploy-preview-19296--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kathancox kathancox force-pushed the cdc-monitoring-guide branch from 8db2635 to edad6e5 Compare January 16, 2025 18:04
Copy link

@rohan-joshi rohan-joshi left a 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

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

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

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

@kathancox
Copy link
Contributor Author

kathancox commented Jan 31, 2025

@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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants