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

DOC-6747: Docs for Improve network observability inside CockroachDB #17824

Merged
merged 1 commit into from
Sep 22, 2023

Conversation

florence-crl
Copy link
Contributor

Addresses DOC-6747

(1) Updated Network page and images. (2) Updated sidebar-data for self-hosted-deployments. (3) Updated Troubleshoot Self-Hosted Setup page, Network partitioning section.

@netlify
Copy link

netlify bot commented Sep 7, 2023

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit ca941d2
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/650dcfdae782ff00088db0ad

@netlify
Copy link

netlify bot commented Sep 7, 2023

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit ca941d2
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/650dcfda79c06800093f6972

@netlify
Copy link

netlify bot commented Sep 7, 2023

Netlify Preview

Name Link
🔨 Latest commit ca941d2
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/650dcfdaedf7060008922e94
😎 Deploy Preview https://deploy-preview-17824--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

@koorosh koorosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from my perspective!

I would probably also mention Unhealthy RPC Connections graph on Metrics page > Networking dashboard as an additional source of info to investigate problems with network connections.
Screenshot 2023-09-08 at 10 25 31

@florence-crl
Copy link
Contributor Author

@koorosh Thanks for the review. I added a comment to PR 17252 to mention the graph on cluster-setup-troubleshooting.md when the networking dashboard is documented.

src/current/v23.2/cluster-setup-troubleshooting.md Outdated Show resolved Hide resolved
src/current/v23.2/cluster-setup-troubleshooting.md Outdated Show resolved Hide resolved
src/current/v23.2/cluster-setup-troubleshooting.md Outdated Show resolved Hide resolved
src/current/v23.2/cluster-setup-troubleshooting.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mdlinville for the careful review!

src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Outdated Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Show resolved Hide resolved
Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not make a separate Network Partitions section. I did modify the description of a network partition to match the changes @mdlinville suggested to the description in the troubleshooting doc.

src/current/v23.2/ui-network-latency-page.md Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Show resolved Hide resolved
src/current/v23.2/ui-network-latency-page.md Show resolved Hide resolved
Copy link

@kevin-v-ngo kevin-v-ngo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great doc! 👏

…f-hosted-deployments. (3) Updated Troubleshoot Self-Hosted Setup page, Network partitioning section.
@florence-crl florence-crl merged commit b7b36ff into main Sep 22, 2023
6 checks passed
@florence-crl florence-crl deleted the DOC-6747 branch September 22, 2023 17:39
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.

None yet

4 participants