Skip to content

docs: add dashboards documentation page with BBE Probes explanation#191

Open
Hauke Löffler (hloeffler) wants to merge 12 commits into
mainfrom
docs/monitoring-dashboards-page
Open

docs: add dashboards documentation page with BBE Probes explanation#191
Hauke Löffler (hloeffler) wants to merge 12 commits into
mainfrom
docs/monitoring-dashboards-page

Conversation

@hloeffler

@hloeffler Hauke Löffler (hloeffler) commented Jan 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a new "Dashboards" page under the Monitoring section (src/multiplayer-servers/monitoring/dashboards.md)
  • Documents the "Network health probes (via Blackbox Exporter)" dashboard explaining:
    • What Blackbox Exporter probes are and what targets they check (AWS, Azure, GCP, DNS servers)
    • Purpose: helps identify network issues vs application bugs
    • How to interpret the dashboard (red sections, short vs prolonged failures)
    • Limitations of probe-based monitoring
  • Updates sidebar to add "Dashboards" as the 2nd item (between Introduction and Profiling)

Context

This addresses customer confusion about the network health probes dashboard (internal ref: CSM-165). The documentation explains what the dashboard shows and helps customers understand that short probe failures are usually nothing to worry about.

@hloeffler Hauke Löffler (hloeffler) requested a review from a team as a code owner January 13, 2026 10:07
Copilot AI review requested due to automatic review settings January 13, 2026 10:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the BBE (BlackBox Exporter) Probes dashboard to help customers understand network probe monitoring. The documentation explains what BBE probes are, what they monitor (cloud providers and DNS servers), how to interpret probe failures, and best practices for handling network issues in game servers.

Changes:

  • Added new "Dashboards" documentation page explaining BBE Probes from Nodes dashboard
  • Updated monitoring sidebar to include the new Dashboards page between Introduction and Audit Logs

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/multiplayer-servers/monitoring/dashboards.md New documentation page explaining BBE probe monitoring, dashboard interpretation, and best practices for handling network issues
src/multiplayer-servers/monitoring/sidebar.json Added "Dashboards" navigation item to the monitoring section sidebar

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
- Add warning callout explaining probe results are not causally
  consistent with network issues
- Clarify that probes only test specific routes and cloud services,
  not entire platforms
- Restructure Best Practices section for clarity
- Improve list introduction wording per style guidelines
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Move network reliability guidance to production-workloads/requirements.md
where it fits better contextually (PR #103).

Addresses review comment from Ullaakut.
Copilot AI review requested due to automatic review settings January 14, 2026 09:01
Hauke Löffler (hloeffler) added a commit that referenced this pull request Jan 14, 2026
Add guidance on handling network issues gracefully:
- Implement retry logic for failed connections
- Gracefully terminate after multiple connection attempts fail

Content moved from Monitoring > Dashboards page (PR #191) where
it was out of context.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
…oards-page

# Conflicts:
#	src/multiplayer-servers/monitoring/sidebar.json
- Remove Purpose sub-section; state purpose inline (Ullaakut)
- Restructure Interpreting the Dashboard section (Ullaakut)
- Change :::warning to :::note admonition (Ullaakut)
- Clarify DNS server IPs (Cloudflare, Google) (Copilot)
- Rename note title for clarity (Copilot, zoomoid)
- Use consistent punctuation and phrasing (Copilot)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Copilot AI review requested due to automatic review settings June 18, 2026 09:26
Co-authored-by: Copilot Autofix powered by AI <[email protected]>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Copilot AI review requested due to automatic review settings June 18, 2026 09:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Comment thread src/multiplayer-servers/monitoring/dashboards.md
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Copilot AI review requested due to automatic review settings June 18, 2026 12:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
Co-authored-by: Copilot Autofix powered by AI <[email protected]>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread src/multiplayer-servers/monitoring/dashboards.md Outdated
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.

4 participants