12.3. Network Observability CLI (oc netobserv) リファレンス
Network Observability CLI (oc netobserv
) は、Network Observability Operator で使用できるほとんどの機能とフィルタリングオプションを備えています。コマンドライン引数を渡すことで、機能やフィルタリングオプションを有効にできます。
12.3.1. Network Observability CLI の使用
Network Observability CLI (oc netobserv
)を使用して、コマンドライン引数を渡して、詳細な分析のためにフローデータ、パケットデータ、およびメトリクスをキャプチャーし、Network Observability Operator でサポートされる機能を有効にすることができます。
12.3.1.1. 構文
oc netobserv
コマンドの基本構文:
oc netobserv
の構文
$ oc netobserv [<command>] [<feature_option>] [<command_options>] 1
12.3.1.2. 基本コマンド
コマンド | 説明 |
---|---|
flows | フロー情報をキャプチャーします。サブコマンドについては、「フローキャプチャーのオプション」表を参照してください。 |
packets | パケットデータをキャプチャーします。サブコマンドについては、「パケットキャプチャーのオプション」表を参照してください。 |
metrics | メトリクスデータを取得します。サブコマンドはメトリクスキャプチャーオプションの表を参照してください。 |
follow | バックグラウンドで実行する場合は、コレクターログを確認してください。 |
stop | エージェント daemonset を削除してコレクションを停止します。 |
copy | コレクター生成されたファイルをローカルにコピーします。 |
cleanup | Network Observability CLI コンポーネントを削除します。 |
version | ソフトウェアのバージョンを出力します。 |
help | ヘルプを表示します。 |
12.3.1.3. フローキャプチャーのオプション
フローキャプチャーには、必須コマンドのほか、パケットドロップ、DNS 遅延、ラウンドトリップタイム、フィルタリングに関する追加機能の有効化などの追加オプションがあります。
oc netobserv flows
の構文
$ oc netobserv flows [<feature_option>] [<command_options>]
オプション | 説明 | デフォルト |
---|---|---|
--enable_all | すべての eBPF 機能を有効にする | false |
--enable_dns | DNS 追跡の有効化 | false |
--enable_network_events | ネットワークイベントの監視を有効にします | false |
--enable_pkt_translation | パケット変換の有効化 | false |
--enable_pkt_drop | パケットドロップの有効化 | false |
--enable_rtt | RTT 追跡の有効化 | false |
--enable_udn_mapping | ユーザー定義のネットワークマッピングの有効化 | false |
--get-subnets | サブネット情報を取得します。 | false |
--background | バックグラウンドで実行 | false |
--copy | 出力ファイルをローカルにコピー | prompt |
--log-level | コンポーネントログ | info |
--max-time | 最大キャプチャー時間 | 5m |
--max-bytes | 最大キャプチャーバイト数 | 50000000 = 50 MB |
--action | アクションのフィルタリング | Accept |
--cidr | CIDR のフィルタリング | 0.0.0.0/0 |
--direction | 方向のフィルタリング | – |
--dport | 送信先ポートのフィルタリング | – |
--dport_range | 送信先ポート範囲のフィルタリング | – |
--dports | 2 つの送信先ポートのどちらかでフィルタリング | – |
--drops | ドロップされたパケットのみでフローをフィルターする | false |
--icmp_code | ICMP コードのフィルタリング | – |
--icmp_type | ICMP タイプのフィルタリング | – |
--node-selector | 特定のノードでキャプチャー | – |
--peer_ip | ピア IP のフィルタリング | – |
--peer_cidr | フィルターピア CIDR | – |
--port_range | ポート範囲のフィルタリング | – |
--port | ポートのフィルタリング | – |
--ports | 2 つのポートのどちらかでフィルタリング | – |
--protocol | プロトコルのフィルタリング | – |
--regexes | 正規表現を使用したフィルターフロー | – |
--sport_range | 送信元ポート範囲のフィルタリング | – |
--sport | 送信元ポートのフィルタリング | – |
--sports | 2 つの送信元ポートのどちらかでフィルタリング | – |
--tcp_flags | TCP フラグのフィルタリング | – |
--interfaces | 監視するインターフェイス | – |
PacketDrop および RTT 機能を有効にして TCP プロトコルとポート 49051 でフローキャプチャーを実行する例:
$ oc netobserv flows --enable_pkt_drop --enable_rtt --enable_filter --action=Accept --cidr=0.0.0.0/0 --protocol=TCP --port=49051
12.3.1.4. パケットキャプチャーのオプション
フィルターを使用すると、キャプチャーするフローと同じで、パケットキャプチャーデータをフィルターできます。パケットドロップ、DNS、RTT、ネットワークイベントなどの一部の機能は、フローおよびメトリックの取得にのみ使用できます。
oc netobserv packets
の構文
$ oc netobserv packets [<option>]
オプション | 説明 | デフォルト |
---|---|---|
--background | バックグラウンドで実行 | false |
--copy | 出力ファイルをローカルにコピー | prompt |
--log-level | コンポーネントログ | info |
--max-time | 最大キャプチャー時間 | 5m |
--max-bytes | 最大キャプチャーバイト数 | 50000000 = 50 MB |
--action | アクションのフィルタリング | Accept |
--cidr | CIDR のフィルタリング | 0.0.0.0/0 |
--direction | 方向のフィルタリング | – |
--dport | 送信先ポートのフィルタリング | – |
--dport_range | 送信先ポート範囲のフィルタリング | – |
--dports | 2 つの送信先ポートのどちらかでフィルタリング | – |
--drops | ドロップされたパケットのみでフローをフィルターする | false |
--icmp_code | ICMP コードのフィルタリング | – |
--icmp_type | ICMP タイプのフィルタリング | – |
--node-selector | 特定のノードでキャプチャー | – |
--peer_ip | ピア IP のフィルタリング | – |
--peer_cidr | フィルターピア CIDR | – |
--port_range | ポート範囲のフィルタリング | – |
--port | ポートのフィルタリング | – |
--ports | 2 つのポートのどちらかでフィルタリング | – |
--protocol | プロトコルのフィルタリング | – |
--regexes | 正規表現を使用したフィルターフロー | – |
--sport_range | 送信元ポート範囲のフィルタリング | – |
--sport | 送信元ポートのフィルタリング | – |
--sports | 2 つの送信元ポートのどちらかでフィルタリング | – |
--tcp_flags | TCP フラグのフィルタリング | – |
TCP プロトコルとポート 49051 でパケットキャプチャーを実行する例:
$ oc netobserv packets --action=Accept --cidr=0.0.0.0/0 --protocol=TCP --port=49051
12.3.1.5. メトリクスキャプチャーオプション
機能を有効にし、フローキャプチャーと同様にメトリクスキャプチャーでフィルターを使用できます。生成されたグラフは、ダッシュボードに従って入力されます。
oc netobserv メトリクス
構文
$ oc netobserv metrics [<option>]
オプション | 説明 | デフォルト |
---|---|---|
--enable_all | すべての eBPF 機能を有効にする | false |
--enable_dns | DNS 追跡の有効化 | false |
--enable_network_events | ネットワークイベントの監視を有効にします | false |
--enable_pkt_translation | パケット変換の有効化 | false |
--enable_pkt_drop | パケットドロップの有効化 | false |
--enable_rtt | RTT 追跡の有効化 | false |
--enable_udn_mapping | ユーザー定義のネットワークマッピングの有効化 | false |
--get-subnets | サブネット情報を取得します。 | false |
--action | アクションのフィルタリング | Accept |
--cidr | CIDR のフィルタリング | 0.0.0.0/0 |
--direction | 方向のフィルタリング | – |
--dport | 送信先ポートのフィルタリング | – |
--dport_range | 送信先ポート範囲のフィルタリング | – |
--dports | 2 つの送信先ポートのどちらかでフィルタリング | – |
--drops | ドロップされたパケットのみでフローをフィルターする | false |
--icmp_code | ICMP コードのフィルタリング | – |
--icmp_type | ICMP タイプのフィルタリング | – |
--node-selector | 特定のノードでキャプチャー | – |
--peer_ip | ピア IP のフィルタリング | – |
--peer_cidr | フィルターピア CIDR | – |
--port_range | ポート範囲のフィルタリング | – |
--port | ポートのフィルタリング | – |
--ports | 2 つのポートのどちらかでフィルタリング | – |
--protocol | プロトコルのフィルタリング | – |
--regexes | 正規表現を使用したフィルターフロー | – |
--sport_range | 送信元ポート範囲のフィルタリング | – |
--sport | 送信元ポートのフィルタリング | – |
--sports | 2 つの送信元ポートのどちらかでフィルタリング | – |
--tcp_flags | TCP フラグのフィルタリング | – |
--interfaces | 監視するインターフェイス | – |
TCP ドロップのメトリクスキャプチャーの実行例
$ oc netobserv metrics --enable_pkt_drop --enable_filter --protocol=TCP