SQL Database の拡張イベントのためのイベント ファイル ターゲット コードEvent File target code for extended events in SQL Database

拡張イベントに関する情報を確かな方法で取得し、レポートするための完全なコード サンプルが必要です。You want a complete code sample for a robust way to capture and report information for an extended event.

Microsoft SQL Server では、イベント出力をローカル ハード ドライブ ファイルに保存するために イベント ファイル ターゲット が使用します。In Microsoft SQL Server, the Event File target is used to store event outputs into a local hard drive file. ただし、このファイルは Azure SQL Database で利用できません。But such files are not available to Azure SQL Database. 代わりに、イベント ファイル ターゲットをサポートする Azure ストレージ サービスを使用します。Instead we use the Azure Storage service to support the Event File target.

このトピックでは、2 段階のコード サンプルを使用します。This topic presents a two-phase code sample:

  • PowerShell。クラウドで Azure Storage コンテナーを作成します。PowerShell, to create an Azure Storage container in the cloud.
  • Transact-SQL:Transact-SQL:

    • イベント ファイル ターゲットに Azure Storage コンテナーを割り当てます。To assign the Azure Storage container to an Event File target.
    • イベント セッションを作成し、開始するなどを行います。To create and start the event session, and so on.

前提条件Prerequisites

フェーズ 1: Azure Storage コンテナーの PowerShell コードPhase 1: PowerShell code for Azure Storage container

この PowerShell は 2 段階のコード サンプルの第 1 段階です。This PowerShell is phase 1 of the two-phase code sample.

このスクリプトは、前の実行があれば、その後でクリーンアップするコマンドで始まるので、再実行可能です。The script starts with commands to clean up after a possible previous run, and is rerunnable.

  1. PowerShell スクリプトを Notepad.exe のような単純なテキスト エディターに貼り付け、 .ps1拡張子が付いたファイルとしてスクリプトを保存します。Paste the PowerShell script into a simple text editor such as Notepad.exe, and save the script as a file with the extension .ps1.
  2. PowerShell ISE を管理者として起動します。Start PowerShell ISE as an Administrator.
  3. プロンプトで、「At the prompt, type
    Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
    」と入力し、Enter キーを押します。and then press Enter.
  4. PowerShell ISE で、 .ps1 ファイルを開きます。In PowerShell ISE, open your .ps1 file. スクリプトを実行します。Run the script.
  5. 最初に新しいウィンドウが開きます。そこから Azure にログインします。The script first starts a new window in which you log in to Azure.

    • セッションを妨げずにスクリプトを再実行するために、 Add-AzureAccount コマンドをコメントアウトする便利なオプションがあります。If you rerun the script without disrupting your session, you have the convenient option of commenting out the Add-AzureAccount command.

Azure モジュールがインストールされ、スクリプトの実行準備が整っている PowerShell ISE。

PowerShell コードPowerShell code

この PowerShell スクリプトでは、AzureRm モジュールに対してコマンドレット Import-Module を既に 実行してあるものとします。This PowerShell script assumes you have already run the cmdlet Import-Module for the AzureRm module. リファレンス ドキュメントについては、「PowerShell Module Browser」(PowerShell モジュール ブラウザー) をご覧ください。For reference documentation, see PowerShell Module Browser.

## TODO: Before running, find all 'TODO' and make each edit!!

cls;

#--------------- 1 -----------------------

'Script assumes you have already logged your PowerShell session into Azure.
But if not, run  Add-AzureRmAccount (or  Login-AzureRmAccount), just one time.';
#Add-AzureRmAccount;   # Same as  Login-AzureRmAccount.

#-------------- 2 ------------------------

'
TODO: Edit the values assigned to these variables, especially the first few!
';

# Ensure the current date is between
# the Expiry and Start time values that you edit here.

$subscriptionName    = 'YOUR_SUBSCRIPTION_NAME';
$resourceGroupName   = 'YOUR_RESOURCE-GROUP-NAME';

$policySasExpiryTime = '2018-08-28T23:44:56Z';
$policySasStartTime  = '2017-10-01';

$storageAccountLocation = 'West US';
$storageAccountName     = 'YOUR_STORAGE_ACCOUNT_NAME';
$contextName            = 'YOUR_CONTEXT_NAME';
$containerName          = 'YOUR_CONTAINER_NAME';
$policySasToken         = ' ? ';

$policySasPermission = 'rwl';  # Leave this value alone, as 'rwl'.

#--------------- 3 -----------------------

# The ending display lists your Azure subscriptions.
# One should match the $subscriptionName value you assigned
#   earlier in this PowerShell script. 

'Choose an existing subscription for the current PowerShell environment.';

Select-AzureRmSubscription -Subscription $subscriptionName;

#-------------- 4 ------------------------

'
Clean up the old Azure Storage Account after any previous run, 
before continuing this new run.';

If ($storageAccountName)
{
    Remove-AzureRmStorageAccount `
        -Name              $storageAccountName `
        -ResourceGroupName $resourceGroupName;
}

#--------------- 5 -----------------------

[System.DateTime]::Now.ToString();

'
Create a storage account. 
This might take several minutes, will beep when ready.
  ...PLEASE WAIT...';

New-AzureRmStorageAccount `
    -Name              $storageAccountName `
    -Location          $storageAccountLocation `
    -ResourceGroupName $resourceGroupName `
    -SkuName           'Standard_LRS';

[System.DateTime]::Now.ToString();
[System.Media.SystemSounds]::Beep.Play();

'
Get the access key for your storage account.
';

$accessKey_ForStorageAccount = `
    (Get-AzureRmStorageAccountKey `
        -Name              $storageAccountName `
        -ResourceGroupName $resourceGroupName
        ).Value[0];

"`$accessKey_ForStorageAccount = $accessKey_ForStorageAccount";

'Azure Storage Account cmdlet completed.
Remainder of PowerShell .ps1 script continues.
';

#--------------- 6 -----------------------

# The context will be needed to create a container within the storage account.

'Create a context object from the storage account and its primary access key.
';

$context = New-AzureStorageContext `
    -StorageAccountName $storageAccountName `
    -StorageAccountKey  $accessKey_ForStorageAccount;

'Create a container within the storage account.
';

$containerObjectInStorageAccount = New-AzureStorageContainer `
    -Name    $containerName `
    -Context $context;

'Create a security policy to be applied to the SAS token.
';

New-AzureStorageContainerStoredAccessPolicy `
    -Container  $containerName `
    -Context    $context `
    -Policy     $policySasToken `
    -Permission $policySasPermission `
    -ExpiryTime $policySasExpiryTime `
    -StartTime  $policySasStartTime;

'
Generate a SAS token for the container.
';
Try
{
    $sasTokenWithPolicy = New-AzureStorageContainerSASToken `
        -Name    $containerName `
        -Context $context `
        -Policy  $policySasToken;
}
Catch 
{
    $Error[0].Exception.ToString();
}

#-------------- 7 ------------------------

'Display the values that YOU must edit into the Transact-SQL script next!:
';

"storageAccountName: $storageAccountName";
"containerName:      $containerName";
"sasTokenWithPolicy: $sasTokenWithPolicy";

'
REMINDER: sasTokenWithPolicy here might start with "?" character, which you must exclude from Transact-SQL.
';

'
(Later, return here to delete your Azure Storage account. See the preceding  Remove-AzureRmStorageAccount -Name $storageAccountName)';

'
Now shift to the Transact-SQL portion of the two-part code sample!';

# EOFile

PowerShell スクリプトが終了したら、出力された名前付きの値を書き留めます。Take note of the few named values that the PowerShell script prints when it ends. 後続の第 2 段階で、これらの値を使用するように Transact-SQL スクリプトを編集する必要があります。You must edit those values into the Transact-SQL script that follows as phase 2.

フェーズ 2: Azure Storage コンテナーを使用する Trasact-SQL コードPhase 2: Transact-SQL code that uses Azure Storage container

  • このコード サンプルの第 1 段階で、PowerShell スクリプトを実行し、Azure ストレージ コンテナーを作成しました。In phase 1 of this code sample, you ran a PowerShell script to create an Azure Storage container.
  • 次の第 2 段階では、次の Transact-SQL スクリプトでそのコンテナーを使用する必要があります。Next in phase 2, the following Transact-SQL script must use the container.

このスクリプトは、前の実行があれば、その後でクリーンアップするコマンドで始まるので、再実行可能です。The script starts with commands to clean up after a possible previous run, and is rerunnable.

PowerShell スクリプトの終了時に、名前付きの値がいくつか出力されました。The PowerShell script printed a few named values when it ended. それらの値を使用するように Transact-SQL スクリプトを編集する必要があります。You must edit the Transact-SQL script to use those values. Transact-SQL スクリプトの TODO を探し、編集する箇所を見つけます。Find TODO in the Transact-SQL script to locate the edit points.

  1. SQL Server Management Studio (ssms.exe) を開きます。Open SQL Server Management Studio (ssms.exe).
  2. Azure SQL Database データベースに接続します。Connect to your Azure SQL Database database.
  3. クリックし、新しいクエリ ウィンドウを開きます。Click to open a new query pane.
  4. 次の Transact-SQL スクリプトをクエリ ウィンドウに貼り付けます。Paste the following Transact-SQL script into the query pane.
  5. スクリプトにある TODO をすべて探し、適宜編集します。Find every TODO in the script and make the appropriate edits.
  6. 保存し、スクリプトを実行します。Save, and then run the script.

警告

前述の PowerShell スクリプトによって生成された SAS キーの値は、"?" (疑問符) で始まる場合があります。The SAS key value generated by the preceding PowerShell script might begin with a '?' (question mark). 次の T-SQL スクリプトで SAS キーを使用する場合は、 先頭の "?" を削除する必要があります。When you use the SAS key in the following T-SQL script, you must remove the leading '?'. 削除しないと、セキュリティによって操作がブロックされる可能性があります。Otherwise your efforts might be blocked by security.

Transact-SQL コードTransact-SQL code

---- TODO: First, run the earlier PowerShell portion of this two-part code sample.
---- TODO: Second, find every 'TODO' in this Transact-SQL file, and edit each.

---- Transact-SQL code for Event File target on Azure SQL Database.


SET NOCOUNT ON;
GO


----  Step 1.  Establish one little table, and  ---------
----  insert one row of data.


IF EXISTS
    (SELECT * FROM sys.objects
        WHERE type = 'U' and name = 'gmTabEmployee')
BEGIN
    DROP TABLE gmTabEmployee;
END
GO


CREATE TABLE gmTabEmployee
(
    EmployeeGuid         uniqueIdentifier   not null  default newid()  primary key,
    EmployeeId           int                not null  identity(1,1),
    EmployeeKudosCount   int                not null  default 0,
    EmployeeDescr        nvarchar(256)          null
);
GO


INSERT INTO gmTabEmployee ( EmployeeDescr )
    VALUES ( 'Jane Doe' );
GO


------  Step 2.  Create key, and  ------------
------  Create credential (your Azure Storage container must already exist).


IF NOT EXISTS
    (SELECT * FROM sys.symmetric_keys
        WHERE symmetric_key_id = 101)
BEGIN
    CREATE MASTER KEY ENCRYPTION BY PASSWORD = '0C34C960-6621-4682-A123-C7EA08E3FC46' -- Or any newid().
END
GO


IF EXISTS
    (SELECT * FROM sys.database_scoped_credentials
        -- TODO: Assign AzureStorageAccount name, and the associated Container name.
        WHERE name = 'https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent')
BEGIN
    DROP DATABASE SCOPED CREDENTIAL
        -- TODO: Assign AzureStorageAccount name, and the associated Container name.
        [https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent] ;
END
GO


CREATE
    DATABASE SCOPED
    CREDENTIAL
        -- use '.blob.',   and not '.queue.' or '.table.' etc.
        -- TODO: Assign AzureStorageAccount name, and the associated Container name.
        [https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent]
    WITH
        IDENTITY = 'SHARED ACCESS SIGNATURE',  -- "SAS" token.
        -- TODO: Paste in the long SasToken string here for Secret, but exclude any leading '?'.
        SECRET = 'sv=2014-02-14&sr=c&si=gmpolicysastoken&sig=EjAqjo6Nu5xMLEZEkMkLbeF7TD9v1J8DNB2t8gOKTts%3D'
    ;
GO


------  Step 3.  Create (define) an event session.  --------
------  The event session has an event with an action,
------  and a has a target.

IF EXISTS
    (SELECT * from sys.database_event_sessions
        WHERE name = 'gmeventsessionname240b')
BEGIN
    DROP
        EVENT SESSION
            gmeventsessionname240b
        ON DATABASE;
END
GO


CREATE
    EVENT SESSION
        gmeventsessionname240b
    ON DATABASE

    ADD EVENT
        sqlserver.sql_statement_starting
            (
            ACTION (sqlserver.sql_text)
            WHERE statement LIKE 'UPDATE gmTabEmployee%'
            )
    ADD TARGET
        package0.event_file
            (
            -- TODO: Assign AzureStorageAccount name, and the associated Container name.
            -- Also, tweak the .xel file name at end, if you like.
            SET filename =
                'https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent/anyfilenamexel242b.xel'
            )
    WITH
        (MAX_MEMORY = 10 MB,
        MAX_DISPATCH_LATENCY = 3 SECONDS)
    ;
GO


------  Step 4.  Start the event session.  ----------------
------  Issue the SQL Update statements that will be traced.
------  Then stop the session.

------  Note: If the target fails to attach,
------  the session must be stopped and restarted.

ALTER
    EVENT SESSION
        gmeventsessionname240b
    ON DATABASE
    STATE = START;
GO


SELECT 'BEFORE_Updates', EmployeeKudosCount, * FROM gmTabEmployee;

UPDATE gmTabEmployee
    SET EmployeeKudosCount = EmployeeKudosCount + 2
    WHERE EmployeeDescr = 'Jane Doe';

UPDATE gmTabEmployee
    SET EmployeeKudosCount = EmployeeKudosCount + 13
    WHERE EmployeeDescr = 'Jane Doe';

SELECT 'AFTER__Updates', EmployeeKudosCount, * FROM gmTabEmployee;
GO


ALTER
    EVENT SESSION
        gmeventsessionname240b
    ON DATABASE
    STATE = STOP;
GO


-------------- Step 5.  Select the results. ----------

SELECT
        *, 'CLICK_NEXT_CELL_TO_BROWSE_ITS_RESULTS!' as [CLICK_NEXT_CELL_TO_BROWSE_ITS_RESULTS],
        CAST(event_data AS XML) AS [event_data_XML]  -- TODO: In ssms.exe results grid, double-click this cell!
    FROM
        sys.fn_xe_file_target_read_file
            (
                -- TODO: Fill in Storage Account name, and the associated Container name.
                'https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent/anyfilenamexel242b',
                null, null, null
            );
GO


-------------- Step 6.  Clean up. ----------

DROP
    EVENT SESSION
        gmeventsessionname240b
    ON DATABASE;
GO

DROP DATABASE SCOPED CREDENTIAL
    -- TODO: Assign AzureStorageAccount name, and the associated Container name.
    [https://gmstorageaccountxevent.blob.core.windows.net/gmcontainerxevent]
    ;
GO

DROP TABLE gmTabEmployee;
GO

PRINT 'Use PowerShell Remove-AzureStorageAccount to delete your Azure Storage account!';
GO

実行時にターゲットがアタッチできなかった場合、イベント セッションを停止し、再起動する必要があります。If the target fails to attach when you run, you must stop and restart the event session:

ALTER EVENT SESSION ... STATE = STOP;
GO
ALTER EVENT SESSION ... STATE = START;
GO

出力Output

Transact-SQL スクリプトが完了したら、event_data_XML 列ヘッダーの下にあるセルをクリックします。When the Transact-SQL script completes, click a cell under the event_data_XML column header. 要素が 1 つ表示されます。これに UPDATE ステートメントが 1 つ表示されます。One element is displayed which shows one UPDATE statement.

ここに、テスト中に生成された 要素が 1 つあります。Here is one element that was generated during testing:

<event name="sql_statement_starting" package="sqlserver" timestamp="2015-09-22T19:18:45.420Z">
  <data name="state">
    <value>0</value>
    <text>Normal</text>
  </data>
  <data name="line_number">
    <value>5</value>
  </data>
  <data name="offset">
    <value>148</value>
  </data>
  <data name="offset_end">
    <value>368</value>
  </data>
  <data name="statement">
    <value>UPDATE gmTabEmployee
    SET EmployeeKudosCount = EmployeeKudosCount + 2
    WHERE EmployeeDescr = 'Jane Doe'</value>
  </data>
  <action name="sql_text" package="sqlserver">
    <value>

SELECT 'BEFORE_Updates', EmployeeKudosCount, * FROM gmTabEmployee;

UPDATE gmTabEmployee
    SET EmployeeKudosCount = EmployeeKudosCount + 2
    WHERE EmployeeDescr = 'Jane Doe';

UPDATE gmTabEmployee
    SET EmployeeKudosCount = EmployeeKudosCount + 13
    WHERE EmployeeDescr = 'Jane Doe';

SELECT 'AFTER__Updates', EmployeeKudosCount, * FROM gmTabEmployee;
</value>
  </action>
</event>

前述のTransact-SQL スクリプトでは、event_file の読み取りに次のシステム関数を使用します。The preceding Transact-SQL script used the following system function to read the event_file:

拡張イベントのデータ表示の高度なオプションについての説明は、次で入手できます。An explanation of advanced options for the viewing of data from extended events is available at:

SQL Server で実行できるようにコード サンプルを変換するConverting the code sample to run on SQL Server

先の Transact-SQL サンプルを Microsoft SQL Server で実行するとします。Suppose you wanted to run the preceding Transact-SQL sample on Microsoft SQL Server.

  • わかりやすくするために、Azure Storage コンテナーの使用を「C:\myeventdata.xel」のような単純なファイルに完全に置換します。For simplicity, you would want to completely replace use of the Azure Storage container with a simple file such as C:\myeventdata.xel. ファイルは SQL Server をホストするコンピューターのローカル ハード ドライブに書き込まれます。The file would be written to the local hard drive of the computer that hosts SQL Server.
  • CREATE MASTER KEYCREATE CREDENTIAL には Transact-SQL ステートメントを必要としません。You would not need any kind of Transact-SQL statements for CREATE MASTER KEY and CREATE CREDENTIAL.
  • CREATE EVENT SESSION ステートメントの ADD TARGET 句で、filename= に割り当てられている HTTP 値を「C:\myfile.xel」のような完全パス文字列に置換します。In the CREATE EVENT SESSION statement, in its ADD TARGET clause, you would replace the Http value assigned made to filename= with a full path string like C:\myfile.xel.

    • Azure ストレージ アカウントは必要ありません。No Azure Storage account need be involved.

詳細情報More information

Azure ストレージ サービスのアカウントとコンテナーに関する詳細については、次を参照してください。For more info about accounts and containers in the Azure Storage service, see: