In this tutorial, you will learn about the Umbraco health check and how you can use it to diagnose issues within your Umbraco CMS powered website. If you are using Umbraco 7.5+ you can use the Health Check tool to check that your website is configured correctly. This tool is a great time saver for developers and I recommend you get familiar with it.
Historically, to check that your Umbraco configuration was OK, you had to manually validate that your web server had the correct configuration. If your website was running in a load-balanced configuration, checking the site may involve remoting onto each server to check settings and log files. Now with the health check tool, a lot of these checks can be done within the CMS. The tool will check 5 key areas of your Umbraco website to ensure everything has been set up and configured in an optimal way for the production website. The five areas included in the health check report include configuration, data integrity, live environment settings, permissions, and security. Cool right 🔥🔥🔥?
To run a health check open the
Developmentsection in the Umbraco Backend:
From here, you should see the
Health Check tab, as seen above. Click on it!
Clicking on the 'Check All Groups' button will run all the health checks. Alternatively, you can run each search separately, but, seriously why?!?!? The health check will make sure you have things like permissions set correctly, you don't have the website running in debug mode, etc... If your site passes the health check, a little green tick will appear within each area. If you haven't configured Umbraco correctly then you'll see a red cross. Fixing issues is also pretty easy, if any of your checks fail, you'll see a 'Fix' button next to the failed check. In most instances, the error can be corrected by simply clicking the fix button.
⚠️⚠️ WARNING Depending on your deployment process, you need to be careful that any changes made on production, get copied back into your source code repository. You don't want to revert a fix the next time you deploy your site! ⚠️⚠️
That is all you need to know in order to master the health check tool. It is super useful. I recommend you run it once every other month to ensure your site is healthy. Happy Coding 🤘