Skip to content

Commit 7e706cf

Browse files
authored
Merge pull request #8 from rokernel/docs/collector-examples-compact
docs: add compact anonymized collector examples
2 parents 40e5197 + 64848c2 commit 7e706cf

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,55 @@ These tests were done with SONiC Community versions, not SONiC Enterprise versio
6565
| SSE-T7132SR | 202505 | 12 | Debian 12.11 | 6.1.0-29-2-amd64 | x86_64-supermicro_sse_t7132s-r0 | marvell-teralynx |
6666
| MSN2100-CB2FC | 202411 | 12 | Debian 12.12 | 6.1.0-29-2-amd64 | x86_64-mlnx_msn2100-r0 | mellanox |
6767

68+
## Collector Examples (Anonymized, Compact)
69+
70+
These examples are synthetic and anonymized. Use them as query patterns. Labels can vary by SONiC platform/version.
71+
72+
- **Interface collector** - interface health and traffic
73+
- `sonic_interface_operational_status{device="Ethernet0"} 1`
74+
- `sonic_interface_receive_bytes_total{device="Ethernet0"} 4.8e+09`
75+
- Query: `rate(sonic_interface_receive_bytes_total[5m])`
76+
77+
- **HW collector** - PSU and fan status
78+
- `sonic_hw_psu_operational_status{psu="PSU1"} 1`
79+
- `sonic_hw_fan_speed_rpm{fan="FAN3"} 14200`
80+
- Query: `sonic_hw_psu_operational_status == 0`
81+
82+
- **CRM collector** - resource usage and headroom
83+
- `sonic_crm_stats_used{resource="ipv4_route"} 1610`
84+
- `sonic_crm_stats_available{resource="ipv4_route"} 80299`
85+
- Query: `100 * sonic_crm_stats_used / (sonic_crm_stats_used + sonic_crm_stats_available)`
86+
87+
- **Queue collector** - queue drops and watermark pressure
88+
- `sonic_queue_dropped_packets_total{device="Ethernet0",queue="3"} 73`
89+
- `sonic_queue_watermark_bytes_total{device="Ethernet0",queue="3",type="periodic",watermark="queue_stat_periodic"} 44`
90+
- Query: `rate(sonic_queue_dropped_packets_total[5m])`
91+
92+
- **LLDP collector** - neighbor discovery and cache health
93+
- `sonic_lldp_neighbor_info{local_interface="Ethernet88",local_role="frontpanel",remote_system_name="leaf02.example.net",remote_port_id="Ethernet88",remote_chassis_id="00:11:22:33:44:55",remote_mgmt_ip="192.0.2.20"} 1`
94+
- `sonic_lldp_neighbors 64`
95+
- Query: `sonic_lldp_neighbors`
96+
97+
- **VLAN collector** - VLAN state and member mapping
98+
- `sonic_vlan_admin_status{vlan="Vlan1000"} 1`
99+
- `sonic_vlan_member_info{vlan="Vlan1000",member="Ethernet0",tagging_mode="untagged"} 1`
100+
- Query: `sonic_vlan_members`
101+
102+
- **LAG collector** - PortChannel status and member state
103+
- `sonic_lag_oper_status{lag="PortChannel1"} 1`
104+
- `sonic_lag_member_status{lag="PortChannel1",member="Ethernet24"} 1`
105+
- Query: `sonic_lag_oper_status == 0`
106+
107+
- **FDB collector** - MAC learning scale and distribution
108+
- `sonic_fdb_entries 1331`
109+
- `sonic_fdb_entries_by_port{port="Ethernet88"} 214`
110+
- Query: `topk(10, sonic_fdb_entries_by_port)`
111+
112+
- **node_exporter collectors** - host CPU, memory, filesystem
113+
- `node_cpu_seconds_total{cpu="0",mode="idle"} 5.93e+06`
114+
- `node_memory_MemAvailable_bytes 1.24e+10`
115+
- Query: `100 - (avg by(instance) (irate(node_cpu_seconds_total{mode="idle"}[5m])) * 100)`
116+
68117
# Development
69118

70119
1. Development environment is based on docker-compose. To start it run:

0 commit comments

Comments
 (0)