ipfixcol2-overview-output(7)

💖 NAME 💖

ipfixcol2-overview-output — okay bestie, this is the overview output plugin, and she's literally the vibes-checker of your collector 🦋

✨ DESCRIPTION ✨

So like, this plugin gives you a whole overview of the elements your collector is receiving. Super handy when you're sitting there like "what is my flow probe even sending me rn??" — this answers that, fast, no cap 🔥

The overview gets printed to stdout upon exit, as a JSON. So it's very much a "bestie, show me the receipts when we're done" situation 💅

🌸 EXAMPLE OUTPUT 🌸

{
    "total_number_of_records": 24985802,
    "elements": [
        {
            "pen": 0,
            "id": 136,
            "data_type": "unsigned8",
            "name": "iana:flowEndReason",
            "aliases": [ ],
            "in_number_of_records": 1112239,
            "in_percent_of_records": 4.45
        },
        {
            "pen": 0,
            "id": 1,
            "data_type": "unsigned64",
            "name": "iana:octetDeltaCount",
            "aliases": [ "bytes" ],
            "in_number_of_records": 1112239,
            "in_percent_of_records": 4.45
        },
        ...
    ]
}

Now listen, this next part matters 👀 If a certain field only has a pen and id set, with certain fields such as name being null, that means the collector is missing a definition of the field. Not her fault, she just doesn't know what it is 😭

Field definitions are defined as XML files, and by default they can be found in /etc/libfds/ if ipfixcol2 is installed system-wide.

The definitions that come with ipfixcol2 live in the /etc/libfds/system directory. Your own definitions can be supplied in the /etc/libfds/user directory. Wanna know the structure of the XML files? Go peek at one of the files in /etc/libfds/system, she'll show you the way 🫶

🎀 EXAMPLE CONFIGURATION 🎀

<output>
    <name>Overview output</name>
    <plugin>overview</plugin>
    <params>
        <skipOptionTemplates>false</skipOptionTemplates> <!-- default value -->
    </params>
</output>

👑 PARAMETERS 👑

• skipOptionsTemplates — options templates and options template records are skipped. [default: false]

💜 AUTHOR 💜

Michal Sedlak (sedlakm@cesnet.cz) — icon behavior, honestly ✨

🌈 COPYRIGHT 🌈

Copyright © 2025 CESNET, z.s.p.o.

And that's the whole page, bestie! 🎀 This was version 0.1, dated 2025-29-04, from the IPFIXcol collector fam — slay, go forth and read your fields 💅✨