[doc] Document Relay metrics and healthcheck loopback binding

[quetz]

Operators running Relay on bare metal need to bind metrics and healthcheck to loopback. Document the standalone Relay host:port metrics syntax, existing healthcheck address flag, and their environment variables, including unchanged defaults and IPv6 examples.

Related to netbirdio/netbird#2836. Companion implementation: netbirdio/netbird#7468. Keep this draft until that implementation lands.

Validation: npm run build and npm run lint:mdx passed.

Summary by CodeRabbit

• Documentation
  • Documented standalone Relay metrics and health check listener binding.
  • Clarified that --metrics-port supports both port-only and host:port values.
  • Added IPv4 and IPv6 loopback configuration examples, including equivalent environment variables.
  • Clarified metrics and health check paths, default behavior, and port 0 handling.

[vercel]

Someone is attempting to deploy a commit to the NetBird GmbH Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: d938c8cd-b799-481e-8eeb-230369c1c215

📥 Commits

Reviewing files that changed from the base of the PR and between 1e79a0c and ff76a7b.

📒 Files selected for processing (1)

• src/pages/selfhosted/observability/relay.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The Relay observability documentation now describes standalone metrics and healthcheck listener binding. It documents port and host:port syntax, CLI and environment variable configuration, endpoint paths, defaults, and port 0 behavior.

Changes

Relay observability documentation

Layer / File(s)	Summary
Document listener configuration src/pages/selfhosted/observability/relay.mdx	Documents port and host:port syntax, IPv4 and IPv6 loopback bindings, CLI flags, environment variables, endpoint paths, defaults, and random-port behavior.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to ff76a

The documentation is ready to remain draft pending the related implementation; no merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main documentation change: documenting Relay metrics and healthcheck loopback binding.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/pages/selfhosted/observability/relay.mdx

typescript-eslint does not support TS 7.0.
Please see https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/#running-side-by-side-with-typescript-6.0 to run typescript-eslint using the TS 6 API.
See also typescript-eslint/typescript-eslint#10940 for tracking typescript-eslint's support for TS >=7.1

Oops! Something went wrong! :(

ESLint: 9.39.5

Error: typescript-eslint does not support TS 7.0.
at Object. (/.eslint-tmp/node_modules/typescript-eslint/dist/index.js:52:11)
at Module._compile (node:internal/modules/cjs/loader:1830:14)
at Object..js (node:internal/modules/cjs/loader:1961:10)
at Module.load (node:internal/modules/cjs/loader:1553:32)
at Module._load (node:internal/modules/cjs/loader:1355:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:255:19)
at Module.require (node:internal/modules/cjs/loader:1576:12)
at require (node:internal/modules/helpers:153:16)
at Object. (/.eslint-tmp/node_modules/eslint-config-next/dist/index.js:5:64)
at Module._compile (node:internal/modules/cjs/loader:1830:14)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit reads the Relay guide,
With metrics neatly side by side.
Ports and paths now clearly show,
Loopback streams begin to flow.
Health checks hop where listeners bide.}

_{Comment @coderabbitai help to get the list of available commands.}

[quetz]

Updated the commit author and committer email using a force push with an explicit lease. File contents are unchanged.