2 Minuten Lesezeit (468 Worte)

Ergebnisse von sp_Blitz im Markdown Format

Dienstag, 01. Februar 2022

Die Prozedur sp_Blitz aus dem First Responder Kit von Brent Ozar überprüft die Konfiguration und den Zustand von Microsoft-SQL-Servern und listet die gefundenen Auffälligkeiten in einer Tabelle auf. Wir nutzen diese Prozedur sehr gerne beim ersten Kontakt mit neuen Kunden, um einen schnellen Überblick über die SQL Server zu erhalten.

Vor kurzem habe ich von der Möglichkeit erfahren, die Ergebnisse im Markdown-Format auszugeben. Diese möchte ich hier vorstellen, denn sie bietet Vorteile – hat aber leider auch Nachteile.

Die Vorteile

In den meisten Fällen führt der Kunde die Prozedur im SQL Server Management Studio (SSMS) aus und kopiert das Ergebnis in eine Excel-Tabelle. Über den Parameter @OutputType kann die Ausgabe aber auch in anderen Formaten ausgegeben werden, darunter auch als Aufzählungsliste im Markdown Format. So ist das Ergebnis einfach mal schnell in eine Mail kopiert, denn auch ohne Markdown-Editor ist eine Aufzählungsliste sehr gut zu lesen.

Wir können dann sehr einfach weitere Informationen in dieser Liste ergänzen und die Liste für den Kunden aufbereiten, um im Anschluss die für den Kunden relevanten Probleme gemeinsam anzugehen. Auch zur Ablage in der Dokumentation eignet sich eine Aufzählungsliste in vielen Fällen besser als eine Tabelle.

Die Funktionsweise

Aber Achtung: Leider verrät nur ein Blick in den Quellcode die genaue Funktionsweise, da nur eine knappe Dokumentation im Quellcode vorhanden ist. Denn bei @OutputType = 'markdown' passiert Folgendes:

Der Parameter @CheckProcedureCache wird auf 0 gesetzt, was aber auch der Standardwert für diesen Parameter ist (Quellcode).

Der Parameter @CheckServerInfo wird auf 1 gesetzt, wodurch zusätzliche Informationen wie die verwendete Version oder die Hardware-Ausstattung ausgegeben werden (Quellcode).

Die Ausgabe enthält jedoch keine Informationen über Sicherheitsaspekte. Das wurde eingeführt, da diese Funktionalität ursprünglich zum schnellen Teilen von Informationen über einen öffentlichen Kanal bei Slack gedacht war und dort solche sensiblen Informationen selbstverständlich nicht auftauchen sollen (Quellcode).

Die Nachteile

Damit eignet sich diese Funktionalität aber leider nicht mehr für einen umfassenden Blick auf das System. Wenn es jedoch nur um die wichtigsten Auffälligkeiten geht, wird in den meisten Fällen der Parameter @IgnorePrioritiesAbove mit dem Wert 50 verwendet. Diese Einstellung unterdrückt alle Sicherheitsaspekte und eine Ausgabe im Markdown-Format verändert nicht mehr den Inhalt und kann so für eine schnelle Übersicht genutzt werden:

sp_Blitz @IgnorePrioritiesAbove = 50, @OutputType = 'markdown'

Der Ausweg

Zudem besteht natürlich die Möglichkeit, die Umwandlung von der klassischen Tabellenausgabe in das Markdown-Format selbst vorzunehmen, zum Beispiel mit PowerShell. Ich habe das programmiert und dabei auch gleich noch ein paar Konfigurationsmöglichkeiten eingebaut. Das Skript finden Sie in meinem GitHub Repository.

Bei Interesse können wir das Skript auch auf Ihre Bedürfnisse anpassen, sprechen Sie uns dazu gerne an.

{loadmoduleid 179}