RAMANAGE.CONF(5)

✨ ramanage.conf(5) — File Formats Manual ✨

okay bestie, this is the manual for the config file of ramanage, from the File Formats Manual section of the man pages. It's giving "boring ini file" but it's actually the whole personality of your archiving pipeline. let's get into it 💅

---

🌸 NAME 🌸

ramanage.conf — ramanage configuration options

---

💫 SYNOPSIS 💫

ramanage.conf

---

🦋 DESCRIPTION 🦋

so the options below control how the compress, upload and delete commands behave. You set them in @sysconfdir@/ramanage.conf, or in some other file that you point at with the -f option. On Windows systems you can also set them in the 64-bit registry — there's a whole WINDOWS REGISTRY section further down for that, don't worry, we'll get there 🫶

---

🔒 RAMANAGE_LOCK_FILE

ramanage is literally designed to be run from rastream(1). And here's the thing: rastream spawns one process for each file it closes, as the files are closed — which means you end up with a whole pile of ramanage processes at once. chaos.

So, to stop all those processes from eating your CPU and/or your network at the exact same time, you can name a lock file which guarantees that only one ramanage process is working at any given moment. one at a time. main character energy only.

The filename has to be written with posix conventions — meaning forward slashes between directories, even on Windows. Currently Cygwin is what's used for building the Windows binaries, so the filenames also have to match the layout of Cygwin's "filesystem". On Unix systems, /var/lib and /var/lock are the common hangout spots for this kind of file.

---

🗜️ RAMANAGE_COMPRESS_EFFORT

Sets the gzip compression effort. Allowed range is 1-9 inclusive.

Currently not implemented. 💀

---

🧪 RAMANAGE_COMPRESS_METHOD

Sets the compression algorithm. Only gzip is supported.

Currently not implemented. 🙈

---

📦 RAMANAGE_COMPRESS_MAX_KB

Caps how much data from the archive can get compressed in one single run of ramanage.

Here's the flow: if compression is enabled, ramanage will always compress the file after the -r option, no matter the size — no skipping, no negotiating. Then, if archive processing is enabled, ramanage starts at the oldest uncompressed file in the archive and keeps compressing files until it hits this limit.

If no limit is specified, or it's set to zero, ramanage just keeps going until the entire archive is compressed. Must be a positive integer value.

---

🌐 RAMANAGE_UPLOAD_USE_DNS

Look for a service record in DNS pointing to the QoSient collection system. The service record (SRV) name has the format _argus_upload._tcp.domainname. ramanage takes the resulting hostname and port values to find the collector. Priority and weight are ignored.

Valid values are "yes" and "no".

---

🧭 RAMANAGE_UPLOAD_USE_DNS_DOMAIN

Look in DNS for a service record in this domain. Use it together with RAMANAGE_UPLOAD_USE_DNS. Valid values are valid domain names. Omit the trailing dot/period — no . at the end, bestie 🎀

---

🖥️ RAMANAGE_UPLOAD_SERVER

If you're not using a DNS service record to locate the collector, put the numeric IPv4 or IPv6 address right here.

---

📁 RAMANAGE_UPLOAD_DIR

Upload (PUT) files into this directory on the collector. QoSient collectors default to /uploads. ramanage itself assumes no default directory.

---

👤 RAMANAGE_UPLOAD_USER

When using BasicAuth, authenticate with this username.

---

🔑 RAMANAGE_UPLOAD_PASS

When using BasicAuth, authenticate with this password.

⚠️ Heads up: if an external curl binary is used, the password will appear on the commandline. yes fr, it'll just be out there. keep that in mind.

---

🛡️ RAMANAGE_UPLOAD_AUTH

Sets the authenticate type for HTTPS uploads. Leave it blank for BasicAuth, or set it to "spnego" for Kerberos V5.

---

📤 RAMANAGE_UPLOAD_MAX_KB

Caps how much data from the archive can get uploaded in one single run of ramanage.

Same deal as the compress one: if upload is enabled, ramanage will always upload the file after the -r option, regardless of size. Then, if archive processing is enabled, ramanage starts with the oldest file in the archive and uploads files until it reaches this limit.

If no limit is specified, or it's set to zero, ramanage keeps going until the entire archive is uploaded. Must be a positive integer value.

---

⏱️ RAMANAGE_UPLOAD_DELAY_USEC

Delays uploads by some random amount of time, limited by this value.

The vibe here: lots of systems are probably all uploading data to the same QoSient collector at the same time (because most systems have some kind of time synchronization, like NTP, and they all sync up like it's a group chat). So stagger the uploads a little by waiting for an unpredictable amount of time. 🌸

Disable it by setting it to zero.

---

🗄️ RAMANAGE_PATH_ARCHIVE

Specify the location of the local Argus file archive (mandatory). The filename must be specified using posix conventions, meaning forward slashes between directories even on Windows systems. Currently, Cygwin is used for building Windows binaries and therefore the filenames must also adhere to the layout of Cygwin's "filesystem".

---

🚚 RAMANAGE_PATH_STAGING

Specify the location of the local Argus file staging directory (mandatory). This is where files get moved after upload. Files remain in this directory until they're deleted, according to the ramanage configuration. The filename must be specified using posix conventions, meaning forward slashes between directories even on Windows systems. Currently, Cygwin is used for building Windows binaries and therefore the filenames must also adhere to the layout of Cygwin's "filesystem".

---

🗑️ RAMANAGE_RPOLICY_DELETE_AFTER

Delete files in the staging and archive directories after the duration specified here, in days. Must be a positive integer.

---

🎁 RAMANAGE_RPOLICY_COMPRESS_AFTER

Compress files in the staging and archive directories after the duration specified here, in days. Must be a positive integer. Set it to 0 to compress immediately.

---

💾 RAMANAGE_RPOLICY_MAX_KB

Delete the oldest files in the archive if more than this amount of storage is used.

Currently not implemented. 💀

---

📅 RAMANAGE_RPOLICY_MIN_DAYS

Keep at least this many days' worth of argus data in the archive, even if that exceeds the storage requirements set in RAMANAGE_RPOLICY_MAX_KB.

Currently not implemented. 💀

---

🙈 RAMANAGE_RPOLICY_IGNORE_ARCHIVE

Set to "yes" if only the file specified by -r should be processed. Defaults to "no".

---

🔁 RAMANAGE_PROCESS_ARCHIVE_PERIOD

ramanage is designed to be run from rastream(1). rastream will spawn one process for each file it closes, as the files are closed, which leads to multiple ramanage processes. To stop the archive compression and upload phases from all running in close succession because of that, specify how often it's permissible to compress/upload/delete files in the archive.

Value must be a non-negative integer and has units of seconds.

---

🗜️ RAMANAGE_CMD_COMPRESS

Set to "yes" to enable file compression. Defaults to "no".

---

🗑️ RAMANAGE_CMD_DELETE

Set to "yes" to enable file deletion. Defaults to "no".

---

📡 RAMANAGE_CMD_UPLOAD

Set to "yes" to enable file uploads. Defaults to "no".

---

🪟 WINDOWS REGISTRY 🪟

If present, configuration items in the Windows registry will be preferred over those in configuration files. They live in:

HKLM:\SOFTWARE\QoSient\ArgusClients\ramanage

Configuration items have the same names as the ones in configuration files, and their type is either SZ for string values, or QWORD for numeric values.

To view the current settings from PowerShell:

C:\> Get-ItemProperty HKLM:\SOFTWARE\QoSient\ArgusClients\ramanage

Create the registry key if it's not already there:

C:\> New-Item -Path HKLM:\SOFTWARE -Name QoSient
C:\> New-Item -Path HKLM:\SOFTWARE\QoSient -Name ArgusClients
C:\> New-Item -Path HKLM:\SOFTWARE\QoSient\ArgusClients -Name ramanage

Configuration values can be added to the ramanage key from PowerShell with the Set-ItemProperty cmdlet. Numeric values require the -Type parameter. To enter string values, omit the type parameter.

C:\> Set-ItemPropery -Path HKLM:\SOFTWARE\QoSient\ArgusClients\ramanage `
     -Type QWord `
     -Name RAMANAGE_RPOLICY_DELETE_AFTER `
     -Value 180
C:\> Set-ItemPropery -Path HKLM:\SOFTWARE\QoSient\ArgusClients\ramanage `
     -Name RAMANAGE_CMD_UPLOAD `
     -Value yes

The regedit program (not regedit32) can be used to create the ramanage key and its properties if a graphical interface is more your thing. 🎀

---

👀 SEE ALSO 👀

• ramanage(1)
• rastream(1)

---

📜 COPYRIGHT 📜

Copyright (c) 2000-2024 QoSient. All rights reserved.

---

and that's the whole thing, bestie 💖 this was ramanage.conf version 5.0.3, dated 13 November 2018 — go forth and configure responsibly, you absolute icon 👑✨🦋