Skip to content

Add External Monitoring page covering SNMP non-support and supported paths#463

Merged
lludlow merged 2 commits into
mainfrom
docs/external-monitoring-snmp
Jun 2, 2026
Merged

Add External Monitoring page covering SNMP non-support and supported paths#463
lludlow merged 2 commits into
mainfrom
docs/external-monitoring-snmp

Conversation

@jasnoyaeger

@jasnoyaeger jasnoyaeger commented Jun 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a new product guide page at docs/product-guide/tools-integrations/external-monitoring.md that explicitly states VergeOS does not support SNMP and explains why, with a rationale grounded in protocol design intent and the broader industry shift to API/Prometheus-based observability.
  • Consolidates the three supported external-monitoring paths into one page — Prometheus Exporter (ioMetrics) (recommended), REST API (x-yottabyte-token auth, Swagger at user icon > System > API Documentation), and IPMI (per-node hardware sensors).
  • Addresses SNMP-first tools (SolarWinds, LogicMonitor, PRTG, Nagios) with two paths: custom REST collectors (preferred) and community Prometheus-to-SNMP bridges (called out explicitly as not Verge-supported, no specific bridge endorsed).
  • Cross-links existing pages: prometheus-exporter.md, system/ipmi.md, and the api-guide.md KB article.
  • Adds the page to mkdocs.yml under Maintenance & Monitoring, alongside the existing Prometheus Exporter entry.

Closes #460

Test plan

  • Verify the page renders correctly on mkdocs serve and the warning admonition is prominent
  • Confirm the new entry appears under Maintenance & Monitoring in the left nav
  • Click each internal cross-link from the new page (Prometheus Exporter, IPMI, API Guide) and confirm they resolve
  • Confirm the Swagger UI path described (user icon > System > API Documentation) matches the current UI
  • CI: frontmatter validation, internal link checks, build passes

🤖 Generated with Claude Code

jasnoyaeger and others added 2 commits June 2, 2026 06:44
…paths

Documents that VergeOS does not support SNMP and consolidates the
supported external-monitoring options (Prometheus Exporter/ioMetrics,
REST API, IPMI) into a single page, with guidance for SNMP-first tools
like SolarWinds and LogicMonitor.

Closes #460

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…tive Prometheus ingestion

Removes inaccurate session-token/API-key conflation from the REST API
section and points readers at the canonical API Keys and API Guide pages.
Trims the Prometheus Exporter section so it no longer duplicates
prometheus-exporter.md, drops the redundant Summary section, and adds a
tip noting that LogicMonitor and SolarWinds Observability ingest
Prometheus metrics natively — so users of those platforms should use the
exporter path rather than a custom REST collector or SNMP bridge.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@lludlow lludlow merged commit 0d57c86 into main Jun 2, 2026
3 checks passed
@jasnoyaeger jasnoyaeger deleted the docs/external-monitoring-snmp branch June 2, 2026 13:36
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.

Docs: External Monitoring & SNMP Support in VergeOS

2 participants