twsnmpfc

README

twsnmpfc

コンテナ環境対応のTWSNMP(TWSNMP For Container)

Overview

コンテナ環境で動作するTWSNMPを開発するプロジェクトです。 コンテナ以外の環境(Windows,Linux,Max OS)でも動作します。

Status

実現したい機能は全て対応しました。

１日100GBのログを受信する環境でデータストアのサイズが5.4TBまで耐えることが できました。

• マップ表示
• 自動発見
• ポーリング（PING,SNMP,HTTP,TLS,DNS,NTP,VMWare..)
• MIBブラウザー
• ログ受信検索表示（Event Log,Syslog,SNMP TRAP,NetFlow,IPFIX,ARP Watch)
• レポート（デバイス、ユーザー、サーバー、フロー、IPアドレス）
• AI分析
• ログ、ポーリング結果の分析機能(FFT,ヒストグラム、クラスター)
• サーバー証明書レポート（発行者、期限、検証状態）
• センサーレポート（syslog,NetFlow,IPFIX,TWPCAP,TWWINLOG,twBlueScan,twWifiScan）
• twpcap連携レポート（EtherType,TLS,RADIUS,DNS問い合わせ）
• twWinLog連携レポート（イベントID、ログオン、アカウント操作...）
• twBlueScan連携レポート（デバイス、オムロン環境センサー）
• twWifiScan連携レポート（アクセスポイント）
• パネル表示
• ホストリソースMIB
• Wake On LAN対応
• Discordへの通知
• HTMLメール通知、定期レポート
• 異常検知アルゴリズムのIsolation Forestに対応(v1.10.0)
• PWAに対応(v1.10.0)
• ノードへのPING対応(v1.12.0)
• ポートリスト対応(v1.12.0)
• 通知のためにコマンドを実行する機能(v1.13.0)
• RTL-SDRで電波強度を測定するtwSdrPowerのレポート機能(v1.14.0)
• SwitchBot Plug Miniで測定した電力レポート機能(v1.14.0)
• グリッド整列(v1.14.0)
• RMON管理対応(v1.16.0)
• MIB管理(v1.19.0)
• マップの描画アイテム対応(v1.20.0)
• スクリプト編集のカラーリング対応、マップの最大化ボタン追加(v1.21.0)
• MIBブラウザーからポーリング作成に対応(v1.22.0)
• 描画アイテムにポーリング情報を追加(v1.23.0)
• セッションタイムアウトの改善、MIB表示の改善(v1.24.0)
• 起動ツールの改善(v1.25.0)
• HTTP/SNMPポーリングの改善、LXIポーリングの追加(v1.26.0)

Build

Build Env

ビルドするためには、以下の環境が必要です。

• go 1.20
• node.js npm
• statik
• docker(Docker版をビルドする場合)

statikは https://github.com/rakyll/statik

です。 私はMac OSでビルドしていますが、実行ファイルだけならばLinxu(Debian/Ubuntu)や Docker環境でビルドできます。

$docker run -it golang:1.20 /bin/bash

で起動したDokcerコンテナ内のLinux環境で

#cd /root
#git clone https://github.com/twsnmp/twsnmpfc.git
#cd twsnmpfc
#./build_setup.sh
#make

でビルドできると思います。

Build

ビルドはmakeで行います。

$make

以下のターゲットが指定できます。

  all        全実行ファイルのビルド（省略可能）
  mac        Mac用の実行ファイルのビルド
  docker     Docker Imageのビルド
  dockerarm  ARM版Docker Imageのビルド
  clean      ビルドした実行ファイルの削除
  zip        リリース用のZIPファイルを作成

$make

を実行すれば、MacOS,Windows,Linux(amd64),Linux(arm)用の実行ファイルが、distのディレクトリに作成されます。

Dockerイメージを作成するためには、

$make docker

を実行します。twssnmp/twsnmpfcというDockerイメージが作成されます。

配布用のZIPファイルを作成するためには、

$make zip

を実行します。ZIPファイルがdist/ディレクトリに作成されます。

Run

Mac OS,Windows,Linuxの環境でコマンドを実行する場合は、 datastoreのディレクトリを作成してコマンドを起動します。

#mkdir datastore
#./twsnmpfc

Dockerが動作する環境で以下のコマンドを実行すれば動作します。 datastore用のボリュームを作成します。（ローカルのディレクトリをマウントしてもよいです。）

#docker volume create twsnmpfc

ARP監視を使わない場合はDokcerのプラベートネットワークを使用します。

#docker run --rm -d --name twsnmpfc -p 8080:8080 -v twsnmpfc:/datastore  twsnmp/twsnmpfc

ARP監視を使いたい場合は、ホストのネットワークを指定します。

#docker run --rm -d  --name twsnmpfc  --net host -v twsnmpfc:/datastore  twsnmp/twsnmpfc

Copyright

see ./LICENSE

Copyright 2021 Masayuki Yamai