Skip to content

docs: update health checks (GF-1972)#227

Open
Philipp (fipsmassa) wants to merge 1 commit intomainfrom
ps/update-health-check
Open

docs: update health checks (GF-1972)#227
Philipp (fipsmassa) wants to merge 1 commit intomainfrom
ps/update-health-check

Conversation

@fipsmassa
Copy link
Contributor

@fipsmassa Philipp (fipsmassa) commented Feb 16, 2026

Goal of this PR

This PR updates the health check section to correctly reflect the new UI state with health checks being disabled by default.

How did I verify the changes?

  • ran docs locally and ensured rendering
  • text is agreed with product

Additional context

Fixes GF-1972

@fipsmassa Philipp (fipsmassa) self-assigned this Feb 16, 2026
@fipsmassa Philipp (fipsmassa) requested a review from a team as a code owner February 16, 2026 11:49
Copilot AI review requested due to automatic review settings February 16, 2026 11:49
@fipsmassa Philipp (fipsmassa) changed the title docs: update health checks docs: update health checks (GF-1972) Feb 16, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the “Health checks” documentation to reflect the current UI behavior where health checks are disabled by default, including an updated screenshot.

Changes:

  • Rewrites the health-check warning callout to describe the new default state and production recommendation.
  • Updates the “Advanced health checks” UI screenshot to match the current UI state.

Reviewed changes

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

File Description
src/multiplayer-servers/getting-started/running-your-game-server.md Updates the health-check warning copy to reflect “disabled by default” and production guidance.
src/multiplayer-servers/getting-started/images/formation/GUI_Create_Vessel_Advanced_Health_Checks.png Updates the screenshot used in the health-check section.

@0x0dr1y Chris (0x0dr1y) requested review from a team and removed request for a team February 16, 2026 13:23
unresponsive state cannot be automatically detected and cleaned up.
:::warning Health Checks: Default State & Best Practices
Health Checks are disabled by default to simplify the initial testing and integration of your Game Server SDK.
However, for production usage, it is recommended that they be enabled. If Health Checks remain disabled in a live environment, game servers that enter an unresponsive or "frozen" state cannot be automatically detected or cleaned up by the platform, leading to potential matchmaking failures.
Copy link
Contributor

Choose a reason for hiding this comment

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

might also add that we don't make any promises as to lifecycle handling of such game servers without health checks during maintenances; game servers without proper integration may be evicted at a moment's notice during maintenance.

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.

5 participants

Comments