Skip to content

Add filewatcher

A SplitStream client is able to probe a set of directories and transfer all the files according to a configuration and a pattern.

Command: splitstream watcher

Options:

  • -c --conf the configuration file used
  • -p --probes the filewatcher probes configuration file
  • -s --status the status of the file transfered
  • -n --parallel (optional) the number of transfers ran at the same time.

Probes: filewatcher probes configuration file contains a Json formated as below

{
   "probes":[
      {
         "directory": "path/to/directory",
         "status": "path/to/statusfile",
         "partner": "remote",
         "login":"login",
         "rule":"send",
         "pattern":"*.txt",
         "info":"very important informations",
         "blocksize": 42,
         "block-cheksum":true,
         "hash":"sha256",
         "async":true,
         "parallel":1,
         "_comment": "parallel has no effect if async is true"
      }
   ]
}

Note: The rule used must be used to send files.

Status: The status of the file transferred is stored in a JSON file.

[
  {
     "filename":"path/to/file1",
     "status":false,
     "lastModified":"25/12/2021"
  },
  {
     "file":"path/to/file2",
     "transfered":true,
     "lastModified":"25/11/2021"
  }
]

Files to transfer are detected through filesystem notification.

Can a given file be tagged by multiple probe/filewatcher ? Yes Do each probe have its own status file or the status file is shared on the filewatcher level ? Each probes have its own status file Limits are on a Probe Basis

Edited by Maxime Robert
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information