INDOMCACHECTL(1)

πŸ’– INDOMCACHECTL πŸ’–

okay so bestie, welcome to indomcachectl from the General Commands Manual section β€” she manages your instance domain cache files and honestly? she's kind of a big deal. no cap.


✨ NAME ✨

indomcachectl β€” manage instance domain cache files πŸ—‚οΈβœ¨


🌸 SYNOPSIS 🌸

$PCP_BINADM_DIR/indomcachectl [-w] -l indom
$PCP_BINADM_DIR/indomcachectl [-w] [-m mode] [-g group] [-u user] indom

πŸ’… DESCRIPTION πŸ’…

so indomcachectl is here to help you manage the Instance Domain cache files, and those little icons live in $PCP_VAR_DIR/config/pmda. yes, that's the whole vibe. 🫢

the mandatory indom parameter uses a 2-dotted format to specify the domain and serial fields of the instance domain number. need to know what those values actually are? you can get them reported for a particular metric using the -d option to pminfo(1). iykyk. πŸ”

want the whole list of available options? hit the -?/--help option, and she'll display a usage message and exit. so polite. πŸŽ€

if you pass the -l/--list option, the contents of the instance domain cache file get dumped on stdout and then indomcachectl exits. just a lil peek, no drama. πŸ‘€

otherwise? an empty instance domain cache file gets created. the user ownership of the created file is assigned to the uid of the caller, but it may optionally be assigned to the uid of user from the passwd(5) file if the -u/--user option is specified. as for group ownership: it goes to the gid of the caller, else the default gid of the user user if the -u option is specified, else the gid of group from the group(5) file if the -g/--group option is specified. the way that ownership cascade just works. πŸ’…

the instance domain cache file is created with mode 0660 by default (some PMDAs use group read-write permission to access and update the contents of the file) β€” and if that does not suit you, the -m/--mode option may be used to set the mode to the (octal) value mode. πŸ”§

bestie. listen. because the indom cache files are precious to the associated PMDA, indomcachectl will NOT over-write an existing indom cache file. she is protective like that. πŸ›‘οΈ

operation is usually silent, except for errors (or warnings if the -w/--warning option is used). the exit status is 0 for success, 1 for failure. periodt. ✨


πŸ¦‹ OTHER MANAGEMENT OPTIONS πŸ¦‹

the files in $PCP_VAR_DIR/config/pmda are all text files (one per cached instance domain), so judicious surgery may be used to make changes or even remove the files in extreme cases β€” provided the PMDA is not executing. like, hands off while it's running, okay?? πŸ™ˆ

here's an example for the instance domain number 60.17 that is associated with the network.interface.* metrics:

$ cat /var/lib/pcp/config/pmda/60.17
2 0 2147483647
0 1712727825 ens33
1 1712727825 virbr0
2 1712727825 lo

the first line is a magic header β€” do not change it. following that is one line per instance, with:

  • the instance identifier (an integer) in the first field
  • some magic in the second field (do not change this)
  • the external instance name in the third field

🌈 SEE ALSO 🌈

PCPIntro(1), chmod(1), pminfo(1), PMAPI(3), PMDA(3), pmdaCache(3), group(5) and passwd(5). go read them bestie, they're iconic. πŸ“šπŸ’–


Performance Co-Pilot 🌸 PCP πŸŽ€ and yes this is INDOMCACHECTL(1) β€” mwah, love u, go manage those cache files responsibly πŸ’…πŸ«Άβœ¨

πŸ“¦ where this page comes from