Skip to content

Docs/health endpoint#1277

Closed
arekborucki wants to merge 2 commits into
mongodb-js:mainfrom
arekborucki:docs/health-endpoint
Closed

Docs/health endpoint#1277
arekborucki wants to merge 2 commits into
mongodb-js:mainfrom
arekborucki:docs/health-endpoint

Conversation

@arekborucki

Copy link
Copy Markdown
Contributor

Proposed changes

Adds a "Monitoring server" subsection under the HTTP transport docs, documenting the optional monitoring HTTP server exposed when running with --transport http:

  • documents the /health route (returns {"status":"ok"}) and the /metrics route
  • explains that the monitoring server starts only when both --monitoringServerHost and --monitoringServerPort are set
  • documents --monitoringServerFeatures (default health-check, optional metrics)
  • notes the deprecated --healthCheckHost / --healthCheckPort aliases
  • adds a runnable example with a curl health check

Checklist

@arekborucki arekborucki requested a review from a team as a code owner June 23, 2026 17:11
@arekborucki arekborucki requested review from csanx and removed request for a team June 23, 2026 17:11
@arekborucki arekborucki force-pushed the docs/health-endpoint branch from 7a4a3d4 to 8cd73a6 Compare June 25, 2026 17:43
@nirinchev

Copy link
Copy Markdown
Collaborator

There's already a PR that achieves mostly the same goal: #1267.

@nirinchev nirinchev closed this Jun 26, 2026
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