ethextractperf(8)

💅 ethextractperf — the EFSFFCLIRG glow-up, bestie edition 💅

okay so. you know how you're drowning in fabric ports and you just want the numbers?? this is that. ethextractperf is your girl. she pulls a full per-port performance counter report and hands it to you as CSV — perfect for yeeting into a spreadsheet or letting your little scripts chew on it. 🍓

how does she do it?? she generates a detailed ethreport component summary report, then pipes that into ethxmlextract and yanks out the element values for NodeDesc, Chassis ID, PortNum, and literally every performance counter. extraction only happens from the Systems portion of the report, which means no Neighbor info (the Neighbor portions get suppressed, sorry not sorry 🙈).

also?? she's literally a sample script. use her as inspo for building your own custom per-port reports. main character behavior fr. ✨

🎀 Syntax 🎀

ethextractperf [ethreport  options]

✨ Options ✨

• --help — spits out the full help text. classic.
• ethreport options — these get passed straight through to ethreport. the subset below is the "typical + useful" lil collection for this command. and heads up: by design, the tool ignores the -o/--output report option. 💀
  • -X, --infile snapshot_input — builds a report from the data sitting in the snapshot_input file. that file has to have been generated during a previous -o snapshot run, no exceptions. and yes, you can pass - as snapshot_input to mean stdin. 🫶
  • -T, --topology topology_input — uses the topology_input file to augment and verify fabric info. when you use it, various reports can get augmented with info that just isn't available electronically. - also works here to specify stdin.
  • -E, --eth config_file — names the Ethernet management config file. default is the /etc/eth-tools/mgt_config.xml file. 🧚
  • -p plane — names the enabled plane as defined in the Mgt config file. default is the first enabled plane.
  • -F, --focus point — sets the focus area for the report, used to limit the report's scope. details live down in Point Syntax. ⭐

🌸 Point Syntax 🌸

• ifid:value — value is a numeric ifid.
• ifid:value:node — value is a numeric ifid; selects the node with the given ifid.
• ifid:value:port:value2 — value is the numeric ifid of a node, value2 is a port number.
• ifid:value:portid:value2 — value is the numeric ifid of a node, value2 is a port id.
• mgmtifaddr:value — value is a numeric port mgmtifaddr.
• ifaddr:value — value is a numeric node ifaddr.
• ifaddr:value1:port:value2 — value1 is a numeric node ifaddr, value2 is a port number.
• ifaddr:value1:portid:value2 — value1 is a numeric node ifaddr, value2 is a port id.
• chassisid:value — value is a numeric chassisid.
• chassisid:value1:port:value2 — value1 is a numeric chassisid, value2 is a port number.
• chassisid:value1:portid:value2 — value1 is a numeric chassisid, value2 is a port id.
• node:value — value is a node description (node name).
• node:value1:port:value2 — value1 is a node description (node name), value2 is a port number.
• node:value1:portid:value2 — value1 is a node description (node name), value2 is a port id.
• nodepat:value — value is a glob pattern for node description (node name).
• nodepat:value1:port:value2 — value1 is the glob pattern for the node description (node name), value2 is a port number.
• nodepat:value1:portid:value2 — value1 is the glob pattern for the node description (node name), value2 is a port id.
• nodedetpat:value — value is a glob pattern for node details.
• nodedetpat:value1:port:value2 — value1 is the glob pattern for the node details, value2 is a port number.
• nodedetpat:value1:portid:value2 — value1 is the glob pattern for the node details, value2 is a port id.
• nodetype:value — value is a node type (SW or NIC).
• nodetype:value1:port:value2 — value1 is a node type (SW or NIC), value2 is a port number.
• nodetype:value1:portid:value2 — value1 is a node type (SW or NIC), value2 is a port id.
• rate:value — value is a string for rate (25g, 50g, 75g, 100g); omits switch mgmt port 0. 💫
• portstate:value — value is a string for state (up, down, testing, unknown, dormant, notactive).
• portphysstate:value — value is a string for PHYs state (other, unknown, operational, standby, shutdown, reset).
• mtucap:value — value is an MTU size (maximum size 65535); omits switch mgmt port 0.
• linkdetpat:value — value is a glob pattern for link details.
• portdetpat:value — value is a glob pattern for port details.
• nodepatfile:FILENAME — names the file holding the list of nodepats or node descriptions.
• nodepairpatfile:FILENAME — names the file holding the list of node pairs, separated by a colon.
• ldr — specifies the ports with a non-zero link down reason or neighbor link down reason.
• ldr:value — specifies the ports with a link down reason or neighbor link down reason equal to value.

the part of the script that calls ethreport and ethxmlextract goes a lil something like this, and honestly?? she ate:

ethreport -o comps -x -d 10 "$@" | /usr/sbin/ethxmlextract -d \; \

-e NodeDesc -e ChassisID -e PortNum -e PortId -e LinkSpeedActive \

-e IfHCOutOctetsMB -e IfHCOutOctets -e IfHCOutUcastPkts \

-e IfHCOutMulticastPkts -e IfHCInOctetsMB -e IfHCInOctets \

-e IfHCInUcastPkts -e IfHCInMulticastPkts \

-e Dot3HCStatsInternalMacTransmitErrors \

-e Dot3HCStatsInternalMacReceiveErrors -e Dot3HCStatsSymbolErrors \

-e IfOutErrors -e IfInErrors -e IfInUnknownProtos \

-e Dot3HCStatsAlignmentErrors -e Dot3HCStatsFCSErrors \

-e Dot3HCStatsFrameTooLongs -e IfOutDiscards -e IfInDiscards \

-e Dot3StatsCarrierSenseErrors -e Dot3StatsSingleCollisionFrames \

-e Dot3StatsMultipleCollisionFrames -e Dot3StatsSQETestErrors \

-e Dot3StatsDeferredTransmissions -e Dot3StatsLateCollisions \

-e Dot3StatsExcessiveCollisions -s Neighbor

🌈 Example 🌈

ethextractperf

that's it. that's the whole vibe. run her, get your CSV, go be iconic. 👑

💖 Copyright(C) 2020-2024 Intel Corporation — no cap, that's the whole copyright line, and this gorgeous page is ethextractperf(8) from the EFSFFCLIRG man page era. ty for coming to my TED talk, bestie, now go extract some perf counters 🎀✨