sapling/eden/fs/monitor
Yedidya Feldblum 22a7fdfe34 migrate from LockedPtr::getUniqueLock
Summary: The new name is `LockedPtr::as_lock`.

Reviewed By: aary

Differential Revision: D28987868

fbshipit-source-id: 8abd6a69a1b9c884adf137f06c24fe0df9ddd089
2021-06-13 18:53:58 -07:00
..
test Remove dead includes in eden 2020-10-09 15:25:47 -07:00
EdenInstance.cpp Apply clang-format update fixes 2021-01-10 10:06:29 -08:00
EdenInstance.h eden: introduce SpawnedProcess 2020-09-01 13:31:32 -07:00
EdenMonitor.cpp enable log rotation in edenfs_monitor 2020-05-07 20:05:46 -07:00
EdenMonitor.h enable log rotation in edenfs_monitor 2020-05-07 20:05:46 -07:00
LogFile.cpp migrate from LockedPtr::getUniqueLock 2021-06-13 18:53:58 -07:00
LogFile.h enable log rotation in edenfs_monitor 2020-05-07 20:05:46 -07:00
LogRotation.cpp add log rotation support to edenfs_monitor 2020-05-07 20:05:45 -07:00
LogRotation.h add log rotation support to edenfs_monitor 2020-05-07 20:05:45 -07:00
main.cpp enable log rotation in edenfs_monitor 2020-05-07 20:05:46 -07:00
README.md add a new process to monitor EdenFS 2020-01-31 13:22:26 -08:00

This directory contains a wrapper process that monitors the EdenFS daemon. This wrapper process serves a few purposes:

Simplifies management of EdenFS across graceful restarts

This monitoring process provides a single parent process that can be monitored by systemd and other system management daemons, even across EdenFS graceful restarts. When a graceful restart is desired this wrapper daemon can spawn the new EdenFS instance, so that the new EdenFS instance is still part of the original service process hierarchy.

Note that using a wrapper for this purpose is not strictly required with systemd (it is possible to inform systemd that the main process ID has changed and it should monitor a new process moving forward). However, this wrapper provides us a bit more flexibility and control around the restart mechanism, and also makes it easier to monitor EdenFS with other service management frameworks on other platforms.

Log file management and rotation

This process reads all messages printed by EdenFS to stdout and stderr, and writes them to a log file, performing log rotation when appropriate.

Implementing log rotation properly is tricky otherwise, as there are many different sources that can end up writing data to EdenFS's stdout/stderr descriptors, including separate processes like the privhelper process and spawned Python subprocesses.

Intelligent Restarting of EdenFS when it is Idle

This wrapper process supports requests to trigger a restart at some point in the future when EdenFS appears to be idle.

While graceful restart should minimize user-visible disruption, it can still introduce a delay for I/O operations while the restart is in progress. Therefore it is still desirable to try and perform the restart while users are not actively accessing the file system, if possible.

This functionality is provided by the wrapper primarily because the wrapper provides a convenient location to centralize this management in case multiple restart attempts are requested before EdenFS becomes idle.