COUNTERS_DB バッファ / ウォーターマーク カウンタ¶
概要¶
portsorch（orchagent 内）および bufferorch・watermarkorch が SAI の flex counter 機構を通じて Queue / Priority Group (PG) / Buffer Pool ごとに収集するバッファ統計カウンタ群1。
- Queue カウンタ: パケット数・バイト数・ドロップ数を
COUNTERS:<oid>に格納 - Queue ウォーターマーク: 共有バッファ最大占有量 (bytes) を
COUNTERS/<PERIODIC/PERSISTENT/USER_WATERMARKS:<oid>に格納 - PG ウォーターマーク: shared / xoff headroom の最大占有量を同テーブルに格納
- PG ドロップカウンタ: PG ごとのドロップパケット数を
COUNTERS:<oid>に格納 - Port バッファドロップ: ポート単位 in/out バッファドロップ数を
COUNTERS:<oid>に格納 - Buffer Pool ウォーターマーク: プール単位の最大占有量を
USER/PERSISTENT/PERIODIC_WATERMARKS:<oid>に格納
データフロー (自動生成)¶
flowchart LR
CFG[("CONFIG_DB<br/>FLEX_COUNTER_TABLE")]
ORC["portsorch<br/>bufferorch<br/>watermarkorch"]
syncd["syncd<br/>FlexCounter"]
HW["SAI / ASIC"]
CNTDB[("COUNTERS_DB<br/>COUNTERS/WATERMARKS")]
CFG --> ORC
ORC --> syncd
syncd --> HW
HW --> syncd
syncd --> CNTDB
syncd -- "Lua plugin" --> CNTDB凡例
FLEX_COUNTER_TABLE|QUEUE_WATERMARK / PG_WATERMARK / PORT_BUFFER_DROP 等が enable になると、portsorch / bufferorch が SAI カウンタ ID リストを syncd へ投入し、syncd が定周期でポーリングして COUNTERS_DB を更新する。ウォーターマークは Lua plugin が max 集計して PERIODIC/PERSISTENT/USER_WATERMARKS テーブルへ書き込む。
key 構造¶
Queue カウンタ¶
COUNTERS_DB / COUNTERS_QUEUE_NAME_MAP (Hash)
field: <port_name>:<queue_index> (例: Ethernet0:0)
value: <SAI OID>
COUNTERS_DB / COUNTERS:<oid> (Hash)
field: <SAI_QUEUE_STAT_*>
value: <uint64 値 (文字列)>
Priority Group カウンタ / ウォーターマーク¶
COUNTERS_DB / COUNTERS_PG_NAME_MAP (Hash)
field: <port_name>:<pg_index>
value: <SAI OID>
COUNTERS_DB / COUNTERS:<oid> (Hash — PG ドロップ)
field: SAI_INGRESS_PRIORITY_GROUP_STAT_DROPPED_PACKETS
value: <uint64>
COUNTERS_DB / PERIODIC_WATERMARKS:<oid>
COUNTERS_DB / PERSISTENT_WATERMARKS:<oid>
COUNTERS_DB / USER_WATERMARKS:<oid> (Hash — PG ウォーターマーク)
field: SAI_INGRESS_PRIORITY_GROUP_STAT_SHARED_WATERMARK_BYTES
field: SAI_INGRESS_PRIORITY_GROUP_STAT_XOFF_ROOM_WATERMARK_BYTES
value: <uint64 bytes>
Buffer Pool ウォーターマーク¶
COUNTERS_DB / USER_WATERMARKS:<oid>
COUNTERS_DB / PERSISTENT_WATERMARKS:<oid>
COUNTERS_DB / PERIODIC_WATERMARKS:<oid> (Hash — Buffer Pool ウォーターマーク)
field: SAI_BUFFER_POOL_STAT_WATERMARK_BYTES
field: SAI_BUFFER_POOL_STAT_XOFF_ROOM_WATERMARK_BYTES
value: <uint64 bytes>
フィールド一覧¶
Queue カウンタ (QUEUE_STAT_COUNTER グループ)2¶
| SAI フィールド | 意味 |
|---|---|
SAI_QUEUE_STAT_PACKETS |
送信パケット数 |
SAI_QUEUE_STAT_BYTES |
送信バイト数 |
SAI_QUEUE_STAT_DROPPED_PACKETS |
ドロップパケット数 |
SAI_QUEUE_STAT_DROPPED_BYTES |
ドロップバイト数 |
SAI_QUEUE_STAT_TRIM_PACKETS |
トリムパケット数 |
SAI_QUEUE_STAT_DROPPED_TRIM_PACKETS |
トリムドロップパケット数 |
SAI_QUEUE_STAT_TX_TRIM_PACKETS |
トリム送信パケット数 |
VoQ (Virtual Output Queue) 環境では追加で:
| SAI フィールド | 意味 |
|---|---|
SAI_QUEUE_STAT_CREDIT_WD_DELETED_PACKETS |
Credit Watchdog 削除パケット数 |
WRED 対応 ASIC の場合 (WRED_ECN_QUEUE_STAT_COUNTER グループ):
| SAI フィールド | 意味 |
|---|---|
SAI_QUEUE_STAT_WRED_ECN_MARKED_PACKETS |
WRED ECN マークパケット数 |
SAI_QUEUE_STAT_WRED_ECN_MARKED_BYTES |
WRED ECN マークバイト数 |
SAI_QUEUE_STAT_WRED_DROPPED_PACKETS |
WRED ドロップパケット数 |
SAI_QUEUE_STAT_WRED_DROPPED_BYTES |
WRED ドロップバイト数 |
Queue ウォーターマーク (QUEUE_WATERMARK_STAT_COUNTER グループ)¶
| SAI フィールド | 意味 |
|---|---|
SAI_QUEUE_STAT_SHARED_WATERMARK_BYTES |
共有バッファ最大占有量 (bytes) |
Priority Group ウォーターマーク (PG_WATERMARK_STAT_COUNTER グループ)¶
| SAI フィールド | 意味 |
|---|---|
SAI_INGRESS_PRIORITY_GROUP_STAT_XOFF_ROOM_WATERMARK_BYTES |
ヘッドルーム (xoff room) 最大占有量 |
SAI_INGRESS_PRIORITY_GROUP_STAT_SHARED_WATERMARK_BYTES |
共有バッファ最大占有量 |
Priority Group ドロップカウンタ (PG_DROP_STAT_COUNTER グループ)¶
| SAI フィールド | 意味 |
|---|---|
SAI_INGRESS_PRIORITY_GROUP_STAT_DROPPED_PACKETS |
PG 受信ドロップパケット数 |
Port バッファドロップカウンタ (PORT_BUFFER_DROP_STAT グループ)¶
| SAI フィールド | 意味 |
|---|---|
SAI_PORT_STAT_IN_DROPPED_PKTS |
受信バッファドロップパケット数 |
SAI_PORT_STAT_OUT_DROPPED_PKTS |
送信バッファドロップパケット数 |
Buffer Pool ウォーターマーク (BUFFER_POOL_WATERMARK_STAT_COUNTER グループ)¶
| SAI フィールド | 意味 |
|---|---|
SAI_BUFFER_POOL_STAT_WATERMARK_BYTES |
プール共有バッファ最大占有量 (bytes) |
SAI_BUFFER_POOL_STAT_XOFF_ROOM_WATERMARK_BYTES |
プールヘッドルーム最大占有量 |
ウォーターマーク Lua plugin の動作¶
watermark_pg.lua / watermark_queue.lua / watermark_bufferpool.lua が syncd の flex counter エンジンから定周期で呼び出され、COUNTERS:<oid> の瞬時値と各ウォーターマークテーブルの既存値を比較して max() を書き込む3。
| テーブル | 意味 | クリア方法 |
|---|---|---|
PERIODIC_WATERMARKS |
定周期 (DEFAULT_TELEMETRY_INTERVAL = 120s) でゼロリセット |
タイマー (WM_TELEMETRY_TIMER) |
PERSISTENT_WATERMARKS |
リブートまたは明示的クリア要求まで保持 | WATERMARK_CLEAR_REQUEST notification (op=PERSISTENT) |
USER_WATERMARKS |
ユーザーが sonic-clear で個別リセット |
WATERMARK_CLEAR_REQUEST notification (op=USER) |
クリア操作はフィールドを "0" に設定する (clearSingleWm — watermarkorch.cpp:329)4。
書き込み経路¶
| 経路 | 対象テーブル | 詳細 |
|---|---|---|
| portsorch 初期化 | COUNTERS_QUEUE_NAME_MAP, COUNTERS_PG_NAME_MAP |
名前→OID マッピング書き込み |
| syncd FlexCounter (QUEUE_STAT) | COUNTERS:<oid> |
Queue 統計を 10000ms ごとにポーリング |
| syncd FlexCounter (PG_DROP) | COUNTERS:<oid> |
PG ドロップを 10000ms ごとにポーリング |
| syncd FlexCounter (PORT_BUFFER_DROP) | COUNTERS:<oid> |
Port バッファドロップを 60000ms ごとにポーリング |
| syncd + Lua (QUEUE_WATERMARK) | *_WATERMARKS:<oid> |
Queue WM を 60000ms ごとに max 集計 |
| syncd + Lua (PG_WATERMARK) | *_WATERMARKS:<oid> |
PG WM を 60000ms ごとに max 集計 |
| bufferorch + Lua (BUFFER_POOL_WATERMARK) | *_WATERMARKS:<oid> |
Buffer Pool WM を 60000ms ごとに max 集計 |
| watermarkorch timer | PERIODIC_WATERMARKS |
120s 周期でゼロリセット |
関連 CONFIG_DB / CLI¶
- CONFIG_DB:
FLEX_COUNTER_TABLE— グループ別有効化と間隔設定 - CONFIG_DB:
BUFFER_POOL,BUFFER_PG,BUFFER_QUEUE— バッファ設定 - CLI:
show queue counters,show priority-group watermark,show buffer pool watermark - CLI:
counterpoll queue enable/disable,counterpoll pg-watermark enable/disable - CLI:
sonic-clear queue counters,sonic-clear priority-group drop counters
暗黙デフォルト・コード由来挙動 (Phase A)¶
ポーリング間隔のコード由来デフォルト¶
各バッファカウンタグループの polling interval は portsorch.cpp / portsorch.h / bufferorch.h にハードコードされており、FLEX_COUNTER_TABLE の POLL_INTERVAL が未設定の場合この値が syncd に投入される5。
| カウンタグループ | ハードコード定数 / 定義箇所 | デフォルト値 |
|---|---|---|
QUEUE_STAT_COUNTER |
QUEUE_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS (portsorch.cpp:90) |
10000 ms |
QUEUE_WATERMARK_STAT_COUNTER |
QUEUE_WATERMARK_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS (portsorch.cpp:91) |
60000 ms |
PG_WATERMARK_STAT_COUNTER |
PG_WATERMARK_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS (portsorch.cpp:92) / PG_WATERMARK_FLEX_STAT_COUNTER_POLL_MSECS (portsorch.h:39) = "60000" |
60000 ms |
PG_DROP_STAT_COUNTER |
PG_DROP_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS (portsorch.cpp:93) / PG_DROP_FLEX_STAT_COUNTER_POLL_MSECS (portsorch.h:40) = "10000" |
10000 ms |
PORT_BUFFER_DROP_STAT |
PORT_BUFFER_DROP_STAT_POLLING_INTERVAL_MS (portsorch.cpp:88) |
60000 ms |
BUFFER_POOL_WATERMARK_STAT_COUNTER |
BUFFER_POOL_WATERMARK_FLEX_STAT_COUNTER_POLL_MSECS (bufferorch.h:16) = "60000" |
60000 ms |
WRED_ECN_QUEUE_STAT_COUNTER |
QUEUE_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS と同値 (portsorch.cpp:739) |
10000 ms |
StatsMode: READ vs READ_AND_CLEAR¶
ウォーターマーク系グループは StatsMode::READ_AND_CLEAR で初期化されており、syncd が SAI からカウンタ値を読み取った後、直ちに SAI ハードウェアカウンタをゼロリセットする6。
| グループ | StatsMode | 意味 |
|---|---|---|
QUEUE_WATERMARK_STAT_COUNTER |
READ_AND_CLEAR |
SAI 読取後に HW カウンタをリセット。Lua が max 値を保持 |
PG_WATERMARK_STAT_COUNTER |
READ_AND_CLEAR |
同上 |
BUFFER_POOL_WATERMARK_STAT_COUNTER |
条件付き READ_AND_CLEAR | clear_buffer_pool_stats SAI API で個別クリア。未対応プールは READ のみ |
QUEUE_STAT_COUNTER |
READ |
リセットなし。累積カウンタ |
PG_DROP_STAT_COUNTER |
READ |
リセットなし。累積カウンタ |
PORT_BUFFER_DROP_STAT |
READ |
リセットなし。累積カウンタ |
BUFFER_POOL のクリア能力差異
bufferorch.cpp:318-324 で各プールに対して sai_buffer_api->clear_buffer_pool_stats() を試み、SAI_STATUS_NOT_SUPPORTED が返った場合は当該プールの clear フラグをオフにして READ のみに切り替える。能力確認に失敗したプールはウォーターマークが単調増加し続ける。
定周期クリアのデフォルト間隔¶
WatermarkOrch のテレメトリタイマー初期値は DEFAULT_TELEMETRY_INTERVAL = 120 秒 (watermarkorch.cpp:9) にハードコードされている。WATERMARK_TABLE|TELEMETRY_INTERVAL で上書き可能だが、CONFIG_DB 未設定の場合は 120 秒が実効値になる7。
| 種類 | 詳細 |
|---|---|
| ハードコードデフォルト | DEFAULT_TELEMETRY_INTERVAL = 120 (watermarkorch.cpp:9) |
| 上書き方法 | CONFIG_DB WATERMARK_TABLE|TELEMETRY_INTERVAL: {interval: <秒>} |
| 乖離 | YANG / CLI に default 宣言なし。counterpoll では "120" と表示するが orchagent ハードコード由来 |
ウォーターマーク Lua plugin の暗黙 max 初期値¶
watermark_pg.lua / watermark_queue.lua は PERIODIC/PERSISTENT/USER テーブルの既存値が nil の場合、math.max() 比較をスキップして SAI から読んだ最新値をそのまま書き込む（初回は常に実測値が最大値になる）8。
-- watermark_pg.lua:36
redis.call('HSET', ..., periodic_shared_wm and math.max(...) or pg_shared_wm)
つまり テーブルエントリが存在しない場合は nil チェックが fallback として機能し、最初の測定値が初期ウォーターマークになる。クリア後は "0" が書かれ、次の Lua 実行で max(実測値, 0) が新たなウォーターマークになる。
WRED Queue カウンタの SAI 能力ガード¶
portsorch.cpp:1882-1909 で sai_query_stats_capability() を呼び出し、ASIC が対応する SAI_QUEUE_STAT_WRED_* を確認する。未対応フィールドは wred_queue_stat_ids から除外されて syncd へ投入されない。能力照会自体が失敗した場合 (SAI_STATUS_NOT_SUPPORTED) は全 WRED フィールドをスキップする9。
PG ウォーターマークの登録タイミング依存¶
pg_watermark_manager.setCounterIdList() は enablePriorityGroupWatermarkStats() が呼ばれるたびに実行される (portsorch.cpp:9051)。FLEX_COUNTER_TABLE|PG_WATERMARK の FLEX_COUNTER_STATUS = enable を受信した時点で全ポートが allPortsReady() でなければ doTask が早期 return し、ポート ready 後に再適用される（書き込み順依存の遅延がある）。
Buffer Pool ウォーターマーク: bufferorch 初期化シーケンス¶
bufferorch.cpp:234-244 で watermark_bufferpool.lua を BUFFER_POOL_WATERMARK_STAT_COUNTER に登録する。登録に失敗した場合は runtime_error をキャッチして LOG_ERROR を出力し続行する（クラッシュしない）。プール OID が未生成の状態でも登録コードは実行されるが、実際のポーリングはプール OID がある場合のみ機能する。
書き込み経路別 polling interval 早見表¶
| グループ | FLEX_COUNTER_TABLE キー | コード由来デフォルト | CLI counterpoll デフォルト |
|---|---|---|---|
| Queue Stats | QUEUE_STAT_COUNTER |
10000 ms | 10000 ms (一致) |
| Queue WM | QUEUE_WATERMARK |
60000 ms | 60000 ms (一致) |
| PG WM | PG_WATERMARK |
60000 ms | 60000 ms (一致) |
| PG Drop | PG_DROP |
10000 ms | 10000 ms (一致) |
| Port Buffer Drop | PORT_BUFFER_DROP |
60000 ms | 60000 ms (一致) |
| Buffer Pool WM | BUFFER_POOL_WATERMARK |
60000 ms | 60000 ms (一致) |
PORT_BUFFER_DROP_STAT_POLLING_INTERVAL_MS の注意点
portsorch.cpp:88 の PORT_BUFFER_DROP_STAT_POLLING_INTERVAL_MS = 60000 と PORT_BUFFER_DROP_STAT_FLEX_COUNTER_POLLING_INTERVAL_MS (counterpoll デフォルト 30000) は別定数。portsorch がマネージャーを初期化する際には 60000ms を投入するが、counterpoll が FLEX_COUNTER_TABLE|PORT_BUFFER_DROP に 30000ms を書くと上書きされる。未設定の場合は orchagent の 60000ms が有効。
証跡:
portsorch.cppL88-93, L389-435, L733-750, L866-885, L1852-1909, L8597-8680, L8932-9051, L9138-9146 全行読了。bufferorch.cppL29-32, L234-344 全行読了。watermarkorch.cppL1-349 全行読了。watermark_pg.lua/watermark_queue.lua/watermark_bufferpool.lua全行読了。
関連リファレンス¶
- CONFIG_DB FLEX_COUNTER_TABLE
- CONFIG_DB BUFFER_POOL
- CONFIG_DB BUFFER_PG
- CONFIG_DB BUFFER_QUEUE
- COUNTERS_DB PORT カウンタ
- COUNTERS_DB Queue カウンタ
引用元¶
-
portsorch バッファカウンタ ID リスト定義:
sonic-swss/orchagent/portsorch.cpp. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/portsorch.cpp#L383 ↩ -
queue_stat_ids 全定義:
sonic-swss/orchagent/portsorch.cpp:389-398. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/portsorch.cpp#L389 ↩ -
watermark Lua プラグイン:
sonic-swss/orchagent/watermark_pg.lua. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/watermark_pg.lua ↩ -
clearSingleWm ゼロリセット:
sonic-swss/orchagent/watermarkorch.cpp:329. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/watermarkorch.cpp#L329 ↩ -
ポーリング間隔ハードコード:
sonic-swss/orchagent/portsorch.cpp:88-93,portsorch.h:39-40. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/portsorch.cpp#L88 ↩ -
StatsMode::READ_AND_CLEAR:
sonic-swss/orchagent/portsorch.cpp:735-736. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/portsorch.cpp#L735 ↩ -
DEFAULT_TELEMETRY_INTERVAL:
sonic-swss/orchagent/watermarkorch.cpp:9. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/watermarkorch.cpp#L9 ↩ -
Lua nil fallback:
sonic-swss/orchagent/watermark_pg.lua:36. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/watermark_pg.lua#L36 ↩ -
WRED 能力照会:
sonic-swss/orchagent/portsorch.cpp:1882-1909. https://github.com/sonic-net/sonic-swss/blob/4305596156d7/orchagent/portsorch.cpp#L1882 ↩