コンテンツにスキップ

FLOW_COUNTER_ROUTE_PATTERN (RouteOrch / FlowCounterRouteOrch)

概要

orchagent 内の RouteOrch は APPL_DB の ROUTE_TABLE を購読して SAI route エントリを管理するが、CONFIG_DB を直接購読しない。

CONFIG_DB を購読するのは同じ orchagent プロセス内の FlowCounterRouteOrch であり、CONFIG_DB FLOW_COUNTER_ROUTE_PATTERN テーブルからルートフローカウンターのパターンを受け取る1。

関連ページ

データフロー

flowchart LR
  CLI["sonic-utilities<br/>config flow_counters route add"]
  CFGDB[("CONFIG_DB<br/>FLOW_COUNTER_ROUTE_PATTERN")]
  FC["orchagent<br/>FlowCounterRouteOrch"]
  RO["orchagent<br/>RouteOrch"]
  SAI["SAI<br/>sai_route_api"]
  ASIC["ASIC"]
  CLI --> CFGDB
  CFGDB --> FC
  FC -->|bindFlowCounter| SAI
  RO -->|addRoute/removeRoute| SAI
  SAI --> ASIC

凡例

FlowCounterRouteOrch は RouteOrch が管理する SAI route エントリに flex counter を付与する。

key 構造

FLOW_COUNTER_ROUTE_PATTERN:<prefix>
FLOW_COUNTER_ROUTE_PATTERN:<vrf_name>|<prefix>
  • <prefix> は IPv4 / IPv6 プレフィックス（例: 10.0.0.0/8、2001:db8::/32）。
  • <vrf_name> は VRF 名（例: Vrf-RED）または VNET 名。セパレータは |。
  • デフォルト VRF の場合は <vrf_name> を省略し <prefix> のみ記述する。
  • <prefix> がデフォルトルート（0.0.0.0/0 / ::/0）の場合は 完全一致 パターンとして扱われる2。
  • 重複・包含関係にあるパターンは登録時にエラーとなる（validateRoutePattern()）1。

主要フィールド

フィールド 型 コード由来デフォルト 説明
max_match_count uint 30 このパターンに一致する経路へ付与するフローカウンターの最大数。0 を設定すると無効値として 30 にフォールバックする

コード由来デフォルト詳細

max_match_count — デフォルト 30、0 フォールバックあり

FlowCounterRouteOrch::doTask() の SET ハンドラ1:

// flowcounterrouteorch.cpp
#define ROUTE_PATTERN_DEFAULT_MAX_MATCH_COUNT       30

size_t maxMatchCount = ROUTE_PATTERN_DEFAULT_MAX_MATCH_COUNT;
for (auto valuePair : data)
{
    const auto &field = fvField(valuePair);
    const auto &value = fvValue(valuePair);
    if (field == ROUTE_PATTERN_MAX_MATCH_COUNT_FIELD)
    {
        maxMatchCount = (size_t)std::stoul(value);
        if (maxMatchCount == 0)
        {
            SWSS_LOG_WARN("Max match count for route pattern cannot be 0, set it to default value 30");
            maxMatchCount = ROUTE_PATTERN_DEFAULT_MAX_MATCH_COUNT;
        }
    }
}
  • max_match_count フィールドが存在しない場合: 30 が使用される。
  • max_match_count = 0 が設定された場合: 警告ログを出力して 30 にフォールバックする。
  • Python 側でも DEFAULT_MAX_MATCH = 30 として同値が定義されており、CLI 表示のデフォルト値と一致する3。

max_match_count を更新すると onRoutePatternMaxMatchCountChange() が呼ばれ、既存バインド済みカウンターの増減が即時反映される1:

  • 新しい上限 > 旧上限: 上限まで新規バインドを追加する。
  • 新しい上限 < 旧上限: 超過分のカウンターを即時アンバインドして解放する。

FlexCounter ポーリングインターバル — 固定 10000ms

FlowCounterRouteOrch の FlexCounter グループは 10000ms（10 秒）ポーリング間隔でハードコードされており、CONFIG_DB から変更できない1:

// flowcounterrouteorch.cpp
#define ROUTE_FLOW_COUNTER_POLLING_INTERVAL_MS      10000

プラットフォームサポート確認

FlowCounterRouteOrch は初期化時に FlowCounterHandler::queryRouteFlowCounterCapability() を呼び出してプラットフォームのサポート状況を確認する。サポートしない場合は CONFIG_DB のパターン変更を無視する1:

void FlowCounterRouteOrch::doTask(Consumer &consumer)
{
    if (!gRouteOrch || !mRouteFlowCounterSupported)
    {
        return;
    }
    ...
}

サポート状態は STATE_DB FLOW_COUNTER_CAPABILITY_TABLE|route の support フィールドに "true" / "false" として書き込まれる。

パターンマッチングロジック

RoutePattern::is_match() による一致判定2:

bool is_match(sai_object_id_t vrf, IpPrefix prefix) const
{
    if (vrf_id != vrf) return false;

    if (!exact_match)
    {
        // prefix がパターンのサブネット内にあれば一致
        return (ip_prefix.getMaskLength() <= prefix.getMaskLength()
                && ip_prefix.isAddressInSubnet(prefix.getIp()));
    }
    else
    {
        // デフォルトルートパターンは完全一致のみ
        return prefix == ip_prefix;
    }
}
  • 通常パターン（非デフォルトルート）: パターンのプレフィックス長 ≤ 経路のプレフィックス長 かつ IP がサブネット内に収まれば一致。
  • デフォルトルートパターン（0.0.0.0/0 / ::/0）: 完全一致のみ（exact_match = true）。

制約

  • 重複・包含関係にあるパターンは登録不可（validateRoutePattern() でエラー）。
  • max_match_count = 0 は無効値。
  • ルートフローカウンターがサポートされないプラットフォームでは、パターン登録は受け付けられるが実際のバインドは行われない。
  • パターン削除時は対応する SAI counter が即時アンバインドされ、COUNTERS_DB からも削除される。

購読者 / 生成者

  • 生成者: sonic-utilities の config flow_counters route add/del コマンド3
  • 購読者: orchagent の FlowCounterRouteOrch（doTask(Consumer &consumer)）1

関連 CONFIG_DB / YANG / CLI

  • 関連 CONFIG_DB: STATIC_ROUTE（静的経路の設定元）、VRF
  • 関連 APPL_DB: ROUTE_TABLE（RouteOrch が購読する経路テーブル）
  • 関連 CLI: config flow_counters route、show flow_counters route
  • 関連 YANG: 未定義（スキーマの正本は flowcounterrouteorch.cpp / flow_counter_util/route.py）

関連リファレンス

引用元

運用ヒント

確認コマンド

# 設定済みパターン一覧
sonic-db-cli CONFIG_DB keys 'FLOW_COUNTER_ROUTE_PATTERN:*'

# 特定パターンの詳細
sonic-db-cli CONFIG_DB hgetall 'FLOW_COUNTER_ROUTE_PATTERN:10.0.0.0/8'

# フローカウンター有効化状態の確認
sonic-db-cli STATE_DB hgetall 'FLOW_COUNTER_CAPABILITY_TABLE|route'

# カウンター値の確認
show flow_counters route

典型エントリ例

# デフォルト VRF の /24 以上の経路に対してカウンター付与（最大 30 経路）
FLOW_COUNTER_ROUTE_PATTERN:10.0.0.0/8
  max_match_count: 30

# VRF-RED の IPv6 /64 以上の経路（最大 10 経路）
FLOW_COUNTER_ROUTE_PATTERN:Vrf-RED|2001:db8::/32
  max_match_count: 10

よくある問題

  • カウンターが付与されない → show flow_counters route の前に STATE_DB FLOW_COUNTER_CAPABILITY_TABLE|route の support が "true" であることを確認する。
  • パターン登録でエラー → 既存パターンと IP 範囲が重複または包含関係にないか確認する（validateRoutePattern() チェック）。
  • max_match_count を減らしたのに反映されない → FlexCounter タイマー（1 秒）待機後に COUNTERS_DB を再確認する。

  1. FlowCounterRouteOrch 実装: orchagent/flex_counter/flowcounterrouteorch.cpp. https://github.com/sonic-net/sonic-swss/blob/4305596156d70e9797e8a881b3d19b46de0bce0d/orchagent/flex_counter/flowcounterrouteorch.cpp ↩↩↩↩↩↩↩

  2. RoutePattern 構造体・is_match ロジック: orchagent/flex_counter/flowcounterrouteorch.h. https://github.com/sonic-net/sonic-swss/blob/4305596156d70e9797e8a881b3d19b46de0bce0d/orchagent/flex_counter/flowcounterrouteorch.h ↩↩

  3. テーブル名・デフォルト値定数: flow_counter_util/route.py. https://github.com/sonic-net/sonic-utilities/blob/master/flow_counter_util/route.py ↩↩