🥇Automatyzacja serwera SQL w Jenkins: piękne zwracanie wyniku

Znowu kontynuując temat aranżacji Zero Touch PROD w ramach RDS. Przyszli administratorzy baz danych nie będą mogli łączyć się bezpośrednio z serwerami PROD, ale będą mogli z nich korzystać Jenkins miejsc pracy dla ograniczonego zestawu operacji. DBA uruchamia zadanie i po pewnym czasie otrzymuje list z raportem o zakończeniu tej operacji. Przyjrzyjmy się sposobom zaprezentowania tych wyników użytkownikowi.

Plain Text

Zacznijmy od najbardziej banalnego. Pierwsza metoda jest tak prosta, że właściwie nie ma o czym mówić (autor dalej korzysta z zadań FreeStyle):

sqlcmd coś robi i przedstawiamy to użytkownikowi. Idealny na przykład do zadań tworzenia kopii zapasowych:

Przy okazji nie zapominaj, że w RDS tworzenie kopii zapasowych/przywracanie odbywa się asynchronicznie, więc musisz na to poczekać:

declare @rds table
  (id int, task_type varchar(128), database_name sysname, pct int, duration int, 
   lifecycle varchar(128), taskinfo varchar(max) null, 
   upd datetime, cre datetime,
   s3 varchar(256), ovr int, KMS varchar(256) null)
waitfor delay '00:00:20' 
insert into @rds exec msdb.dbo.rds_task_status @db_name='{db}'
select @xid=max(id) from @rds

again:
waitfor delay '00:00:02'
delete from @rds
insert into @rds exec msdb.dbo.rds_task_status @db_name='{db}' 
# {db} substituted with db name by powershell
select @stat=lifecycle,@info=taskinfo from @rds where id=@xid
if @stat not in ('ERROR','SUCCESS','CANCELLED') goto again

Druga metoda, CSV

Wszystko tutaj jest również bardzo proste:

Jednak ta metoda działa tylko wtedy, gdy dane zwrócone w pliku CSV są „proste”. Jeśli spróbujesz w ten sposób zwrócić na przykład listę zapytań obciążających procesor TOP N, plik CSV „skoroduje” ze względu na fakt, że tekst zapytania może zawierać dowolne znaki - przecinki, cudzysłowy, a nawet podziały wierszy. Dlatego potrzebujemy czegoś bardziej skomplikowanego.

Piękne znaki w HTML

Zaraz ci podam fragment kodu

$Header = @"
<style>
TABLE {border-width: 1px; border-style: solid; border-color: black; border-collapse: collapse;}
TH {border-width: 1px; padding: 3px; border-style: solid; border-color: black; background-color: #6495ED;}
TD {border-width: 1px; padding: 3px; border-style: solid; border-color: black;}
</style>
"@
  
$Result = invoke-Sqlcmd -ConnectionString $jstr -Query "select * from DbInv" `
  | Select-Object -Property * -ExcludeProperty "ItemArray", "RowError", "RowState", "Table", "HasErrors"
if ($Result -eq $null) { $cnt = 0; }
elseif ($Result.getType().FullName -eq "System.Management.Automation.PSCustomObject") { $cnt = 1; }
else { $cnt = $Result.Rows.Count; } 
if ($cnt -gt 0) {
  $body = "<h2>My table</h2>"
  $Result | ConvertTo-HTML -Title "Rows" -Head $header -body $body `
    | Out-File "res.log" -Append -Encoding UTF8
  } else {
    "<h3>No data</h3>" | Out-File "res.log" -Append -Encoding UTF8
  }

Swoją drogą zwróć uwagę na linię z System.Management.Automation.PSCustomObject, jest magiczna, jeśli w siatce jest dokładnie jedna linia, to pojawiają się pewne problemy. Rozwiązanie zostało zaczerpnięte z Internetu bez większego zrozumienia. W rezultacie otrzymasz dane wyjściowe sformatowane mniej więcej tak:

Rysowanie wykresów

Ostrzeżenie: poniższy kod jest perwersyjny!
Na serwerze SQL pojawia się zabawne zapytanie, które wyświetla procesor z ostatnich N minut - okazuje się, że Towarzysz Major wszystko pamięta! Wypróbuj ten quiz:

DECLARE @ts_now bigint = (SELECT cpu_ticks/(cpu_ticks/ms_ticks) 
  FROM sys.dm_os_sys_info WITH (NOLOCK)); 
SELECT TOP(256) 
  DATEADD(ms, -1 * (@ts_now - [timestamp]), GETDATE()) AS [EventTime],
  SQLProcessUtilization AS [SQLCPU], 
  100 - SystemIdle - SQLProcessUtilization AS [OtherCPU]
FROM (SELECT record.value('(./Record/@id)[1]', 'int') AS record_id, 
  record.value('(./Record/SchedulerMonitorEvent/SystemHealth/SystemIdle)[1]', 'int') 
    AS [SystemIdle], 
  record.value('(./Record/SchedulerMonitorEvent/SystemHealth/ProcessUtilization)[1]', 'int') 
    AS [SQLProcessUtilization], [timestamp] 
  FROM (SELECT [timestamp], CONVERT(xml, record) AS [record] 
  FROM sys.dm_os_ring_buffers WITH (NOLOCK)
  WHERE ring_buffer_type = N'RING_BUFFER_SCHEDULER_MONITOR' 
    AND record LIKE N'%<SystemHealth>%') AS x) AS y 
ORDER BY 1 DESC OPTION (RECOMPILE);

Teraz, używając tego formatowania (zmienna $Fragment)

<table style="width: 100%"><tbody><tr style="background-color: white; height: 2pt;">
  <td style="width: SQLCPU%; background-color: green;"></td>
  <td style="width: OtherCPU%; background-color: blue;"></td>
  <td style="width: REST%; background-color: #C0C0C0;"></td></tr></tbody>
</table>

Treść listu możemy uformować:

$Result = invoke-Sqlcmd -ConnectionString $connstr -Query $Query `
  | Select-Object -Property * -ExcludeProperty `
  "ItemArray", "RowError", "RowState", "Table", "HasErrors"
if ($Result.HasRows) {
  foreach($item in $Result) 
    { 
    $time = $itemEventTime 
    $sqlcpu = $item.SQLCPU
    $other = $itemOtherCPU
    $rest = 100 - $sqlcpu - $other
    $f = $fragment -replace "SQLCPU", $sqlcpu
    $f = $f -replace "OtherCPU", $other
    $f = $f -replace "REST", $rest
    $f | Out-File "res.log" -Append -Encoding UTF8
    }

Które będą wyglądać tak:

Tak, monsieur wie dużo o perwersjach! Co ciekawe, kod ten zawiera: Powershell (napisany w nim), SQL, Xquery, HTML. Szkoda, że nie możemy dodać JavaScriptu do HTML (bo służy do pisania), ale polerowanie kodu w Pythonie (który można wykorzystać w SQL) to obowiązek każdego!

Dane wyjściowe śledzenia profilera SQL

Oczywiste jest, że ślad nie zmieści się w pliku CSV ze względu na pole TextData. Ale wyświetlanie siatki śledzenia w liście jest również dziwne - zarówno ze względu na rozmiar, jak i dlatego, że dane te są często wykorzystywane do dalszej analizy. Dlatego robimy co następuje: dzwonimy poprzez wywołaj-SqlCmd pewien scenariusz, w głębi którego się to dokonuje

select 
  SPID,EventClass,TextData,
  Duration,Reads,Writes,CPU,
  StartTime,EndTime,DatabaseName,HostName,
  ApplicationName,LoginName
   from ::fn_trace_gettable ( @filename , default )

Następny другом Na serwerze dostępnym dla DBA znajduje się baza danych Traces z pustym szablonem, płytką modelową, gotową do przyjęcia wszystkich określonych kolumn. Kopiujemy ten model do nowej tabeli o unikalnej nazwie:

$dt = Get-Date -format "yyyyMMdd"
$tm = Get-Date -format "hhmmss"
$tableName = $srv + "_" + $dt + "_" + $tm
$copytab = "select * into " + $tableName + " from Model"
invoke-SqlCmd -ConnectionString $tstr -Query $copytab

A teraz możemy zapisać w nim nasz ślad za pomocą Data.SqlClient.SqlBulkCopy - Podałem już tego przykład powyżej. Tak, miło byłoby również zamaskować stałe w TextData:

# mask data
foreach ($Row in $Result)
{ 
  $v = $Row["TextData"]
  $v = $v -replace "'([^']{2,})'", "'str'" -replace "[0-9][0-9]+", '999'
  $Row["TextData"] = $v
}

Zamieniamy liczby dłuższe niż jeden znak na 999, a ciągi dłuższe niż jeden znak na „str”. Jako flagi często używane są liczby od 0 do 9, których nie dotykamy, a także często spotykane są wśród nich ciągi puste i jednoznakowe - „Y”, „N” itp.

Dodajmy trochę koloru swojemu życiu (tylko 18+)

W tabelach często chcesz wyróżnić komórki wymagające uwagi. Na przykład FAILS, wysoki poziom fragmentacji itp. Oczywiście można to zrobić w czystym SQL, generując HTML za pomocą PRINT i ustawiając typ pliku na HTML w Jenkins:

declare @body varchar(max), @chunk varchar(max)
set @body='<font face="Lucida Console" size="3">'
set @body=@body+'<b>Server name: '+@@servername+'</b><br>'
set @body=@body+'<br><br>'
set @body=@body+'<table><tr><th>Job</th><th>Last Run</th><th>Avg Duration, sec</th><th>Last Run, Sec</th><th>Last Status</th></tr>'
print @body

DECLARE tab CURSOR FOR SELECT '<tr><td>'+name+'</td><td>'+
  LastRun+'</td><td>'+
  convert(varchar,AvgDuration)+'</td><td>'+
  convert(varchar,LastDuration)+'</td><td>'+
    case when LastStatus<>'Succeeded' then '<font color="red">' else '' end+
      LastStatus+
      case when LastStatus<>'Succeeded' then '</font>' else '' end+
     +'</td><td>'
  from #j2
OPEN tab;  
FETCH NEXT FROM tab into @chunk
WHILE @@FETCH_STATUS = 0  
BEGIN
  print @chunk
  FETCH NEXT FROM tab into @chunk;  
END  
CLOSE tab;  
DEALLOCATE tab;
print '</table>'

Dlaczego napisałem taki kod?

Ale jest piękniejsze rozwiązanie. Konwertuj na HTML nie pozwala nam pokolorować komórek, ale możemy to zrobić po fakcie. Przykładowo chcemy wybrać komórki o poziomie fragmentacji większym niż 80 i większym niż 90. Dodajmy style:

<style>
.SQLmarkup-red { color: red; background-color: yellow; }
.SQLmarkup-yellow { color: black; background-color: #FFFFE0; }
.SQLmarkup-default { color: black; background-color: white; }
</style>

W samym zapytaniu dodamy fikcyjną kolumnę bezpośrednio przed kolumnę, którą chcemy pokolorować. Należy wywołać kolumnę znaczniki SQL-coś:

case  
  when ps.avg_fragmentation_in_percent>=90.0 then 'SQLmarkup-red'
  when ps.avg_fragmentation_in_percent>=80.0 then 'SQLmarkup-yellow'
  else 'SQLmarkup-default' 
  end as [SQLmarkup-1], 
ps.avg_fragmentation_in_percent,

Teraz, po otrzymaniu kodu HTML wygenerowanego przez Powershell, usuniemy fikcyjną kolumnę z nagłówka, a w treści danych przeniesiemy wartość z kolumny do stylu. Odbywa się to za pomocą tylko dwóch podstawień:

$html = $html `
  -replace "<th>SQLmarkup[^<]*</th>", "" `
  -replace "<td>SQLmarkup-(.+?)</td><td>",'<td class="SQLmarkup-$1">'

Wynik:

Czyż to nie eleganckie? Choć nie, ta kolorystyka coś mi przypomina

Źródło: www.habr.com

Automatyzacja serwera SQL w Jenkins: piękne zwracanie wyniku