API Discoveryセットアップ 
¶
本記事では、API Discoveryモジュールの有効化、設定、およびデバッグの方法について説明します。
有効化¶
API Discoveryはすべての形態のWallarmノードインストールに含まれています。ノードのデプロイ時に、API Discoveryモジュールはインストールされますが、デフォルトでは無効状態となっています。
API Discoveryを正しく有効化して実行するには、次の手順に従ってください：
-
お使いのサブスクリプションプランにAPI Discoveryが含まれていることを確認してください。サブスクリプションプランを変更する場合は、sales@wallarm.comまでリクエストを送信してください。
-
Wallarm Console → API Discovery → Configure API Discoveryで、API Discoveryによるトラフィック分析を有効にしてください。
API Discoveryモジュールの有効化後、トラフィック分析およびAPIインベントリの構築が開始されます。APIインベントリはWallarm ConsoleのAPI Discoveryセクションに表示されます。
設定¶
「API Discovery」セクションのConfigure API Discoveryボタンをクリックすると、API Discoveryの調整オプションに進み、APIの検出対象アプリケーションの選択やリスクスコア計算のカスタマイズなどが可能になります。
API Discoveryの対象アプリケーションの選択¶
すべてのアプリケーションまたは選択したアプリケーションのみで、API Discoveryを有効または無効にすることができます：
-
記事Setting up applicationsに記載の手順に従い、アプリケーションを追加してください。
アプリケーションが設定されていない場合、すべてのAPIの構造が1つのツリーにまとめられます。
-
Wallarm Console → API Discovery → Configure API Discoveryで、必要なアプリケーションに対してAPI Discoveryを有効にしてください。
「Settings」→ Applicationsで新しいアプリケーションを追加すると、API Discoveryの対象アプリケーションリストに自動的にdisabled状態で追加されます。
リスクスコア計算のカスタマイズ¶
risk score計算における各要因の重みと計算方法を設定できます。
機微なデータ検出のカスタマイズ¶
API Discoveryは、APIによって使用および送信される機微なデータをsensitive dataとして検出し、強調表示します。既存の検出プロセスを調整し、独自のデータタイプを追加して検出対象を拡張することができます。
現在の設定を表示し、変更を加えるには、Wallarm ConsoleでAPI Discovery → Configure API Discovery → Sensitive dataに移動してください。ここで、既存の機微なデータパターンを確認および修正し、独自のパターンを追加することができます。
デバッグ¶
API Discoveryのログを取得して解析するには、次の方法を使用してください：
-
ノードが実行されているマシンで
/opt/wallarm/var/log/wallarm/appstructure-out.logログファイルを確認してください。 -
もしWallarmノードがKubernetes Ingressコントローラとしてデプロイされている場合は、Tarantoolと
wallarm-appstructureコンテナが実行されているpodの状態を確認してください。podの状態はRunningである必要があります。wallarm-appstructureコンテナのログを確認してください：