Dnes bych Vás chtěl seznámit s jedním zajímavým programem přímo od Sitecore a to Sitecore Diagnostics Toolset. Před nedávnem jsme se bavili s kolegy, že by bylo skvělé, kdyby existoval nějaký nástroj, který by nám dokázal projet instalaci Sitecore a říci, zda máme vše nastavené správně, nainstalované opravné balíčky, které existují pro danou verzi Sitecore a zkrátka prozkoumal, zda je vše, tak jak má být. Takže jsem začal pátrat a našel program přímo od Sitecore a v tomto článku se Vám ho pokusím popsat.

K čemu aplikace slouží

Sitecore Diagnostics Toolset slouží k automatické diagnostice Sitecore webů. Tento nástroj dokáže vybraný web projet a prozkoumat následující oblasti:

  • Otestovat konzistenci a konfiguraci webu
  • Otestovat známé problémy (tzv. known issues) a symptomy, které se vztahují k dané verzi Sitecore, na které zkoumaný web běží
  • Otestovat, zda jsou dodržena doporučení ze Sitecore dokumentace (tzv. recommendations)
  • A jako poslední vygenerovat přehledný html report s výsledky diagnostiky

Jak aplikaci nainstalovat

Program je distribuován jako windows aplikace a jeho domovská stránka se nachází zde – https://github.com/Sitecore/Sitecore-Diagnostics-Toolset. Instalace je velmi jednoduchá, je zde pro Vás připraven tzv. ClickOnce installer (viz. Obrázek 1), na který na webu kliknete a aplikace se nainstaluje. Velmi doporučuji použít následující odkaz – http://dl.sitecore.net/updater/qa/sdt který odkazuje na tzv. nighly version, tedy vždy známou poslední verzi. Vzhledem k podstatě programu, kdy mimo jiné testuje known issues je třeba, aby byl program co možná nejaktuálnější, doporučuji tedy pravidelně aktualizovat.

sdt_installer

Obrázek 1 – ClickOnce installer

Jak spustit diagnostiku

Po zdárné instalaci a spuštění programu se objeví úvodní obrazovka (viz. Obrázek 2). Celý program je koncipován jako průvodce, máte zde známá tlačítka „next“ „back“ „start“, tedy nic složitého.

sdt_step1

Obrázek 2 – úvodní obrazovka

V následujícím kroku (viz. Obrázek 3) vyberete web (instanci), který chcete diagnostikovat. Druhou možností je nechat diagnostikovat tzv. SSPG package, tedy zip soubor, který obsahuje výsledek ze známého „Sitecore Support Package Generator“ – https://marketplace.sitecore.net/en/Modules/Sitecore_Support_Package_Generator.aspx. Tato možnost je bezvadná zejména tehdy, pokud nebudete chtít instalovat tento diagnostický nástroj na produkční sever. Pak si pouze na produkčním serveru vytvoříte pomocí SSPG balíček, ten si stáhnete a diagnostiku můžete provést na libovolném jiném počítači, kde si nástroj nainstalujete. Tato možnost má ovšem i svá omezení, kdy například diagnostika nastavení práv na různé adresáře, se nedá přes sspg package otestovat. Záleží tedy na Vás, jakou možnost zvolíte.

sdt_step2

Obrázek 3 – výběr Sitecore instance

Po vybrání jedné z možností se ocitnete na dalším kroku průvodce (viz. Obrázek 4), kde určíte pro jaký účel se daná instance Sitecore používá, tedy např. Content Delivery Server, Content Management server atd. V druhé části pak určíte, které typy testů se mají spustit. Následně stačí kliknout na tlačítko „Start“ a čekat, až diagnostika doběhne.

sdt_step3

Obrázek 4 – volba testů

V průběhu giagnostiky se objeví následující obrazovka (viz. Obrázek 5), kde se po kliknutí na text „More infromation“ objeví okno s detailními informacemi o právě probíhajícím testu. Celá diagnostika může trvat i několik desítek minut, záleží na velikosti testované Sitecore instance. Což mě přivádí k myšlence, že bych Vás měl na tento fakt upozornit, protože při mém prvním spuštění jsem si myslel, že program nefunguje, když se několik minut nic nedělo 🙂 Ale neděste se, buďte trpěliví a čekejte až diagnostika doběhne do konce.

sdt_step4

Obrázek 5 – průběh diagnostiky

Jakmile je diagnostika u konce, objeví se tlačítko „View results“ a vy se konečně dostane k tíženému dokumentu, tedy k vygenerovanému html reportu (viz. Obrázek 6).

sdt_step5

Obrázek 6 – konec diagnostiky, odkaz na report

Jak výsledky vyhodnotit

Jak již bylo na začátku řečeno, nástroj Sitecore Diagnostics Toolset jako výsledek diagnostiky vygeneruje html report, který vypadá zhruba následovně (viz. Obrázek 7).

sdt_report1

Obrázek 7 – ukázka html reportu

Celý report je rozdělen na tři části:

  1. Hlavička – zobrazuje souhrnné informace o testu
  2. Filtry – filtrování je možné podle pěti přednastavených typů a slouží k tomu, aby si mohl uživatel zobrazit vždy část reportu, která ho aktuálně zajímá.
  3. Tabulka výsledků – v této části jsou již výsledky jednotlivých testů. Výsledky jsou rozděleny na několik základních skupin (Errors, Warning atd.) přičemž každá skupina je oddělena i barevně.

Ve výsledcích jednotlivých testů najdete vždy informace o tom, co se testovalo, z jaké kategorie test pochází a zprávu, která popisuje daný test, kde v případě chyb nebo upozornění dostanete informaci o tom, jak danou věc napravit.

Zde je nutné upozornit na fakt, že někdy mohou být výsledky i trochu zavádějící a vždy tedy záleží na zdravém rozumu toho, kdo výsledky analyzuje. Jako příklad takového positive warning mohu uvést například výsledek testu na Global.asax s tímto textem „The Global.asax file must use the Sitecore.Web.Application base class or inherit from it.“, který například na mém testovaném webu nebyl pravda, protože v projektu je Global.asax zděděn z vlastní třídy, ale ta dědí z třídy Sitecore.Web.Application a to již nedokázal test odhalit. Tedy platí pravidlo, že je vše třeba s rozvahou prozkoumat a udělat si vlastní úsudek. I když na druhou stranu je dobré, že například v tomto případě na to nástroj upozorní, i toho si cením.

Závěr

Sitecore Diagnostics Toolset není jistě všemocný, ale rozhodně se jedná o povedený program, který rozhodně pomáhá k odhalování různých nekonzistencí v nastavení, upozorňuje na existující a již odhalené problémy na které existují opravy atd. Doufám, že Vám tento článek pomohl se v tomto nástroji zorientovat.