Автоматизация SQL server в Jenkins: возвращаем результат красиво / Хабр

Снова продолжая тему обустройства Zero Touch PROD под RDS. Будущие DBA не будут иметь возможности подключиться к PROD серверам напрямую, но смогут использовать Jenkins jobs для ограниченного набора операций. DBA запускает job и через некоторое время получает письмо с отчетом о выполнении этой операции. Давайте рассмотрим способы презентации этих результатов пользователю.

Plain Text

Начнем с самого тривиального. Первый способ настолько прост, что и говорить, в общем то, не о чем (автор здесь и далее использует FreeStyle jobs):

sqlcmd что-то выполняет, и мы презентуем это пользователю. Идеально подходит для, например, backup jobs:

Не забываем, кстати, что под RDS backup/restore аснихронен, поэтому надо бы его подождать:

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

Второй способ, CSV

Здесь все тоже очень просто:

Однако этот способ работает только, если данные, возвращаемые в CSV, «простые». Если вы попытаетесь подобным образом вернуть, например, список TOP N CPU intensive queries, то CSV «разъедется» из-за того, что текст запроса может содержать любые символы — запятые, кавычки, и даже переводы строк. Поэтому нам потребуется что-то посложнее.

Красивые таблички на HTML

Приведу сразу фрагмент кода

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

Кстати, обратите внимание на строку с System.Management.Automation.PSCustomObject, она магическая, если в гриде ровно одна строка, то возникали какие-то проблемы. Решение взято из интернета особо не разбираясь. В результате вы получите вывод, оформленный примерно так:

Рисуем графики

Внимание: извращенный код ниже!

Есть забавный запрос на SQL сервер, который выводит CPU за последние N минут — оказывается, товарищ майор все запоминает! Попробуйте эту кверь:

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

Теперь, используя такое форматирование (переменная $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>

Мы можем сформировать тело письма:

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

Которое будет выглядеть так:

Таки да, месье знает толк в извращениях! Интересно, что данный код содержит в себе: Powershell (на нем и написан), SQL, Xquery, HTML. Жаль что к HTML мы не можем добавить Javascript (так как это для письма), но шлифануть код Python (который можно использовать в SQL) долг каждого!

Вывод SQL profiler trace

Понятно, что трейс «не залезет» в CSV из-за поля TextData. Но выводить трейс гридом в письме тоже странно — и из-за размера, и потому, что часто эти данные используются для дальнейшего анализа. Поэтому мы делаем следующее: вызываем через invoke-SqlCmd некий скрипт, в недрах которого делается

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

Далее, на другом сервере, доступном DBA, существует база Traces с пустой заготовкой, табличкой Model, готовой принять все указанные колонки. Мы эту модель копируем в новую таблицу с уникальным именем:

$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

И теперь мы можем в нее записать наш трейс с помощью Data.SqlClient.SqlBulkCopy — пример этого я уже приводил выше. Да, еще неплохо бы сделать masking констант в TextData:

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

Мы заменяем числа более чем в один символ длиной на 999, а строки длиннее одного символа мы заменяем на 'str'. Числа от 0 до 9 часто используются как флаги, и мы их не трогаем, равно как и пустые и односимвольные строки — среди них часто встречаются 'Y', 'N' итд.

Добавим красок в нашу жизнь (строго 18+)

В табличках часто хочется выделить ячейки, требующие внимания. Например, FAILS, высокий уровень фрагментации итд. Конечно, это можно сделать и на голом SQL, формируя HTML с помощью PRINT, а в Jenkins поставить тип файла HTML:

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

Зачем я написал такой код?

Но есть более красивое решение. ConvertTo-HTML не дает нам раскрасить клетки, но мы можем сделать это постфактум. Например, мы хотим выделить клетки с уровнем фрагментации более 80 и более 90. Добавим стили:

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

В самой квери мы добавим фиктивную колонку непосредственно до колонки, которую хотим раскрасить. Колонка должна называться SQLmarkup-что-то:

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,

Теперь, получив HTML, созданный Powershell, мы уберем фиктивную колонку из заголовка, а в теле данных перенесем значение из колонки в стиль. Это делается всего двумя подстановками:

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

Результат:

Не правда ли, элегантно? Хотя нет, что-то эта раскраска мне напоминает