Skip to content

Document the client local metrics endpoint - #952

Open
lixmal wants to merge 2 commits into
mainfrom
client-local-metrics
Open

Document the client local metrics endpoint#952
lixmal wants to merge 2 commits into
mainfrom
client-local-metrics

Conversation

@lixmal

@lixmal lixmal commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Documents the client-side Prometheus /metrics endpoint added in netbirdio/netbird#6689.

New page Client → Local Metrics Endpoint (/client/local-metrics):

  • Enabling with netbird up --enable-local-metrics and --local-metrics-address, and that the setting is per profile
  • Why the endpoint stays on loopback, and that binding elsewhere requires root / administrator privileges
  • A Prometheus scrape config
  • Reference for every exposed metric and label value, split into the scrape-time gauges and the histograms the client records as it runs

Also:

  • dashboards.mdx: adds the client Grafana dashboard alongside management/signal/relay, its template variables, and a note that it scrapes clients rather than a server component
  • mdm-integration.mdx: adds the enableLocalMetrics and localMetricsAddress keys, plus a note on how an MDM-pushed address relates to the privilege check. Corrects the key count, which was already stale at 16 against an 18-row table
  • manage/client-metrics.mdx: links to the new page from the metrics-push docs, since both surface the same underlying client metrics
  • Navigation entry under CLIENT

@vercel

vercel Bot commented Aug 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 26, 2026 7:13pm

Request Review

@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

Next included review available in 57 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e00e7dfb-7da8-4049-8b02-38208f7c5135

📥 Commits

Reviewing files that changed from the base of the PR and between f7433ce and b42bf56.

📒 Files selected for processing (5)
  • src/components/NavigationDocs.jsx
  • src/pages/client/local-metrics.mdx
  • src/pages/client/mdm-integration.mdx
  • src/pages/manage/client-metrics.mdx
  • src/pages/selfhosted/observability/dashboards.mdx
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch client-local-metrics

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

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

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.

1 participant