Monitoring FileCloud

The ability to receive email notification when a MongoDB error occurs is available in FileCloud version 18.2 and later.

For security purposes, to initially access the API, you must now change the default API key. If you do not change it, when you enter a command to call the API, an error is returned.
Note: You are only required to change the default API key initially; after that, you can continue to use the new key you entered.


Administrators can use tools provided by FileCloud Server to review current statistics and monitor MongoDB.

  • Get stats using an HTTP REST API. This is useful for integration with external monitoring systems like Nagios.
  • Review email notifications about MongoDB errors. This is useful for preventing loss of data. For example, if you have a High Availability (HA) deployment, and one day after a VMs in the cluster dies you discover that the master MongoDB node replication failed weeks ago, then you would not be able to recover all of your data.


What do you want to do?


API URL


RETURNED XML DATA

<stats>
 <stat> 
<totalusers>55</totalusers> 
<fullaccessusers>25</fullaccessusers> 
<guestaccessusers>27</guestaccessusers>
<totalsize>87.5 GB</totalsize>
<totalsizeused>2.45 GB</totalsizeused>
<totalsizefree>85.05 GB</totalsizefree>
<totalsizeusedraw>2632858720</totalsizeusedraw>
<groupscount>19</groupscount>
<externalscount>10</externalscount>
<scratchuseddisk>19.69 GB</scratchuseddisk>
<scratchfreedisk>9.52 GB</scratchfreedisk>
<scratchsize>375.25 MB</scratchsize>
<sharescount>73</sharescount>
<localstoragefreedisk>9.52 GB</localstoragefreedisk>
<totalmanagedfiles>1190</totalmanagedfiles>
<totaldevicescount>45</totaldevicescount>
<totalauditrecords>7260</totalauditrecords>
<totalvalidmanagedfiles>818</totalvalidmanagedfiles>
<totalsyncfiles>822</totalsyncfiles>
<totalvalidmanagedfolders>178</totalvalidmanagedfolders>
<totalsyncfolders>171</totalsyncfolders>
<totalalerts>0</totalalerts>
</stat>
</stats>

The XML can be parsed to graph various values and to trigger various actions.


In FileCloud Server version 18.2 and later, you will automatically receive an email notification on MongoDB cluster failure status.

(warning) Please note that when MongoDB fails, then nothing will respond through FileCloud including the FileCloud cron jobs.

Therefore, the mongo health monitor must be running separately from and independent of FileCloud's cron jobs.

To run MongoHealth:

  1. In FileCloud Server version 18.2 and later, FileCloud includes a mongohealth folder in the following location:

    /server/resources/tools
  2. The email address that is sent the notification (TO) is configured by the following variable:

    TONIDOCLOUD_REPLY_TO_EMAIL
  3. Add the /server/resources/tools/index.php to the cron directly.