Skip to content

Commit 6cec110

Browse files
kostorrkostorr
committed
[docs] Update roc-{list-cards,metrics,status} docs
1 parent df33de5 commit 6cec110

15 files changed

+383
-4
lines changed

‎README.md‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -359,11 +359,27 @@ Reads from the card's flash memory.
359359
Currently only supports the C-RORC.
360360
361361
### roc-list-cards
362-
Lists the readout cards present on the system, along with their type, PCI address, vendor ID, device ID, serial number,
363-
and firmware version.
362+
Lists the readout cards present on the system along with information documented in the following table. Every entry represents
363+
an endpoint. For every physical card present in the system, two endpoint entries should be extended for the CRU and one for the
364+
CRORC.
365+
366+
| Parameter | Description |
367+
| ------------ | ------------------------------------------------------------------------------------- |
368+
| `#` | Sequence ID. Used for addressing within `ReadoutCard` (int) |
369+
| `Type` | The card type (`CRU` or `CRORC`) |
370+
| `PCI Addr` | PCI address of the card |
371+
| `Serial` | The serial of the card (3-5 digit int) |
372+
| `Endpoint` | Endpoint ID (`0/1` for a CRU, `0` for a CRORC) |
373+
| `NUMA` | NUMA node of the card (`0` or `1`) |
374+
| `FW Version` | Firmware version installed (`vx.y.z` if identified and supported, git hash otherwise) |
375+
| `UL Version` | User Logic version installed (git hash) |
376+
377+
Output may be in ASCII table (default), or JSON format (`--json-out` option). Example outputs can be found [here](doc/examples/roc-list-cards/).
364378
365379
### roc-metrics
366-
Outputs metrics for the ReadoutCards.
380+
Outputs metrics for the ReadoutCards. Output may be in an ASCII table (default), in JSON (`--json-out` option), or CSV format (`--csv-out` option). Example outputs can be found [here](doc/examples/roc-metrics/).
381+
382+
Parameter information can be extracted from the monitoring table below.
367383
368384
#### Monitoring metrics
369385
@@ -403,7 +419,10 @@ Run a Python script that can use a simple interface to use the library.
403419
Setup hugetlbfs directories & mounts. If using hugepages, should be run once per boot.
404420
405421
### roc-status
406-
Reports status of the card's configuration.
422+
Reports status on the card's global and per-link configuration. Output may be in an ASCII table (default), in JSON (`--json-out` option), or CSV format (`--csv-out` option). Example outputs can be found [here](doc/examples/roc-status/).
423+
424+
Parameter information can be extracted from the monitoring tables below. Please note that for "UP/DOWN" and "Enabled/Disabled"
425+
states while the monitoring format is an int (0/1), in all other formats a string representation is used.
407426
408427
#### Monitoring status
409428

‎doc/examples/roc-list-cards/roc-list-cards.json‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"0": {
3+
"type": "CRORC",
4+
"pciAddress": "d8:00.0",
5+
"serial": "942",
6+
"endpoint": "0",
7+
"numa": "1",
8+
"firmware": "v2.6.1",
9+
"userLogicVersion": "n\/a"
10+
},
11+
"1": {
12+
"type": "CRU",
13+
"pciAddress": "af:00.0",
14+
"serial": "10243",
15+
"endpoint": "0",
16+
"numa": "1",
17+
"firmware": "51882687",
18+
"userLogicVersion": "51882687"
19+
},
20+
"2": {
21+
"type": "CRU",
22+
"pciAddress": "3b:00.0",
23+
"serial": "10241",
24+
"endpoint": "0",
25+
"numa": "0",
26+
"firmware": "v3.5.2",
27+
"userLogicVersion": "d458317e"
28+
},
29+
"3": {
30+
"type": "CRU",
31+
"pciAddress": "3c:00.0",
32+
"serial": "10241",
33+
"endpoint": "1",
34+
"numa": "0",
35+
"firmware": "v3.5.2",
36+
"userLogicVersion": "d458317e"
37+
},
38+
"4": {
39+
"type": "CRU",
40+
"pciAddress": "b0:00.0",
41+
"serial": "10243",
42+
"endpoint": "1",
43+
"numa": "1",
44+
"firmware": "51882687",
45+
"userLogicVersion": "51882687"
46+
}
47+
}

‎doc/examples/roc-list-cards/roc-list-cards.out‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
============================================================================
2+
# Type PCI Addr Serial Endpoint NUMA FW Version UL Version
3+
----------------------------------------------------------------------------
4+
0 CRORC d8:00.0 942 0 1 v2.6.1 n/a
5+
1 CRU af:00.0 10243 0 1 51882687 51882687
6+
2 CRU 3b:00.0 10241 0 0 v3.5.2 d458317e
7+
3 CRU 3c:00.0 10241 1 0 v3.5.2 d458317e
8+
4 CRU b0:00.0 10243 1 1 51882687 51882687
9+
============================================================================

‎doc/examples/roc-metrics/roc-metrics.csv‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#,Type,PCI Addr,Temp (C),#Dropped Packets,CTP Clock (MHz),Local Clock (MHz),Total Packets per second
2+
0,CRU,af:00.0,40.894531,0,0.768170,240.471039,0
3+
1,CRU,3b:00.0,40.894531,79307,1.140186,240.470917,0
4+
2,CRU,3c:00.0,40.894531,0,1.140186,240.470917,0
5+
3,CRU,b0:00.0,40.894531,0,0.768170,240.471039,0

‎doc/examples/roc-metrics/roc-metrics.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"0": {
3+
"type": "CRU",
4+
"pciAddress": "af:00.0",
5+
"temperature": "40.89",
6+
"droppedPackets": "0",
7+
"ctpClock": "0.77",
8+
"localClock": "240.47",
9+
"totalPacketsPerSecond": "0"
10+
},
11+
"1": {
12+
"type": "CRU",
13+
"pciAddress": "3b:00.0",
14+
"temperature": "40.89",
15+
"droppedPackets": "79307",
16+
"ctpClock": "1.14",
17+
"localClock": "240.47",
18+
"totalPacketsPerSecond": "0"
19+
},
20+
"2": {
21+
"type": "CRU",
22+
"pciAddress": "3c:00.0",
23+
"temperature": "40.89",
24+
"droppedPackets": "0",
25+
"ctpClock": "1.14",
26+
"localClock": "240.47",
27+
"totalPacketsPerSecond": "0"
28+
},
29+
"3": {
30+
"type": "CRU",
31+
"pciAddress": "b0:00.0",
32+
"temperature": "40.89",
33+
"droppedPackets": "0",
34+
"ctpClock": "0.77",
35+
"localClock": "240.47",
36+
"totalPacketsPerSecond": "0"
37+
}
38+
}

‎doc/examples/roc-metrics/roc-metrics.mon‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2020-05-18 11:50:57 InfluxDB backend initialized
2+
card,hostname=flp-kostas.cern.ch,name=roc-metrics,id=1,type=CRU pciAddress="af:00.0",temperature=40.8945,droppedPackets=0i,ctpClock=0.76817,localClock=240.471,totalPacketsPerSecond=0i 1589795457315995973
3+
card,hostname=flp-kostas.cern.ch,name=roc-metrics,id=2,type=CRU pciAddress="3b:00.0",temperature=40.8945,droppedPackets=79307i,ctpClock=1.14019,localClock=240.471,totalPacketsPerSecond=0i 1589795457317687156
4+
card,hostname=flp-kostas.cern.ch,name=roc-metrics,id=3,type=CRU pciAddress="3c:00.0",temperature=40.8945,droppedPackets=0i,ctpClock=1.14019,localClock=240.471,totalPacketsPerSecond=0i 1589795457319052138
5+
card,hostname=flp-kostas.cern.ch,name=roc-metrics,id=4,type=CRU pciAddress="b0:00.0",temperature=40.8945,droppedPackets=0i,ctpClock=0.76817,localClock=240.471,totalPacketsPerSecond=0i 1589795457480038339

‎doc/examples/roc-metrics/roc-metrics.out‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
===========================================================================================================================
2+
# Type PCI Addr Temp (C) #Dropped Packets CTP Clock (MHz) Local Clock (MHz) Total Packets per second
3+
---------------------------------------------------------------------------------------------------------------------------
4+
0 CRU af:00.0 40.8945 0 0.76817 240.471 0
5+
1 CRU 3b:00.0 40.8945 79307 1.14019 240.471 0
6+
2 CRU 3c:00.0 40.8945 0 1.14019 240.471 0
7+
3 CRU b0:00.0 40.8945 0 0.76817 240.471 0
8+
===========================================================================================================================

‎doc/examples/roc-status/roc-status-crorc.csv‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Link ID,Status,Optical Power(uW),QSFP Enabled,Offset,Time Frame Detection, Time Frame Length
2+
,,,Enabled,Fixed,Enabled,256
3+
0,UP,0.000000
4+
1,UP,0.000000
5+
2,UP,0.000000
6+
3,UP,0.000000
7+
4,DOWN,0.000000
8+
5,DOWN,0.000000

‎doc/examples/roc-status/roc-status-crorc.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"qsfp": "Enabled",
3+
"offset": "Fixed",
4+
"timeFrameDetection": "Enabled",
5+
"timeFrameLength": "256",
6+
"0": {
7+
"status": "UP",
8+
"opticalPower": "0.00"
9+
},
10+
"1": {
11+
"status": "UP",
12+
"opticalPower": "0.00"
13+
},
14+
"2": {
15+
"status": "UP",
16+
"opticalPower": "0.00"
17+
},
18+
"3": {
19+
"status": "UP",
20+
"opticalPower": "0.00"
21+
},
22+
"4": {
23+
"status": "DOWN",
24+
"opticalPower": "0.00"
25+
},
26+
"5": {
27+
"status": "DOWN",
28+
"opticalPower": "0.00"
29+
}
30+
}

‎doc/examples/roc-status/roc-status-crorc.mon‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2020-05-18 17:18:41 InfluxDB backend initialized
2+
CRORC,hostname=flp-kostas.cern.ch,name=roc-status,id=0,type=CRORC pciAddress="d8:00.0",qsfp=1i,dynamicOffset=0i,timeFrameDetection=1i,timeFrameLength=256i 1589815121114561065
3+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=0,type=CRORC pciAddress="d8:00.0",status=1i,opticalPower=0 1589815121114654200
4+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=1,type=CRORC pciAddress="d8:00.0",status=1i,opticalPower=0 1589815121114681240
5+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=2,type=CRORC pciAddress="d8:00.0",status=1i,opticalPower=0 1589815121114690458
6+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=3,type=CRORC pciAddress="d8:00.0",status=1i,opticalPower=0 1589815121114698361
7+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=4,type=CRORC pciAddress="d8:00.0",status=0i,opticalPower=0 1589815121114706030
8+
link,hostname=flp-kostas.cern.ch,name=roc-status,CRORC=0,id=5,type=CRORC pciAddress="d8:00.0",status=0i,opticalPower=0 1589815121114713597

0 commit comments

Comments
 (0)