コンテンツにスキップ

COUNTERS_DB RIF カウンタ

概要

intfsorch（orchagent 内）が SAI の flex counter 機構を通じて L3 Router Interface (RIF) ごとに取得する統計カウンタ群1。値は COUNTERS_DB の COUNTERS:<oid> に格納され、intfstat コマンドが読み出す。rate 統計は RATES:<oid> に別途格納される。

データフロー (自動生成)

flowchart LR
  CFG[("CONFIG_DB<br/>FLEX_COUNTER_TABLE|RIF")]
  ORC["intfsorch"]
  syncd["syncd<br/>FlexCounter"]
  HW["SAI / ASIC"]
  CNTDB[("COUNTERS_DB<br/>COUNTERS:<oid>")]
  RATES[("COUNTERS_DB<br/>RATES:<oid>")]
  CFG --> ORC
  ORC --> syncd
  syncd --> HW
  HW --> syncd
  syncd --> CNTDB
  syncd -->|"rif_rates.lua"| RATES

凡例

CONFIG_DB の FLEX_COUNTER_TABLE|RIF が enable になると intfsorch が SAI カウンタ ID リストを syncd へ投入。syncd が 1 s ごとにポーリングして COUNTERS_DB を更新し、rif_rates.lua Lua プラグインがレート計算結果を RATES テーブルへ書き込む。

key 構造

RIF 名→OID マップ

COUNTERS_DB / COUNTERS_RIF_NAME_MAP   (Hash)
  field: <rif_name>   (例: Ethernet0, Vlan1000, PortChannel0001)
  value: <SAI OID>    (例: oid:0x6000000000001)

RIF タイプ→OID マップ

COUNTERS_DB / COUNTERS_RIF_TYPE_MAP   (Hash)
  field: <SAI OID>
  value: <type>       (例: port, lag, vlan, subport)

カウンタハッシュ

COUNTERS_DB / COUNTERS:<oid>           (Hash)
  field: <SAI_ROUTER_INTERFACE_STAT_*>
  value: <uint64 カウンタ値 (文字列)>

レートハッシュ

COUNTERS_DB / RATES:<oid>              (Hash)
  field: RX_BPS | RX_PPS | TX_BPS | TX_PPS
  value: <float 文字列>

フィールド一覧

以下は intfsorch.cpp の rifStatIds[] に定義されている全 SAI カウンタ ID2。

RIF カウンタ

SAI フィールド 意味
SAI_ROUTER_INTERFACE_STAT_IN_PACKETS 受信パケット数
SAI_ROUTER_INTERFACE_STAT_IN_OCTETS 受信バイト数
SAI_ROUTER_INTERFACE_STAT_IN_ERROR_PACKETS 受信エラーパケット数
SAI_ROUTER_INTERFACE_STAT_IN_ERROR_OCTETS 受信エラーバイト数
SAI_ROUTER_INTERFACE_STAT_OUT_PACKETS 送信パケット数
SAI_ROUTER_INTERFACE_STAT_OUT_OCTETS 送信バイト数
SAI_ROUTER_INTERFACE_STAT_OUT_ERROR_PACKETS 送信エラーパケット数
SAI_ROUTER_INTERFACE_STAT_OUT_ERROR_OCTETS 送信エラーバイト数

RATES テーブル

syncd が rif_rates.lua を定期実行して計算した派生レートを RATES:<oid> に書く3。

フィールド 意味
RX_BPS 受信ビットレート (bps)
RX_PPS 受信パケットレート (pps)
TX_BPS 送信ビットレート (bps)
TX_PPS 送信パケットレート (pps)

書き込み経路

COUNTERS_DB は直接 CONFIG_DB から書かれず、すべて orchagent / syncd 経由で書かれる。

経路 詳細
intfsorch 初期化 COUNTERS_RIF_NAME_MAP に RIF 名→OID、COUNTERS_RIF_TYPE_MAP に OID→タイプを書き込み
syncd FlexCounter FLEX_COUNTER_TABLE|RIF が enable になった後、1 秒ごとに SAI カウンタをポーリングして COUNTERS:<oid> を更新
syncd Lua プラグイン rif_rates.lua が RATES:<oid> の RX_BPS / RX_PPS / TX_BPS / TX_PPS を書き込み

関連 CONFIG_DB / CLI

  • CONFIG_DB: FLEX_COUNTER_TABLE — ポーリング有効化と間隔設定
  • CLI: intfstat（L3 インタフェース統計表示）、counterpoll rif enable/disable/interval

暗黙デフォルト・コード由来挙動 (Phase A)

ポーリング間隔のコード由来デフォルト

FLEX_COUNTER_TABLE|RIF に POLL_INTERVAL が設定されていない場合、intfsorch が ハードコードした初期値で syncd に投入する4。

カウンタグループ ハードコード定数 値
RIF (通常カウンタ) RIF_FLEX_STAT_COUNTER_POLL_MSECS (intfsorch.h:21) 1000 ms

counterpoll show の表示でも RIF_STAT グループは DEFLT_1_SEC = "default (1000)" をフォールバック値として使用する（counterpoll/main.py:815）。

FLEX_COUNTER_STATUS 未設定時の挙動

FLEX_COUNTER_TABLE|RIF の FLEX_COUNTER_STATUS が enable になるまで syncd は SAI ポーリングを行わない。カウンタ値は 0 のまま（または古い値）。

種類 詳細
コード由来デフォルト FLEX_COUNTER_STATUS なし → syncd 収集なし
CLI デフォルト counterpoll show 未設定時は disable 扱いで表示される（counterpoll/main.py:815）

レートスムージングのデフォルト

rif_rates.lua は COUNTERS_DB の RATES:RIF エントリから RIF_SMOOTH_INTERVAL と RIF_ALPHA を読み取り、指数移動平均 (EMA) でレートを平滑化する5。これらの値は enable_counters.py によって起動時に書き込まれる。

パラメータ デフォルト値 定義箇所
RIF_SMOOTH_INTERVAL 10（秒） enable_counters.py:10
RIF_ALPHA 0.18（= 2/(10+1) ≈ 0.182） enable_counters.py:11

RIF_ALPHA は alpha = 2/(N+1) で、N = ウィンドウ幅（秒）から導出される。デフォルト 10 秒ウィンドウで 1 秒スパイクの影響が約 10 秒で収束するよう設計されている（enable_counters.py:7-9 コメント）。

ユーザーが config rate smoothing-interval <interval> rif を実行すると新しい alpha = 2.0/(interval+1) が計算され RATES:RIF に書き直される（config/main.py:9591-9598）。

RIF_ALPHA 未定義時の挙動

rif_rates.lua は RIF_ALPHA が未定義の場合 "Alpha is not defined" をログに残して即 return する（rif_rates.lua:21-23）。enable_counters.py が実行されていない場合はレート計算が一切行われず RATES:<oid> が空のままになる。

起動遅延（enable_counters.py）

enable_counters.py はシステム起動後にデフォルト率設定を書き込む前に意図的に sleep する6。

起動後経過時間 sleep 時間
< 5 分（uptime < 300 s） 180 秒（3 分待機後に設定書き込み）
5 分以上 60 秒（1 分待機後に設定書き込み）

これにより orchagent / syncd が完全に初期化される前に RATES:RIF が書かれることを防いでいる。

RIF タイプ別登録

intfsorch は RIF ごとに COUNTERS_RIF_TYPE_MAP に OID→タイプ（port, lag, vlan, subport 等）を書く。COUNTERS_RIF_NAME_MAP には RIF 名（インタフェース名）→OID のマッピングが格納され、intfstat がこのマップを元にカウンタを引く。

SAI フィールド未サポート時の挙動

ASIC が対応していない SAI カウンタは intfstat の get_counters() で STATUS_NA ('N/A') として扱われ、表示に N/A が出る（scripts/intfstat:93-98）。

関連リファレンス

引用元

  1. intfsorch RIF カウンタ登録: sonic-swss/orchagent/intfsorch.cpp. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/intfsorch.cpp#L49 ↩

  2. rifStatIds[] 全定義: sonic-swss/orchagent/intfsorch.cpp:49-59. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/intfsorch.cpp#L49 ↩

  3. rif_rates.lua レート計算ロジック: sonic-swss/orchagent/rif_rates.lua. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/rif_rates.lua ↩

  4. ポーリング間隔ハードコード: sonic-swss/orchagent/intfsorch.h:21. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/intfsorch.h#L21 ↩

  5. RIF_ALPHA/SMOOTH_INTERVAL デフォルト: sonic-buildimage/dockers/docker-orchagent/enable_counters.py:10-11. https://github.com/sonic-net/sonic-buildimage/blob/master/dockers/docker-orchagent/enable_counters.py#L10 ↩

  6. 起動遅延ロジック: sonic-buildimage/dockers/docker-orchagent/enable_counters.py:57-64. https://github.com/sonic-net/sonic-buildimage/blob/master/dockers/docker-orchagent/enable_counters.py#L57 ↩