plantpulse-data-gateway (データゲートウェイ)
役割
外部システムとコンソールがデータを安全に照会する HTTP REST + JDBC ゲートウェイ です。リポジトリに直接接続せず、このゲートウェイを通してのみアクセスさせるセキュリティ・権限・監査レイヤであり、2026-09-07 からは コンソールの SQL 実行画面 でもあります。
| 項目 | 値 |
|---|---|
| モジュール名 | plantpulse-data-gateway |
| インストールパス | /opt/kopens/plantpulse-platform/plantpulse-data-gateway/ |
| ポート | 5500 (HTTP) · 5501 (TLS) |
pd サービス | data-gateway — MASTER のみ |
| API 認証 | X-API-Key: <PP_DATA_GATEWAY_API_KEY> |
| コンソールログイン | PP_DATA_GATEWAY_WEB_USER / PP_DATA_GATEWAY_WEB_PASSWORD — 空の場合はコンソールのみクローズします |
構成
4つのバックエンドに JDBC で接続します — コンソール 1 つの画面で SQL · CQL · TQL · Spark SQL が使えます。
ディレクトリ構造
plantpulse-data-gateway/
├── config/ # 생성물
│ ├── plantpulse-jdbc.properties # ← plantpulse-jdbc.properties.template — 백엔드 접속과 계정
│ └── plantpulse-data-gateway.properties # ← plantpulse-data-gateway.properties.template — 제한 · 타임아웃
├── bin/start.sh stop.sh
└── server/ # 내장 Tomcat — webapps/ROOT.war · logs/
主要設定
plantpulse-jdbc.properties.template のコア — バックエンド 4 つと認証情報がすべてここでレンダリングされます。
jdbc.postgres.url = jdbc:postgresql://${PP_POSTGRES_HOST}:${PP_POSTGRES_PORT}/${PP_DB_NAME}
jdbc.cassandra.url = jdbc:cassandra://${PP_CASSANDRA_HOST}:${PP_CASSANDRA_PORT}/${PP_SCHEME}
jdbc.tse.url = jdbc:ts://${PP_TSE_HOST}:${PP_TSE_PORT}/${PP_SCHEME}
jdbc.spark.url = jdbc:spark://${PP_SPARK_HOST}:${PP_KYUUBI_PORT}/default/${PP_SCHEME}
data.gateway.api.key = ${PP_DATA_GATEWAY_API_KEY} # X-API-Key
data.gateway.web.user = ${PP_DATA_GATEWAY_WEB_USER} # 콘솔 로그인
data.gateway.web.password = ${PP_DATA_GATEWAY_WEB_PASSWORD}
plantpulse-data-gateway.properties.template — 運用上の制限:
data.gateway.rate.limit=1000 # 초당 요청
data.gateway.slow.query.ms=10000 # 이보다 느리면 슬로우 로그
data.gateway.async.timeout.ms=60000
SQL コンソール
https://<server-ip>:5501/ で開き、PP_DATA_GATEWAY_WEB_USER / PP_DATA_GATEWAY_WEB_PASSWORD でログインします。管理コンソールの ツール 画面に Data Gateway カードがあります。旧 plantpulse-sql の SQL ツールはこれに統合されました → plantpulse-sql (廃止)
パスワードが空の場合、ログインフォームは拒否します。サイドカーに記入して再起動してください → ウェブ画面ログインアカウント
主要 API
# 표준 헬스체크 (익명, readiness — DB · InMemory · QueryLog 정상 시에만 UP. 이 경로만 HTTPS 강제 제외)
curl -fsS http://127.0.0.1:5500/api/health
# 200 {"status":"UP","service":"plantpulse-data-gateway-web",…,"checks":{"database":true,"inmemory":true,"query_log":true}}
# 태그 시계열 조회 (API 키 필요)
curl -fsS -H "X-API-Key: ${PP_DATA_GATEWAY_API_KEY}" \
"http://127.0.0.1:5500/api/v1/tags/TAG_001/values?from=2026-05-30T00:00:00Z&to=2026-05-30T23:59:59Z&limit=10000"
# QPS · 지연 메트릭
curl -fsS -H "X-API-Key: ${PP_DATA_GATEWAY_API_KEY}" http://127.0.0.1:5500/api/v1/metrics
運用コマンド
docker exec plantpulse-datalake pd status data-gateway
docker exec plantpulse-datalake pd restart data-gateway
docker exec plantpulse-datalake pd logs --lines 100 data-gateway
よくある問題
| 症状 | 原因 | 対応 |
|---|---|---|
| 403 / 401 | API キーが一致しない | passwd.sh PP_DATA_GATEWAY_API_KEY — サーバーとゲートウェイを同時に |
| コンソールログイン拒否 | PP_DATA_GATEWAY_WEB_PASSWORD が空 | サイドカー + restart-datalake.sh |
| Spark SQL だけ動作しない | Kyuubi が起動していない | pd status analytics — 起動直後の場合は 1 分後に |
| 応答が遅い | バックエンド負荷 | スロウログ、クエリ時間範囲を短縮 |
| 504 | リバースプロキシタイムアウト | nginx proxy_read_timeout |