error.flexfs

Caution

This entire page documents an internal component. error.flexfs is the error-report collection server operated by Paradigm4. It is not intended for customer deployment.

error.flexfs receives the panic and error reports that flexFS binaries send when run with --reportErrors, stores each report under its report folder, and optionally forwards a summary of each to a Slack channel. It is the receiving end of the --reportErrors mechanism exposed by the other binaries.

Persistent Flags

These flags apply to every subcommand.

Flag	Type	Default	Description	Visibility
--reportErrors	bool	false	Report errors and panics to Paradigm4	Public

Subcommands

Subcommand	Description	Visibility
deinit creds	Remove the credentials file	Public
deinit systemd	Remove the systemd service unit	Public
init creds	Initialize the credentials file	Public
init systemd	Create and enable a systemd service unit	Public
license	Print license information	Public
start	Start the error report server	Public
version	Print the build version	Public

deinit creds

error.flexfs deinit creds [flags]

Removes the credentials file for the error server. If the credentials file is referenced by a systemd unit, the command refuses unless --force is passed, in which case it removes the references too.

Flag	Type	Default	Description	Visibility
--credsFile	string	~/.flexfs/error/creds	Credentials file path	Public
--force	bool	false	Remove creds even if referenced by systemd (removes references too)	Public

deinit systemd

sudo error.flexfs deinit systemd

Removes the systemd service unit (flexfs-error.service) for the error server. Requires root.

init creds

error.flexfs init creds [flags]

Initializes a credentials file for the error server with a Slack webhook for report forwarding. If --slackWebhook is omitted, the command prompts for one; leaving the prompt empty runs the server with no Slack forwarding.

Flag	Type	Default	Description	Visibility
--credsFile	string	~/.flexfs/error/creds	Credentials file path	Public
--force	bool	false	Overwrite existing credentials file	Public
--slackWebhook	string	""	Slack incoming webhook URL for report forwarding (will prompt if omitted)	Public

init systemd

sudo error.flexfs init systemd [flags]

Creates and enables a systemd service unit (flexfs-error.service) for the error server. Requires root.

Flag	Type	Default	Description	Visibility
--force	bool	false	Overwrite existing systemd unit file	Public
--now	bool	false	Start the service immediately after enabling	Public
--startFlags	string	""	Additional flags to pass to the start command	Public

start

error.flexfs start [flags]

Starts the error report server, binding the HTTPS endpoint that flexFS binaries post reports to.

Flag	Type	Default	Description	Visibility
--bindAddr	string	0.0.0.0:443	Address and port to bind	Public
--credsFile	string	~/.flexfs/error/creds	Credentials file path	Public
--maxReportSize	string	8M	Maximum accepted report size, given as a size (4M, 8M) or bytes (8388608).	Public
--minDiskAvail	string	1G	Minimum available space required on the report folder filesystem (e.g. 2%, 512M; 0 = disabled)	Public
--noSSL	bool	false	Disable SSL for the REST API	Public
--pprof	bool	false	Enable pprof profiler	Internal
--pprofPort	int	6062	Pprof server port	Internal
--reportFolder	string	~/.flexfs/error/reports	Report folder path	Public
--slackDebounce	string	60s	Minimum time between Slack notifications for the same remote address (e.g. 60s, 5m; 0 = disabled)	Internal
--slackExcerptLines	int	40	Lines of a report’s message to forward to Slack	Internal
--slackWebhook	string	""	Slack incoming webhook URL (overrides credentials file)	Internal
--sslCert	string	~/.flexfs/ssl/cert	SSL certificate file path	Public
--sslKey	string	~/.flexfs/ssl/key	SSL private key file path	Public
--verbose, -v	bool	false	Enable verbose logging	Public

Low disk space protection

The server writes each report under --reportFolder, which cannot be written safely on a filesystem that has run out of space. It therefore guards that filesystem:

• On startup, it refuses to start if the available space is already below --minDiskAvail.
• While running, it re-checks every minute and shuts down gracefully as soon as available space drops below --minDiskAvail.

Setting --minDiskAvail to 0 disables both checks.