プロジェクト

全般

プロフィール

概要

# yfoxlogsrv — TCP/UDP ログ受信サーバー

ネットワーク経由(TCP / UDP、別ポート)でログテキストを受信し、**送信元IP・受信時刻**付きで
SQLite に保存する Windows サービスと、保存内容を閲覧する MFC 監視 GUI。

受信処理は既存の **yfoxnet** ライブラリ(`C:\debug\yfoxlib\yfoxnet`)を利用する。

## ドキュメント

設計・利用文書は [`docs/`](docs/README.md) にある:
[基本仕様書](docs/01_基本仕様書.md) / [詳細仕様書](docs/02_詳細仕様書.md) /
[UML 図集](docs/03_UML.md) / [関数説明書](docs/04_関数説明書.md) / [取扱説明書](docs/05_取扱説明書.md)

## 構成

| プロジェクト | 種類 | 役割 |
|---|---|---|
| `LogServerSvc` | コンソール/サービス exe (MFC共有DLL) | **本体**。TCP/UDP 受信 → SQLite 保存。サービス登録対応 |
| `LogMonitor`   | MFC ダイアログ exe | 監視 GUI。同一 DB を読み取り表示(ライブ更新・フィルタ・**ログレベル別の色分け/色設定**)+サービス操作(開始/停止/再起動/登録/解除) |

- 受信: TCP は yfoxnet `CServer`、UDP は yfoxnet `CSocketComm` を **生テキスト(非YF)モード**で使用。
- SQLite: **yfoxbase の `CSQLite` / `CSQLiteStmt`** を使用(amalgamation を別途同梱しない)。
  本サーバ用に `CSQLiteStmt`(プリペアド+バインド)を yfoxbase に追加している(後述)。
- 保存: 受信スレッドはロック付きキューへ投入し、**単一ライタースレッド**が `CSQLiteStmt` で
  トランザクションのバッチ INSERT(任意テキストも安全にバインド)。`PRAGMA journal_mode=WAL`
  で GUI から同時読み取り可能。
- スキーマ: `common/DbSchema.h`(`logs(id, recv_time, source_time, source_ip, source_port, protocol, level, message)`、
  `source_ip` と `recv_time` にインデックス)。`source_time`(送信元時刻)・`level`(plog 重大度トークン)は
  無ければ NULL。旧 DB へは起動時に冪等マイグレーションで両列を追加する。

## 前提(ビルド環境)

- Visual Studio 2022(v143)、Windows SDK 10、x64、**MFC は共有DLL**。
- **yfoxnet と yfoxbase をリンクするため、依存先が必要**:
  - ヘッダ: `C:\debug\yfoxlib\yfoxnet`(`YfoxNetDir`)、`C:\debug\yfoxlib\yfoxbase`(`YfoxBaseDir`)。
  - lib/dll: `C:\debug\yfoxlib\yfoxnet\x64\<Config>\yfoxnet.{lib,dll}` と
    `C:\debug\yfoxlib\yfoxbase\x64\<Config>\yfoxbase.{lib,dll}`。
  - yfoxnet/yfoxbase 自体のビルドには **plog** ヘッダが必要。各 `.vcxproj` は `$(SolutionDir)include`
    を見るので、`C:\debug\yfoxlib\yfoxnet\include\plog\` と `C:\debug\yfoxlib\yfoxbase\include\plog\`
    に配置する。
- `LogServerSvc`/`LogMonitor` 自体は **plog 不要**(`Server.h`/`SocketComm.h`/`SQLite.h` を直接
  include し、plog を含む傘ヘッダ `yfoxnet.h`/`yfoxbase.h` は使わない)。
- `LogServerSvc` は MFC共有DLLのコンソール exe(`AfxWinInit` を明示呼出。yfoxnet/yfoxbase は MFC拡張DLL)。

## ビルド手順

### 1. yfoxnet / yfoxbase をビルド(依存ライブラリ。**先に必要**)
本リポジトリは yfoxnet の `CServer`(任意送信元の生テキスト受信)と yfoxbase の `CSQLite`
(`CSQLiteStmt` 追加)に**後方互換な追加**を行っている(下記「ライブラリへの変更」)。変更後に再ビルドする。

```powershell
$msbuild = "C:\Program Files\Microsoft Visual Studio\2022\Professional\MSBuild\Current\Bin\MSBuild.exe" 
# plog を各ライブラリの include に配置(未配置の場合)
#   copy <plog>\plog -> C:\debug\yfoxlib\yfoxnet\include\plog
#   copy <plog>\plog -> C:\debug\yfoxlib\yfoxbase\include\plog
& $msbuild C:\debug\yfoxlib\yfoxnet\yfoxnet.vcxproj   /p:Configuration=Release /p:Platform=x64
& $msbuild C:\debug\yfoxlib\yfoxbase\yfoxbase.vcxproj /p:Configuration=Release /p:Platform=x64
```

### 2. 本ソリューションをビルド
```powershell
& $msbuild C:\debug\yfoxlogsrv\yfoxlogsrv.sln /p:Configuration=Release /p:Platform=x64
```
出力: `C:\debug\yfoxlogsrv\build\x64\Release\`(`LogServerSvc.exe` / `LogMonitor.exe` /
`yfoxnet.dll` / `yfoxbase.dll`(いずれも自動コピー))。

> Debug 構成でビルドする場合は、yfoxnet と yfoxbase も Debug|x64 でビルドしておくこと
> (両 exe は `…\x64\$(Configuration)\*.lib` をリンクするため)。

## 配置と設定

`config.ini` を exe と同じフォルダに置く(リポジトリ直下のものをコピー)。

```ini
[server]
BindAddress=0.0.0.0   ; 待ち受けアドレス(全IF=0.0.0.0)
TcpPort=5515          ; TCP と UDP は別ポート
UdpPort=5514
MaxLineBytes=65536    ; TCP の1行最大バイト(メモリ防御)
[db]
Path=logs.db          ; 相対パスは exe 基準
LogPath=logserver.log ; サービス自身の動作ログ
BatchSize=200         ; INSERT バッチ最大件数
FlushMs=500           ; またはこの間隔(ms)でフラッシュ
```
実行時に `yfoxnet.dll` / `yfoxbase.dll` と MFC/VC ランタイム(`mfc140u.dll` 等)が必要。
MFC ランタイムは VS導入機なら System32 にある。

## 実行

### コンソールモード(デバッグ用)
```powershell
cd C:\debug\yfoxlogsrv\build\x64\Release
.\LogServerSvc.exe -console      # Ctrl+C で停止
```

### サービスとして
```powershell
# 管理者権限の PowerShell で
.\LogServerSvc.exe -install       # サービス登録(自動起動)
net start YfoxLogServer
# ...
net stop  YfoxLogServer
.\LogServerSvc.exe -uninstall     # 登録解除
```
サービス名: `YfoxLogServer`。動作ログは `config.ini` の `LogPath`(既定 `logserver.log`)。

### 監視 GUI
```powershell
.\LogMonitor.exe
```
`config.ini` の `db/Path` を読み、最新ログを一覧表示。送信元IP・本文・**ログレベル**でフィルタ、
`Auto` で自動更新(1秒間隔、新着検知時のみ再読込)。

行の文字色は**ログレベル別**(既定: FATAL=紫 / ERROR=赤 / WARN=橙 / INFO=青 / DEBUG=緑 /
VERB=灰 / レベルなし=黒)。「Colors...」ボタンでレベル毎の色を変更でき、`config.ini` の `[colors]`
セクション(`Level0`〜`Level6`)に保存して**同一インストールの全ユーザで共有**する
(`config.ini` が `Program Files` 等の保護フォルダにある場合、保存には管理者権限が必要)。

## 動作確認(送信テスト, PowerShell)
```powershell
# UDP -> 5514
$u=New-Object Net.Sockets.UdpClient
$b=[Text.Encoding]::UTF8.GetBytes("udp test log`n")
$u.Send($b,$b.Length,"127.0.0.1",5514); $u.Close()

# TCP -> 5515
$c=New-Object Net.Sockets.TcpClient("127.0.0.1",5515); $s=$c.GetStream()
$b=[Text.Encoding]::UTF8.GetBytes("tcp test log`n"); $s.Write($b,0,$b.Length); $c.Close()
```
保存確認(sqlite3 CLI があれば):
```
sqlite3 logs.db "SELECT id,recv_time,source_time,source_ip,source_port,protocol,level,message FROM logs ORDER BY id DESC LIMIT 5;" 
```

## 受信仕様メモ
- TCP はストリームのため `\n` で行分割し、送信元ごとに部分行を持ち越して再結合(1行=1レコード)。
  改行で終わらない末尾は次の受信まで保留(`MaxLineBytes` 超で強制フラッシュ)。
- UDP は1データグラム=1メッセージ(改行を含む場合は分割)。
- 末尾の `\r` / NUL はトリム。本文は UTF-8 として TEXT 保存。
- 送信元: TCP は接続の `from`、UDP は `recvfrom` の送信元から取得。

## ライブラリへの変更(後方互換)

### yfoxbase(SQLite)
`C:\debug\yfoxlib\yfoxbase\SQLite.h` / `SQLite.cpp` に追加(既存挙動は不変):
- `sqlite3* CSQLite::getHandle() const` — 生ハンドル取得アクセサ。
- `class CSQLiteStmt` — プリペアドステートメントのラッパ
  (`bindText/bindInt/bindInt64/bindNull` / `step` / `stepResult` / `reset` / 列アクセス)。
  既存 `CSQLite::exec()` は `sqlite3_exec`+文字列SQL のためログ本文(引用符等)の INSERT に
  不向き。本クラスにより**安全なバインド**と**プリペアド再利用**で高速・安全に書き込む。
  `stepResult()` は `sqlite3_step` の生 rc を返し、INSERT の成否(`SQLITE_DONE`)を判定できる。
  書き込み(`DbWriter`)と GUI のフィルタ付き SELECT(`DbReader`)で使用。

### yfoxnet(TCP 受信)
`C:\debug\yfoxlib\yfoxnet\Server.h` / `Server.cpp` / `SocketComm.h` / `SocketComm.cpp` に
既定 OFF のフラグ・仮想関数等を追加(既定では従来挙動を維持し、本サーバ用途のみ有効化):

- `bool CServer::m_bOpenServer`(既定 `false`): ON で①未登録IPの接続も受理、
  ②非YF生テキストを送信元付きで通知。
- `virtual void CServer::OnClientText(const SockAddrIn&, const LPBYTE, int)`: 生テキスト受信フック。
- `virtual void CServer::OnClientClosed(const SockAddrIn&)`: 切断フック。送信元単位に保持した
  状態(部分行バッファ等)を破棄する用途(`carry_` リーク/混入の防止)。
- `void CServer::Stop()`: accept と全 ServerSub を停止・join(冪等)。**派生メンバ破棄前に明示
  呼出**することで、基底 `~CServer` の join より前に派生メンバ(mutex/map)が壊れる UAF を防ぐ。
- 停止応答性: 開放モード時は accept/recv を**有限タイムアウトでポーリング**し `m_bStopping` に即応。
  `ReadComm` はタイムアウト時に番兵 `SOCKET_RECV_TIMEOUT` を返す(切断 `0` と区別)。`closesocket`
  が別スレッドの `select` を確実には起こさない Windows 仕様に依存せず、確実・即時に停止できる。
- `ReadComm` 非YF経路の修正: 切断(`recv==0`)/エラーで `0` を返す(YF 経路と対称)。これを欠くと
  ServerSub が `EVT_CONDROP` を吐き続けるビジーループになっていた。
- `ServerThreadProc`/`ServerSub`: 非YF(`bNotYFMode`)反映は `m_bOpenServer` でゲートし、開放
  モード以外は厳密に従来どおり。開放モード時は未登録IPに簡易IDを採番、非YFは `OnClientText` で通知。

UDP 側は `LogUdpServer` が `CSocketComm::Run()` を override(有限タイムアウトでポーリングし、空/
エラーのデータグラムや停止で受信ループが正しく継続/終了する)。

時間管理

  • 予定工数: 0:00時間
  • 作業時間: 120:00時間

詳細 | レポート

メンバー

Manager: 藤崎

Developer: 藤崎

Reporter: 藤崎

Redmine Appliance - Powered by TurnKey Linux