Shumoku Docs

ドキュメントを検索

Server · next

検索を読み込み中…

English

このドキュメントは開発中のServerを対象としています。

server · stable

Shumoku Server概要

セルフホスト環境でTopology、監視データ、Dashboardを一つの画面にまとめます。

Shumoku Serverは、ネットワーク構成図と監視システムの観測データを組み合わせるセルフホスト型Webアプリケーションです。Topologyを複数のデータソースから構成し、状態や使用率を画面上で確認できます。

主な使い方

  • YAMLまたはManualソースからTopologyを作成する
  • Plugin経由でインベントリ、メトリクス、アラートを取得する
  • 複数のTopologyや状態WidgetをDashboardへ配置する
  • 読み取り専用の共有リンクを発行する
  • HTTP APIから構成、同期、描画、共有を操作する

Serverは入力形式やPlugin固有のフィールドを独自に再定義しません。YAMLの形式はYAMLリファレンス、HTTP endpointはServer API、Pluginの接続項目はPluginリファレンスがコードから生成されます。

導入後の流れ

  1. Serverをインストールして管理者としてログインします。
  2. Data Sourceを追加します。
  3. Topologyを作成し、必要なソースを接続します。
  4. 必要に応じてDashboardを作成し、共有範囲を設定します。