Folder Size Check Reference

All parameters, thresholds, and configuration options for the folder size check in octoja.

Written By Erdinc Akay

Last updated About 2 months ago

The Folder Size Check measures the total size of specific directories and alerts when the size reaches or exceeds the configured thresholds.

Configuration fields

Field	Type	Required	Default	Description
Folders to monitor	List	Yes	—	One or more directories, each with path and thresholds
— Folder path	String	Yes	—	Absolute directory path
— Warning threshold (GB)	Number	No	50	Size in GB that triggers a warning
— Critical threshold (GB)	Number	No	100	Size in GB that triggers a critical result
Include subdirectories	Boolean	No	Yes	Include all files in subdirectories

The check runs every 60 minutes (hourly). The cadence is declared by the check itself and is not exposed as a per-instance configuration field.

Size per monitored folder (GB and bytes) — there is no aggregate total across folders
File count per folder
Per-folder count of files that could not be read (access denied) — surfaced in the result detail as "N files inaccessible (access denied)"
Per-folder result status and any error message recorded while scanning

Each folder is evaluated on its own; the overall check result is the worst per-folder result.

Situation	Per-folder result
Size below the warning threshold	OK
Size reaches or exceeds the warning / critical threshold	Warning / Critical
Folder path does not exist	Critical, with the error "Directory not found" (`dir-not-found`)
No file in the folder could be read	The error "Access denied to all files" (`access-denied`) is recorded; the measured size is 0, so the result follows the thresholds (usually OK)
Unexpected error while scanning	Failure

The check calculates the size by summing all file sizes in the directory tree. For directories with millions of files, execution may be slower.
The agent process must have read permission for the directory and its contents.
If the warning threshold is set higher than the critical threshold, the agent silently swaps the two values before evaluating — a misconfigured pair still produces useful results, but the configuration screen is the source of truth, not the alert payload.
If no folders are configured, the check reports Warning (not Failure and not OK) to surface the empty configuration without raising an incident.
Symbolic-link traversal follows .NET DirectoryInfo defaults and is not explicitly enabled or disabled by the check. Behaviour can differ between Windows, Linux, and macOS — if symlinks under a monitored path may point to large external directories, validate the resulting total against your expectation.

See also: Configure a Folder Size Check