Sitecore System Check PowerShell Report

Created: 4 Sep 2024, last update: 3 Oct 2024

Tip: Sitecore System Check PowerShell Report

Curious about your Sitecore environment's memory usage or whether the pagefile is being utilized? Want to know how many processors your server has, or simply check the size of your database? Perhaps you're interested in finding out how many items are currently in the database, excluding those stored as Items As Resources (IAR). Are your media blobs stored in the database or on disk?

With this PowerShell report, you no longer need physical access to your environment to gather such insights. This tool enables you to quickly check these aspects and more. However, some technical knowledge is necessary to accurately interpret the vast amount of data it provides.

Running Sitecore on Docker or Kubernetes? The results may vary, as the isolation differs. For Docker, you’ll see the CPU count and memory allocated to the container. On Kubernetes, you might see the server's CPU and memory, which could be larger than what you're actually allowed to use.

Currently, the report pulls some values from the master database, which is typically the one you want data from, or the web database if you're not on XM Cloud. The source code is available on GitHub, so feel free to extend it with any additional data you need.

Note: The report contains multiple pages, so be sure to navigate through them to view all the data.

Database or IAR:
In the Example above "Master Database Unversioned Media Size (byte)" is 46744089  this is the sum of all size field from Unversioned Media, see Sitecore content migration - Part 1: Media analysis for a use case. so unversioned media is not in this count, and also media items stored in IAR files is not in this count. For everything about IAR files see Find-overwritten-Sitecore-resource-items 

Database or File:
A media blob can be stored in Database, IAR or Disk. In the Example above Master Database Blob count / rows and Master Database Blob size are both 0, this is because the Sitecore from this report is using blob storage on disk.

Computer:
All names that start with Computer are coming from the PowerShell Get-ComputerInfo See the documentation at Microsoft

Process:
The names that start with Process using Get-WmiObject See Microsoft

Note: It depends on the server which fields there are.

See GitHub for source code and ready to install Sitecore Package download