Add observability documentation for self-hosted deployments#772
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✅ Files skipped from review due to trivial changes (5)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds an "Observability" docs section and eight MDX pages detailing OpenTelemetry/Prometheus metrics for Management, Signal, Relay, Proxy, combined deployments, naming conventions, Prometheus scrape examples, and Grafana dashboards. ChangesObservability Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/pages/selfhosted/observability/combined.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/selfhosted/observability/index.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON src/pages/selfhosted/observability/management.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
src/pages/selfhosted/observability/proxy.mdx (1)
1-67:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd missing import for the
<Warning>component.The file uses
<Warning>on lines 24-26 but does not import it. As per coding guidelines, custom components must be imported from@/components/mdx.📦 Proposed fix
Add this import at the top of the file after the description export:
export const description = 'Metrics recorded by the NetBird Proxy service.' + +import { Warning } from '`@/components/mdx`' # Proxy metricsAs per coding guidelines: "Import custom components from
@/components/mdx(Note, Warning, Success)".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/pages/selfhosted/observability/proxy.mdx` around lines 1 - 67, The document uses the custom MDX component Warning but never imports it; add an import for Warning from "`@/components/mdx`" near the top of the file (after export const description) so the <Warning> tag resolves; update the import block to include Warning alongside any existing MDX component imports (referencing the Warning symbol and the file's top-level export description for placement).src/pages/selfhosted/observability/relay.mdx (1)
1-47:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd missing import for the
<Note>component.The file uses
<Note>on lines 22-24 but does not import it. As per coding guidelines, custom components must be imported from@/components/mdx.📦 Proposed fix
Add this import at the top of the file after the description export:
export const description = 'Metrics recorded by the NetBird Relay service.' + +import { Note } from '`@/components/mdx`' # Relay metricsAs per coding guidelines: "Import custom components from
@/components/mdx(Note, Warning, Success)".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/pages/selfhosted/observability/relay.mdx` around lines 1 - 47, The MDX uses the custom <Note> component but doesn't import it; add an import for Note from "`@/components/mdx`" near the top of the file (after the existing export const description line) so the <Note> component is available during rendering; ensure the import references the named export Note from "`@/components/mdx`".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/pages/selfhosted/observability/index.mdx`:
- Line 11: The sentence in src/pages/selfhosted/observability/index.mdx stating
"Every server-side component exposes a `/metrics` HTTP endpoint. By default,
each listens on port `9090`." is inaccurate; update that sentence to clarify
that most components default to 9090 but the Proxy service defaults to 8080 (as
shown in the table). Edit the line containing that sentence so it either says
"most" instead of "each" or explicitly notes the Proxy exception (e.g., "By
default, most components listen on port 9090; the Proxy defaults to 8080"),
ensuring consistency with the table below.
- Line 67: Replace the incorrect sentence "metrics endpoints listen on all
interfaces" with accurate wording that reflects the table: mention that the
Proxy service listens on localhost (127.0.0.1) while other metrics endpoints may
be reachable externally depending on service configuration, and advise to
restrict access at the firewall/reverse-proxy/service-mesh so only Prometheus
and operators can scrape them; specifically update the sentence referencing
"metrics endpoints listen on all interfaces" and refer to the "Proxy service"
and the table that shows it bound to localhost to avoid the misleading blanket
statement.
---
Outside diff comments:
In `@src/pages/selfhosted/observability/proxy.mdx`:
- Around line 1-67: The document uses the custom MDX component Warning but never
imports it; add an import for Warning from "`@/components/mdx`" near the top of
the file (after export const description) so the <Warning> tag resolves; update
the import block to include Warning alongside any existing MDX component imports
(referencing the Warning symbol and the file's top-level export description for
placement).
In `@src/pages/selfhosted/observability/relay.mdx`:
- Around line 1-47: The MDX uses the custom <Note> component but doesn't import
it; add an import for Note from "`@/components/mdx`" near the top of the file
(after the existing export const description line) so the <Note> component is
available during rendering; ensure the import references the named export Note
from "`@/components/mdx`".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8cd2d4b5-8dec-47c3-ba3e-350855c98888
📒 Files selected for processing (8)
src/components/NavigationDocs.jsxsrc/pages/selfhosted/observability/combined.mdxsrc/pages/selfhosted/observability/dashboards.mdxsrc/pages/selfhosted/observability/index.mdxsrc/pages/selfhosted/observability/management.mdxsrc/pages/selfhosted/observability/proxy.mdxsrc/pages/selfhosted/observability/relay.mdxsrc/pages/selfhosted/observability/signal.mdx
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2 participants
Summary by CodeRabbit