Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

ismét a rendezés témáját folytatva Zero Touch PROD RDS alatt. A jövőbeli DBA-k nem tudnak majd közvetlenül csatlakozni a PROD-kiszolgálókhoz, de használhatók Jenkins munkák korlátozott számú művelethez. A DBA elindítja a munkát, és egy idő után levelet kap a művelet befejezéséről szóló jelentéssel. Nézzük meg, hogyan lehet ezeket az eredményeket bemutatni a felhasználónak.

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Plain Text

Kezdjük a legtriviálisabbal. Az első módszer annyira egyszerű, hogy valójában nincs miről beszélni (a szerző a továbbiakban FreeStyle munkákat használ):

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

sqlcmd csinál valamit, és bemutatjuk a felhasználónak. Ideális például biztonsági mentési munkákhoz:

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Egyébként ne felejtsd el, hogy az RDS biztonsági mentés/visszaállítás alatt aszinkron, tehát várnod kell rá:

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

Második módszer, a CSV

Itt is minden nagyon egyszerű:

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Ez a módszer azonban csak akkor működik, ha a CSV-ben visszaadott adatok "egyszerűek". Ha ilyen módon megpróbálja visszaadni például a TOP N CPU-igényes lekérdezések listáját, akkor a CSV „korrodálódik” amiatt, hogy a lekérdezés szövege bármilyen karaktert tartalmazhat - vesszőt, idézőjeleket, sőt sortöréseket is. Ezért valami bonyolultabbra van szükségünk.

Gyönyörű jelek HTML-ben

Azonnal adok egy kódrészletet

$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
  }

Egyébként figyelj a System.Management.Automation.PSCustomObject sorra, ez varázslatos, ha pontosan egy sor van a rácsban, akkor felmerült néhány probléma. A megoldást az internetről vették, különösebb értés nélkül. Ennek eredményeként a kimenet formázott lesz, valami ilyesmi:

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Grafikonok rajzolása

Figyelmeztetés: perverz kód lent!
Az SQL szerveren van egy vicces lekérdezés, ami az utolsó N perc CPU-ját jeleníti meg – kiderül, hogy Major elvtárs mindenre emlékszik! Próbáld ki ezt a kvízt:

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);

Most ezzel a formázással ($Fragment változó)

<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>

A levél törzsét alkothatjuk:

$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
    }

Ami így fog kinézni:

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Igen, Monsieur sokat tud a perverziókról! Érdekes, hogy ez a kód tartalmazza: Powershell (bele van írva), SQL, Xquery, HTML. Kár, hogy nem tudunk Javascriptet hozzáadni a HTML-hez (hiszen írásra való), de a Python kód (SQL-ben használható) csiszolása mindenkinek kötelessége!

SQL-profilozó nyomkövetési kimenet

Nyilvánvaló, hogy a nyomkövetés nem fog beleférni a CSV-be a TextData mező miatt. De a nyomkövetési rács megjelenítése egy levélben is furcsa - mind a méret miatt, mind azért, mert ezeket az adatokat gyakran használják további elemzésekhez. Ezért a következőket tesszük: telefonálunk keresztül invoke-SqlCmd egy bizonyos forgatókönyv, aminek a mélyén ez megtörténik

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

Legközelebb más A DBA által elérhető szerveren van egy Traces adatbázis egy üres sablonnal, a Model plate-vel, amely készen áll az összes megadott oszlop elfogadására. Ezt a modellt egy új táblába másoljuk egyedi névvel:

$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 

Most pedig beírhatjuk a nyomunkat a segítségével Data.SqlClient.SqlBulkCopy - Erre fentebb már hoztam példát. Igen, jó lenne elfedni a konstansokat a TextData-ban:

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

Az egy karakternél hosszabb számokat 999-re cseréljük, az egy karakternél hosszabb karakterláncokat pedig "str"-re cseréljük. A 0-tól 9-ig terjedő számokat gyakran használjuk zászlóként, és nem nyúlunk hozzájuk, valamint gyakran előfordulnak köztük üres és egykarakteres karakterláncok - 'Y', 'N' stb.

Vigyünk színt az életünkbe (szigorúan 18+)

A táblázatokban gyakran szeretné kiemelni a figyelmet igénylő cellákat. Például SIKERTELEN, nagyfokú töredezettség stb. Természetesen ez megtehető csupasz SQL-ben, PRINT segítségével HTML-t generálva, és Jenkinsben HTML-re állítva a fájltípust:

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>'

Miért írtam ilyen kódot?

Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

De van ennél szebb megoldás is. Konvertálás HTML-be nem engedi színezni a sejteket, de utólag megtehetjük. Például olyan cellákat szeretnénk kijelölni, amelyek töredezettségi szintje meghaladja a 80-at és a 90-et. Adjunk hozzá stílusokat:

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

Magában a lekérdezésben egy áloszlopot adunk hozzá közvetlenül előtte oszlopot szeretnénk színezni. Az oszlopot meg kell hívni SQLmarkup-valami:

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, 

Most, miután megkaptuk a Powershell által generált HTML-t, eltávolítjuk a dummy oszlopot a fejlécből, és az adattörzsben átvisszük az oszlop értékét a stílusba. Ez mindössze két helyettesítéssel történik:

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

Eredmény:
Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Hát nem elegáns? Bár nem, ez a színezés emlékeztet valamire
Az SQL szerver automatizálása Jenkinsben: az eredmény gyönyörű visszaadása

Forrás: will.com

Hozzászólás