Documentation Index

Fetch the complete documentation index at: https://docs.fmad.io/llms.txt

Use this file to discover all available pages before exploring further.

Setup

Prev Next

The following setups are required for configuring the metadata indexing

NOTE: Indexing is in Alpha stage release and evolving, not for Production usage

Step 1) Scratch disk

Allocating a location to write all indexing data. We recommend re-allocating the PAR0 (Parity) drive as the scratch disk.

Discussion on Scratch Disk setup is

https://docs.fmad.io/docs/scratch-disk

Step 2) Directory

Start by creating a directory on the scratch disk as follow

mkdir /mnt/store1/index

And ensuring permissions include fmadio.staff

sudo chown fmadio.staff /mnt/store1/index

Step 3) Configuration (Optional)

By deafult no configuration file is required, a default setting is used, it assumes index data is written to

/mnt/store1/index

This can be overwritten with a configuration file located in

/opt/fmadio/etc/index.lua

Example configuration is shown below to write index data to a index2 directory (as an example)

local Config = {}

-- set the index to write in a different directory
Config.PathIndex = "/mnt/store1/index2/"

-- set the roll period of each parq file (default 60sec)
Config.RollPeriod = 60e9

return Config

Step 4) Enable on scheduler

Enable the indexer to run 24/7 automatically via the Scheduler

Confirm there is a builtin fmadio_index analytics item

fmadiocli show analytics schedule

Expected output

fmadio@fmadio200v4-636:/mnt/store0/etc$ fmadiocli show analytics schedule
[Thu Jul 30 03:33:40 2026] Cmd [show analytics schedule ]
[Thu Jul 30 03:33:40 2026]
[Thu Jul 30 03:33:40 2026] Scheduled Capture Status
[Thu Jul 30 03:33:40 2026]
[Thu Jul 30 03:33:40 2026]                                          |        |  Start   |   Stop   |Mon|Tue|Wed|Thu|Fri|Sat|Sun|
[Thu Jul 30 03:33:40 2026] -----------------------------------------+--------+----------+----------+---+---+---+----+--+---+---+
[Thu Jul 30 03:33:40 2026] pcap_rotate                              |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:33:40 2026] push_pcap                                |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:33:40 2026] push_lxc                                 |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:33:40 2026] fmadio_index                             |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:33:40 2026] -----------------------------------------+--------+----------+----------+---+---+---+----+--+---+---+
fmadio@fmadio200v4-636:/mnt/store0/etc$

In the above case fmadio_index is not enabled

Enable it to run using

fmadiocli config analytics 247-enable fmadio_index

Example output

fmadio@fmadio200v4-636:/mnt/store0/etc$ fmadiocli config analytics 247-enable fmadio_index
[Thu Jul 30 03:35:02 2026] Cmd [config analytics 247-enable fmadio_index ]
fmadio_index
[Thu Jul 30 03:35:02 2026]
[Thu Jul 30 03:35:02 2026] Scheduled Capture Status
[Thu Jul 30 03:35:02 2026]
[Thu Jul 30 03:35:03 2026]                                          |        |  Start   |   Stop   |Mon|Tue|Wed|Thu|Fri|Sat|Sun|
[Thu Jul 30 03:35:03 2026] -----------------------------------------+--------+----------+----------+---+---+---+----+--+---+---+
[Thu Jul 30 03:35:03 2026] pcap_rotate                              |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:35:03 2026] push_pcap                                |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:35:03 2026] push_lxc                                 |        | 00:00:00 | 23:59:59 |   |   |   |   |   |   |   |
[Thu Jul 30 03:35:03 2026] fmadio_index                             |        | 00:00:00 | 23:59:59 | Y | Y | Y | Y | Y | Y | Y |
[Thu Jul 30 03:35:03 2026] -----------------------------------------+--------+----------+----------+---+---+---+----+--+---+---+
fmadio@fmadio200v4-636:/mnt/store0/etc$

From the above output fmadio_index is enabled to run 24/7

Step 5) Logfile Debug

To confirm the indexer is running use

tail -F /opt/fmadio/log/fmadio_index.cur

Expected output is shown below

fmadio@fmadio200v45-828-2U:~$ tail -F /opt/fmadio/log/fmadio_index.cur
[20260730_055642] pcap2parq:    197712039 pkts       76430439840 (      76.430 GB)     0.039 Gbps     356 file
[20260730_055643] pcap2parq:    197725869 pkts       76434381042 (      76.434 GB)     0.030 Gbps     356 file
[20260730_055644] pcap2parq:    197726747 pkts       76435410906 (      76.435 GB)     0.007 Gbps     356 file
[20260730_055646] pcap2parq:    197736723 pkts       76439416686 (      76.439 GB)     0.030 Gbps     356 file
[20260730_055647] pcap2parq:    197751932 pkts       76444117094 (      76.444 GB)     0.038 Gbps     356 file
[20260730_055648] pcap2parq:    197757435 pkts       76449243194 (      76.449 GB)     0.034 Gbps     356 file
.
.
.

FMADIO Packet Capture systems