Jenkins での SQL サーバーの自動化: 結果を美しく返す

もう一度 アレンジのテーマを継続 ゼロタッチ製品 RDSの下で。 将来の DBA は、PROD サーバーに直接接続できなくなりますが、 ジェンキンズ 限られた操作セットのジョブ。 DBA はジョブを開始し、しばらくして、この操作の完了に関するレポートを含むレターを受け取ります。 これらの結果をユーザーに表示する方法を見てみましょう。

Jenkins での SQL サーバーの自動化: 結果を美しく返す

プレーンテキスト

最も些細なことから始めましょう。 最初の方法は非常に簡単なので、特に話すことはありません (以下、著者は FreeStyle ジョブを使用します)。

Jenkins での SQL サーバーの自動化: 結果を美しく返す

sqlcmd 何かを実行し、それをユーザーに提示します。 たとえば、バックアップ ジョブに最適です。

Jenkins での SQL サーバーの自動化: 結果を美しく返す

ちなみに、RDS ではバックアップ/復元は非同期であるため、それを待つ必要があることを忘れないでください。

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

XNUMX 番目の方法、CSV

ここでもすべて非常にシンプルです。

Jenkins での SQL サーバーの自動化: 結果を美しく返す

ただし、この方法は、CSV で返されたデータが「単純」な場合にのみ機能します。 たとえば、この方法で上位 N 個の CPU 負荷の高いクエリのリストを返そうとすると、クエリ テキストにはカンマ、引用符、さらには改行などの任意の文字が含まれる可能性があるため、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 の行に注目してください。これは魔法のようなもので、グリッド内に XNUMX 行だけがあると、いくつかの問題が発生します。 解決策はあまり理解できないままインターネットから取得しました。 その結果、次のような形式の出力が得られます。

Jenkins での SQL サーバーの自動化: 結果を美しく返す

グラフを描く

警告: 以下に奇妙なコードがあります!
SQL サーバーには、過去 N 分間の CPU を表示する面白いクエリがあります。同志少佐はすべてを覚えていることが判明しました。 このクイズを試してみてください:

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
    }

これは次のようになります:

Jenkins での SQL サーバーの自動化: 結果を美しく返す

そう、ムッシュは倒錯についてよく知っているのです! 興味深いことに、このコードには Powershell (コード内に記述)、SQL、Xquery、HTML が含まれています。 HTML に Javascript を追加できないのは残念ですが (書き込み用なので)、Python コード (SQL で使用できる) を磨くのは全員の義務です。

SQLプロファイラのトレース出力

TextData フィールドがあるため、トレースが CSV に収まらないことは明らかです。 しかし、文字内にトレース グリッドを表示するのも奇妙です。サイズの点と、このデータはさらなる分析によく使用されるためです。 したがって、次のことを実行します。 invoke-SqlCmd 特定のスクリプト、その深部で実行されます

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

次へ другом DBA がアクセスできるサーバー上には、指定されたすべての列を受け入れる準備ができている空のテンプレート (モデル プレート) を備えたトレース データベースがあります。 このモデルを一意の名前を持つ新しいテーブルにコピーします。

$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 - これについてはすでに上で例を挙げました。 はい、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 文字を超える数字は 0 に置き換えられ、9 文字を超える文字列は 'str' に置き換えられます。 XNUMX から XNUMX までの数字はフラグとしてよく使用されますが、それらには触れません。また、その中には空の単一文字列 (「Y」、「N」などがよく見つかります) も含まれます。

生活に彩りを加えましょう(18禁)

表では、注意が必要なセルを強調表示したいことがよくあります。 たとえば、FAILS、高レベルの断片化などです。 もちろん、これは単純な SQL で実行でき、PRINT を使用して HTML を生成し、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>'

なぜそのようなコードを書いたのでしょうか?

Jenkins での SQL サーバーの自動化: 結果を美しく返す

しかし、もっと美しい解決策があります。 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>

クエリ自体にダミー列を追加します。 直前に 色を付けたい列。 列は次のように呼ばれる必要があります SQLマークアップ-何か:

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, 

Powershell によって生成された HTML を受け取ったので、ヘッダーからダミー列を削除し、データの本文で列の値をスタイルに転送します。 これは、次の XNUMX つの置換だけで実行されます。

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

結果:
Jenkins での SQL サーバーの自動化: 結果を美しく返す

エレガントじゃないですか? いやでも、このカラーリングは何かを思い出させます
Jenkins での SQL サーバーの自動化: 結果を美しく返す

出所: habr.com

コメントを追加します