Automatizácia servera SQL v Jenkins: krásne vracia výsledok

znovu pokračovanie v téme usporiadania Zero Touch PROD pod RDS. Budúci správci databáz sa nebudú môcť pripojiť k serverom PROD priamo, ale budú ich môcť používať Jenkins úlohy pre obmedzený súbor operácií. DBA spustí úlohu a po určitom čase dostane list so správou o dokončení tejto operácie. Pozrime sa na spôsoby, ako tieto výsledky prezentovať používateľovi.

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Plain Text

Začnime tým najtriviálnejším. Prvá metóda je taká jednoduchá, že nie je o čom hovoriť (autor ďalej používa úlohy FreeStyle):

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

sqlcmd niečo urobí a my to predstavíme používateľovi. Ideálne napríklad pre úlohy zálohovania:

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Mimochodom, nezabudnite, že v rámci RDS je zálohovanie/obnovenie asynchrónne, takže na to musíte počkať:

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

Druhá metóda, CSV

Všetko je tu tiež veľmi jednoduché:

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Táto metóda však funguje iba vtedy, ak sú údaje vrátené v CSV „jednoduché“. Ak sa takýmto spôsobom pokúsite vrátiť napríklad zoznam TOP N dopytov náročných na CPU, CSV bude „korodovať“, pretože text dopytu môže obsahovať ľubovoľné znaky – čiarky, úvodzovky a dokonca aj zlomy riadkov. Preto potrebujeme niečo zložitejšie.

Krásne znaky v HTML

Hneď vám poskytnem útržok kódu

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

Mimochodom, dávajte pozor na riadok so System.Management.Automation.PSCustomObject, je to magické, ak je v mriežke presne jeden riadok, nastali problémy. Riešenie bolo prevzaté z internetu bez veľkého pochopenia. V dôsledku toho dostanete výstup vo formáte približne takto:

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Kreslenie grafov

Upozornenie: nižšie uvedený zmätený kód!
Na SQL serveri je vtipný dotaz, ktorý zobrazuje CPU za posledných N minút - ukázalo sa, že súdruh major si všetko pamätá! Vyskúšajte tento kvíz:

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 pomocou tohto formátovania (premenná $ 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>

Môžeme vytvoriť telo listu:

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

Ktorá bude vyzerať takto:

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Áno, Monsieur vie veľa o zvrátenosti! Je zaujímavé, že tento kód obsahuje: Powershell (v ňom napísaný), SQL, Xquery, HTML. Je škoda, že nemôžeme pridať Javascript do HTML (keďže je na písanie), ale vylepšiť Python kód (ktorý sa dá použiť v SQL) je povinnosťou každého!

Výstup sledovania profilovača SQL

Je jasné, že stopa sa nezmestí do CSV kvôli poľu TextData. Ale zobrazenie mriežky sledovania v liste je tiež zvláštne - kvôli veľkosti a preto, že tieto údaje sa často používajú na ďalšiu analýzu. Preto robíme nasledovné: voláme cez invoke-SqlCmd určitý scenár, v hĺbke ktorého sa to robí

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

Ďalej, ďalej priateľa Na serveri, ku ktorému má prístup DBA, je databáza Traces s prázdnou šablónou, Model plate, pripravená akceptovať všetky špecifikované stĺpce. Tento model skopírujeme do novej tabuľky s jedinečným názvom:

$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 do nej môžeme zapísať našu stopu pomocou Data.SqlClient.SqlBulkCopy - Už som uviedol príklad vyššie. Áno, bolo by tiež pekné maskovať konštanty v TextData:

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

Čísla dlhšie ako jeden znak nahrádzame 999 a reťazce dlhšie ako jeden znak nahrádzame 'str'. Ako vlajky sa často používajú čísla od 0 do 9, ktorých sa nedotýkame, často sa medzi nimi nachádzajú aj prázdne a jednoznakové reťazce - 'Y', 'N' atď.

Pridajme trochu farby do našich životov (prísne 18+)

V tabuľkách často chcete zvýrazniť bunky, ktoré si vyžadujú pozornosť. Napríklad FAILS, vysoká úroveň fragmentácie atď. Dá sa to samozrejme urobiť v holom SQL, vygenerovaním HTML pomocou PRINT a nastavením typu súboru na HTML v 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>'

Prečo som napísal takýto kód?

Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Existuje však aj krajšie riešenie. Previesť na HTML nedovolí nám zafarbiť bunky, ale môžeme to urobiť dodatočne. Napríklad chceme vybrať bunky s úrovňou fragmentácie viac ako 80 a viac ako 90. Pridajme štýly:

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

V samotnom dotaze pridáme fiktívny stĺpec bezprostredne predtým stĺpec, ktorý chceme vyfarbiť. Stĺpec by sa mal volať SQLmarkup-niečo:

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, keď dostaneme HTML vygenerovaný Powershell, odstránime fiktívny stĺpec z hlavičky a v tele údajov prenesieme hodnotu zo stĺpca do štýlu. Robí sa to iba dvoma substitúciami:

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

Výsledok:
Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Nie je to elegantné? Aj keď nie, toto sfarbenie mi niečo pripomína
Automatizácia servera SQL v Jenkins: krásne vracia výsledok

Zdroj: hab.com

Pridať komentár