hpct-importer(1)

📦
version 2.2.10 · 2 versions
, in ubuntu stonking

💖 hpct-importer(1) — the girlies' guide to the HiPerConTracer Trace Data Importer 💖

okay so bestie, welcome to hpct-importer, a General Commands Manual page, and honestly? she's iconic. this little tool grabs your HiPerConTracer results and yeets them into a database. let me walk you through it, no gatekeeping 💅

✨ NAME ✨

hpct-importer — HiPerConTracer Trace Data Importer

🦋 SYNOPSIS 🦋

like, here's the shape of the thing, copy-paste ready:

hpct-importer [-C importer_configuration | --importer-config importer_‐
              configuration]
              [-D database_configuration | --database-config database_‐
              configuration]
              [-L level | --loglevel level]
              [-Z on|off | --logcolor on|off]
              [-O file | --logfile file]
              [-q | --quiet] [-w | --verbose]
              [-X mode | --import-mode mode]
              [-Y depth | --import-max-depth depth]
              [-I path | --import-file-path path]
              [-B path | --bad-file-path path]
              [-G path | --good-file-path path]
              [-F filter_regexp | --import-file-path-filter filter_‐
              regexp]
              [-Q | --quit-when-idle]
              [--ping-workers number] [--ping-files number]
              [--traceroute-workers number] [--traceroute-files number]
hpct-importer [-h | --help]
hpct-importer [-v | --version]

🌸 DESCRIPTION 🌸

so what does she do? hpct-importer imports HiPerConTracer results into an SQL or NoSQL database. and rn, these are the database backends she supports:

  • MySQL/MariaDB (SQL)
  • PostgreSQL (SQL)
  • MongoDB (NoSQL)

results files that imported successfully can be moved into a "good" directory, deleted, or kept as-in — and bestie, keeping them is for debugging only! 🫣

results files that failed to import get moved into a "bad" directory. that's the vibe check they failed.

also, the input of multiple input files can be combined into a single database transaction, which improves performance on short files 🚀. but if there's an import error? each file gets imported sequentially so we can figure out which ones are the faulty little guys.

🎀 ARGUMENTS 🎀

the following arguments may be provided:

  • -L level, --loglevel level — sets the minimum logging level to the provided value: 0=trace, 1=debug, 2=info, 3=warning, 4=error, 5=fatal.
  • -Z on|off, --logcolor on|off — enables (on) or disables (off) the usage of ANSI color escape sequences to colorise the log output according to its level. yes she's serving colorful logs 💅
  • -O file, --logfile file — sets a file name for appending the log output to. if a file is set, no log output is made to the console. otherwise, all log output will be written to the console.
  • -q, --quiet — sets the minimum logging level to 3 (warning). shhh 🤫
  • -w, --verbose — sets the minimum logging level to 0 (trace). she's telling you everything.
  • -C importer_configuration, --importer-config importer_configuration — sets the name of the importer configuration file. this option must be provided! see /usr/share/hipercontracer/hipercontracer-importer.conf for an example.
  • -D database_configuration, --database-config database_configuration — sets the name of the database configuration file. this option must be provided! see /usr/share/hipercontracer/hipercontracer-database.conf for an example.
  • -X mode, --import-mode mode — specifies the import mode, overriding the mode read from the database configuration file: DeleteImportedFiles (delete successfully imported files), MoveImportedFiles (move successfully imported files into "good" directory), KeepImportedFiles (keep successfully imported files where they are). do not use KeepImportedFiles except for testing. otherwise, the next re-run of hpct-importer tries to import them again! they may create duplicates when the underlying database system (e.g. NoSQL without unique indices) does not ensure uniqueness! 💀
  • -Y depth, --import-max-depth depth — specifies the import directory traversal depth, overriding the mode read from the database configuration file.
  • -I path, --import-file-path path — specifies the import file path, overriding the mode read from the database configuration file. this path is used to look for files to import. 🔍
  • -B path, --bad-file-path path — specifies the "good" file path, overriding the mode read from the database configuration file. this path is used to move successfully imported files to, when the import mode is set to KeepImportedFiles.
  • -G path, --good-file-path path — specifies the "bad" file path, overriding the mode read from the database configuration file. this path is used to move files to which failed to import.
  • -F filter_regexp, --import-file-path-filter filter_regexp — specifies the import path filter, overriding the mode read from the database configuration file. this filter can be used to only import a subset of the import files for testing. the filter expression is an std::regex regular expression. regex girlies rise 🧚
  • -Q, --quit-when-idle — quit importer when all workers are idle. this will perform only one import round.
  • --ping-workers number — sets the number of Ping import workers. default: 1. an import file is distributed to a worker by hashing the source address given in the file name.
  • --ping-files number — sets the number of Ping import files per database transaction. default: 1.
  • --traceroute-workers number — sets the number of Traceroute import workers. default: 1. an import file is distributed to a worker by hashing the source address given in the file name.
  • --traceroute-files number — sets the number of Traceroute import files per database transaction. default: 1.
  • -h, --help — prints command help. bestie behaviour fr fr.
  • -v, --version — prints program version.

👑 EXIT STATUS 👑

the hpct-importer tool exits with 0 on success, and >0 in case of an error. zero is slay, anything else is a whole situation 😭

🔥 EXAMPLES 🔥

here's how the girlies actually run her:

hpct-importer -C hipercontracer-importer.conf -D
        hipercontracer-database.conf
hpct-importer --importer-config hipercontracer-importer.conf
        --database-config hipercontracer-database.conf --verbose
hpct-importer -C hipercontracer-importer.conf -D
        hipercontracer-database.conf -F 1234/.*
hpct-importer --version
hpct-importer -h

🍓 NOTES 🍓

this program is part of HiPerConTracer. the latest version of HiPerConTracer can be found on the HiPerConTracer Homepage at HiPerConTracer Homepage: https://www.nntb.no/~dreibh/hipercontracer/. go look, she's worth it ✨

💜 AUTHORS 💜

Thomas Dreibholz, Homepage: https://www.nntb.no/~dreibh

and that's the whole page, bestie 🫶 this was hpct-importer, from the General Commands Manual, sourced and versioned as hpct-importer and dated August 31, 2026. main character energy, no cap. periodt 💅💖

📦 where this page comes from