Konduo Manual

English

한국어

English

한국어

Appearance

Synology Plugin ​

Basic accessibility observation ​

Resource overviews show accessible, inaccessible, or access unknown independently of metric sources. Successful access does not attest healthy membership, replication, partitions, or workloads; use domain diagnostics and alerts for those conditions. Existing liveness/readiness fields are domain evidence and do not drive the single core-owned access alarm. Unknown observations do not resolve firing incidents.

Configuration acceptance alone does not verify access; this plugin leaves basic access unknown until a direct access probe is implemented.

Chart value semantics ​

State labels follow Synology MIB definitions and IF-MIB, not numeric severity ordering. Scrubbing/repair/update activity is distinguished from hardware failure. Mapping v3 retains target, disk, array and interface labels. UPS status is a device-provided string; no unsupported numeric enum is assumed. Unknown codes remain unknown.

Temperature/capacity and network comparisons each fill a three-chart row. Disk comparisons use two columns and a full-width final retry chart; storage I/O keeps its two full-width multi-device comparisons. Existing saved layouts and query definitions remain unchanged.

Six state/capacity summaries share a compact row, followed by temperature and capacity trends; a trend no longer stretches the status cards.

The Synology plugin registers Synology NAS targets as Konduo resources and exposes DSM status, RAID/volume, disk, fan, power, temperature, network, and storage IO signals.

This plugin is an SNMP sample and reference implementation, not a complete DSM management integration. It is excluded from the general resource-plugin feature-completeness roadmap. Maintenance is limited to contract compatibility, security and correctness fixes, and SNMP behavior verified with real device samples; DSM API configuration, package, storage, backup, and lifecycle management are not implied roadmap scope.

Highlights ​

  • Supports both Prometheus snmp_exporter and Konduo-managed direct SNMP collection.
  • Maps raw MIB metrics into Synology logical metrics.
  • Focuses dashboards on NAS health, capacity, disk health, storage IO, and network link/throughput.
  • Checks SNMP target setup, metric source linkage, required metric coverage, label model, and historical risk in diagnostics.
  • Adds read-only NAS evidence tabs for storage inventory, disk/RAID health, DSM update and UPS hints, capacity top lists, and data-protection boundaries.

Before Registration ​

  • Prepare NAS host, SNMP port, SNMP version, community, or SNMPv3 security settings.
  • In managed mode, the Konduo backend must reach the NAS SNMP endpoint directly.
  • When Prometheus is the managed collection write target, run Prometheus with --web.enable-remote-write-receiver.
  • In external mode, confirm snmp_exporter module and Prometheus scrape labels first.

Operations Tips ​

  • Labels such as diskID, raidName, and ifDescr are device evidence, not Konduo resource IDs.
  • Review volume utilization with RAID status and disk temperature/health to avoid missing capacity risk.
  • When terminal access is enabled, consider access policy and audit requirements.
  • terminal_timeout_seconds (default 5) covers the complete SSH connection and shell setup. Canceling creation stops unfinished setup; completed terminals keep their session lifetime.
  • Terminal capacity includes pending creation and active sessions. When a limit is reached, creation is rejected before the server contacts SSH.

Operator Views ​

  • The NAS health view highlights DSM system status, temperature, fan, power, and upgrade state.
  • Overview combines NAS status, RAID/volume capacity and network trends (12 default panels). Disk Details combines disk condition and storage I/O (7). State/count cards use compact values. All 29 catalog keys, 19 defaults and saved layouts remain available.
  • Disk details retain health, temperature, SSD life, bad-sector, and retry evidence. Storage IO compares physical-device read/write byte rates and read/write IOPS in two full-width charts.
  • Fresh dashboards select 19 of 29 catalog presets. Four former single-direction storage panels and the existing six optional panels remain available to saved layouts and manual personalization.
  • Network views expose Ethernet link state, throughput, and error/drop evidence while filtering loopback, Docker, and system interfaces by default.
  • Inventory and evidence views expose metric-backed storage pool, volume, disk, and IO query blueprints. They also show which NAS details require DSM API evidence, such as shared-folder capacity, snapshot/replication state, backup job history, reboot-required markers, and RAID rebuild progress.

Diagnostics And Alerts ​

  • Diagnostics separate SNMP target reachability, module and label coverage, required metric coverage, hardware risk, and historical risk.
  • Alert rules cover system faults, high temperature, fan/power faults, disk health, SSD life, bad sectors, RAID/volume state, utilization, and network link.
  • Disk, RAID/volume, and interface alerts identify the affected diskID, raidName, or ifDescr; alert details and notifications also include localized diagnostic guidance and a recommended action.
  • Managed SNMP collection and external snmp_exporter mode use the same raw MIB names, so the same mapping pack applies.
  • UPS hints use logical metrics for upsInfoStatus, upsBatteryChargeValue, and upsInfoLoadValue when the scrape profile exposes them. Direct managed SNMP UPS collection requires validated device OIDs before it can emit those raw samples.
  • SNMP labels can vary by device model and DSM/exporter version; validate coverage on the actual customer device.

Management Boundary ​

  • The plugin focuses on NAS observation and limited access-path support, not automated DSM configuration changes.
  • Volume create/delete, RAID changes, disk initialization, package management, and backup-job control are outside CE scope.
  • Shared-folder capacity rows, snapshot/replication status, backup success/failure history, live rebuild progress, and reboot-required confirmation stay read-only boundaries unless a DSM API-backed extension provides the evidence.
  • Enabling terminal access should not turn into arbitrary DSM automation.
  • SNMP community, SNMPv3 passwords, and terminal credentials stay inside the secret boundary.

Example Workflows ​

  • For volume utilization alerts, compare RAID status, volume free/total, disk health, and recent backup or snapshot growth.
  • For disk health alerts, interpret temperature, bad sectors, retry count, SSD life, and RAID redundancy together.
  • For fan or power alerts, review chassis temperature, system status, DSM events, and physical device state.
  • For network throughput drops, combine interface link state, errors/drops, bond/bridge configuration, and service latency.

RAID utilization requires a positive observed total size. Missing or zero total size is unavailable, not a synthetic 100% utilization. Empty volumes with valid capacity still report a real 0%.

Synology Enterprise Overlay ​

Basic accessibility observation ​

Resource overviews show accessible, inaccessible, or access unknown independently of metric sources. Successful access does not attest healthy membership, replication, partitions, or workloads; use domain diagnostics and alerts for those conditions. Existing liveness/readiness fields are domain evidence and do not drive the single core-owned access alarm. Unknown observations do not resolve firing incidents.

Configuration acceptance alone does not verify access; this plugin leaves basic access unknown until a direct access probe is implemented.

Chart value semantics ​

State labels follow Synology MIB definitions and IF-MIB, not numeric severity ordering. Scrubbing/repair/update activity is distinguished from hardware failure. Mapping v3 retains target, disk, array and interface labels. UPS status is a device-provided string; no unsupported numeric enum is assumed. Unknown codes remain unknown.

Temperature/capacity and network comparisons each fill a three-chart row. Disk comparisons use two columns and a full-width final retry chart; storage I/O keeps its two full-width multi-device comparisons. Existing saved layouts and query definitions remain unchanged.

Six state/capacity summaries share a compact row, followed by temperature and capacity trends; a trend no longer stretches the status cards.

Fresh dashboards select 19 of 29 catalog panels. Overview combines NAS health, RAID/volume capacity, and network trends (12 panels); Disk Details combines disk condition and storage I/O (7). States and counts use compact values. Storage byte rates and IOPS each pair read/write in a full-width chart. Former direction-specific and optional panels remain available to saved layouts.

This overlay extends the Community SNMP sample/reference plugin only to verify Enterprise contribution contracts. Synology is excluded from the general resource-plugin feature-completeness roadmap. Maintenance is limited to contract, security, correctness, and verified SNMP compatibility; this overlay does not imply a complete DSM management roadmap.

The Synology Enterprise overlay adds read-only risk analysis metadata on top of the Community Synology NAS evidence routes. It correlates storage pool, volume, disk, capacity, snapshot, replication, backup, UPS, DSM update, and network signals without performing DSM changes.

Highlights ​

  • Contributes an anomaly rule pack and anomaly/rules route through Enterprise metadata.
  • Adds correlation/storage-backup-risk to summarize weighted NAS storage and data-protection risk.
  • Publishes MCP descriptors for CE evidence routes and the EE correlation route.
  • Declarative metric rules evaluate Synology logical metrics through metric-source mapping.

Before Registration ​

  • Community Synology connectivity and metric-source mapping must be healthy.
  • Verify storage pool, volume, disk, capacity, backup, snapshot, replication, UPS, DSM update, and network metric coverage.
  • Decide whether anomaly and correlation analysis feeds alerting or remains diagnostic context.
  • If backup or snapshot details are not collected by the configured DSM/API or metric source, the correlation route reports the boundary instead of inventing compliance evidence.

Operations Tips ​

  • Interpret storage pool degradation, volume usage, disk errors, stale backups, snapshot or replication warnings, and network saturation together with replacement and backup policy.
  • Disk, RAID/volume, and interface alerts identify the affected diskID, raidName, or ifDescr; alert details and notifications also include localized diagnostic guidance and a recommended action.
  • Use the storage/backup risk correlation output as incident context. It is not a legal backup audit, RPO/RTO certification, or DSM remediation workflow.
  • Keep device-specific collection and base health behavior in CE; only Enterprise-only rule metadata belongs in the overlay.
  • terminal_timeout_seconds (default 5) covers the complete SSH connection and shell setup. Canceling creation stops unfinished setup; completed terminals keep their session lifetime.
  • Terminal capacity includes pending creation and active sessions. When a limit is reached, creation is rejected before the server contacts SSH.

Operational Scenarios ​

  • For NAS capacity risk, inspect storage pools, volume usage, disk health, and network throughput together to separate capacity alerts from failure signals.
  • When backup or file-service failures occur, connect Synology health with related host, network, and log evidence.
  • For a model or assistant workflow, use the MCP resources for storage inventory, disk health evidence, DSM/UPS hints, capacity top lists, data-protection evidence, anomaly rules, and storage/backup risk correlation.

MCP Resources ​

  • storage/inventory: storage pool, volume, disk, and IO inventory evidence.
  • diagnostics/disk-health: RAID status, disk health, SMART-proxy signals, and rebuild-progress boundaries.
  • diagnostics/system-hints: DSM update, UPS, and reboot-required hints.
  • capacity/top-lists: volume capacity top-list blueprints and shared-folder capacity boundaries.
  • data-protection/evidence: snapshot, replication, backup-job boundaries, and capacity context.
  • correlation/storage-backup-risk: Enterprise weighted correlation across NAS storage and data-protection evidence.
  • anomaly/rules: Enterprise declarative metric anomaly rules.

Boundaries ​

  • The Synology overlay provides storage-risk analysis metadata and does not perform device changes such as RAID rebuild, volume expansion, or package control.
  • MCP descriptors remain EE overlay metadata, with only edition-neutral hooks added to CE when needed.

RAID utilization requires a positive observed total size. Missing or zero total size is unavailable, not a synthetic 100% utilization. Empty volumes with valid capacity still report a real 0%.

MCP client coverage and result contracts ​

Storage inventory, disk health, DSM/UPS hints, capacity top lists, data-protection evidence and anomaly rules require resources/read. The risk-correlation tool covers correlation only; a tools-only client cannot read those evidence payloads.

describe_resource_instance lists resource metadata and available MCP entries; it does not return plugin resource results. Reads retain API key scopes, resource restrictions and current RBAC. No product client version is certified by this documentation. Tool inputs use the advertised types and bounds; defaults remain plugin-owned. Plugin evidence results are dynamic and intentionally omit optional outputSchema.