チュートリアル: IntelliTrace を使用した SharePoint アプリケーションのデバッグ

[アーティクル]
06/19/2023

IntelliTrace を使用すると、SharePoint ソリューション簡単にデバッグできます。従来のデバッガーでは、現時点のソリューションを示すスナップショットだけを取得できました。 IntelliTrace を使用すると、ソリューション内で過去に発生したイベントと、そのイベントが発生したコンテキストをレビューし、コードに移動できます。

このチュートリアルでは、配置済みアプリケーションからの IntelliTrace データの収集に Microsoft Monitoring Agent を使用して、Visual Studio で SharePoint プロジェクトをデバッグする方法について説明します。このデータを分析するには、Visual Studio Enterprise を使用する必要があります。このプロジェクトには、フィーチャーがアクティブ化されたときに、タスクリストにタスクを、お知らせリストにお知らせを追加するフィーチャーレシーバーが組み込まれます。フィーチャーが非アクティブ化されると、タスクは完了とマークされ、次のお知らせがお知らせリストに追加されます。ただし、このプロシージャには、プロジェクトの正常な実行を妨げる論理エラーが含まれています。 IntelliTrace を使用することで、このエラーを見つけて修正できます。

対象: このトピックの情報は、Visual Studio で作成された SharePoint ソリューションに適用されます。

このチュートリアルでは、次の作業について説明します。

フィーチャーレシーバーを作成する
フィーチャーレシーバーにコードを追加する
プロジェクトをテストする
Microsoft Monitoring Agent を使用して IntelliTrace データを収集する
SharePoint ソリューションのデバッグと修正

Note

次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio IDE のカスタマイズ」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

サポート対象エディションの Windows と SharePoint
Visual Studio Enterprise。

フィーチャーレシーバーを作成する

最初に、フィーチャーレシーバーがある空の SharePoint プロジェクトを作成します。

インストールしているバージョンの SharePoint を対象にする SharePoint ソリューションプロジェクトを作成し、「IntelliTraceTest」という名前を付けます。

SharePoint カスタマイズウィザードが表示されます。このウィザードで、プロジェクト用の SharePoint サイトとソリューションの信頼レベルの両方を指定できます。
[ファームソリューションとして配置する] オプションボタンをクリックし、[完了] ボタンをクリックします。

IntelliTrace は、ファームソリューションに対してのみ動作します。
ソリューションエクスプローラーで、[フィーチャー] ノードのショートカットメニューを開き、[フィーチャーの追加] を選択します。

Feature1.feature が表示されます。
Feature1.feature のショートカットメニューを開き、[イベントレシーバーの追加] を選択して、コードモジュールをフィーチャーに追加します。

フィーチャーレシーバーにコードを追加する

次に、フィーチャーレシーバー内の 2 つのメソッド (FeatureActivated と FeatureDeactivating) にコードを追加します。これらのメソッドは、SharePoint でフィーチャーがアクティブ化または非アクティブ化されたときにトリガーされます。

Feature1EventReceiver クラスの一番上に次のコードを追加します。このコードは、SharePoint サイトとサブサイトを指定する変数を宣言します。

// SharePoint site and subsite.
private string siteUrl = "http://localhost";
private string webUrl = "/";

' SharePoint site and subsite.
Private siteUrl As String = "http://localhost"
Private webUrl As String = "/"

FeatureActivated メソッドを次のコードで置き換えます。

public override void FeatureActivated(SPFeatureReceiverProperties properties)
{
    try
    {
        using (SPSite site = new SPSite(siteUrl))
        {
            using (SPWeb web = site.OpenWeb(webUrl))
            {
                // Reference the lists.
                SPList announcementsList = web.Lists["Announcements"];
                SPList taskList = web.Lists["Tasks"];

                // Add an announcement to the Announcements list.
                SPListItem listItem = announcementsList.Items.Add();
                listItem["Title"] = "Activated Feature: " + properties.Definition.DisplayName;
                listItem["Body"] = properties.Definition.DisplayName + " was activated on: " + DateTime.Now.ToString();
                listItem.Update();

                // Add a task to the Task list.
                SPListItem newTask = taskList.Items.Add();
                newTask["Title"] = "Deactivate feature: " + properties.Definition.DisplayName;
                newTask.Update();
            }
        }
    }

    catch (Exception e)
    {
        Console.WriteLine("Error: " + e.ToString());
    }

}

Public Overrides Sub FeatureActivated(ByVal properties As SPFeatureReceiverProperties)
    Try
        Using site As New SPSite(siteUrl)
            Using web As SPWeb = site.OpenWeb(webUrl)
                ' Reference the lists.
                Dim announcementsList As SPList = web.Lists("Announcements")
                Dim taskList As SPList = web.Lists("Tasks")

                ' Add an announcement to the Announcements list.
                Dim listItem As SPListItem = announcementsList.Items.Add()
                listItem("Title") = "Activated Feature: " & Convert.ToString(properties.Definition.DisplayName)
                listItem("Body") = Convert.ToString(properties.Definition.DisplayName) & " was activated on: " & DateTime.Now.ToString()
                listItem.Update()

                ' Add a task to the Task list.
                Dim newTask As SPListItem = taskList.Items.Add()
                newTask("Title") = "Deactivate feature: " & Convert.ToString(properties.Definition.DisplayName)
                newTask.Update()
            End Using
        End Using

    Catch e As Exception
        Console.WriteLine("Error: " & e.ToString())
    End Try

End Sub

FeatureDeactivating メソッドを次のコードで置き換えます。

public override void FeatureDeactivating(SPFeatureReceiverProperties properties)
{
    // The following line induces an error to demonstrate debugging.
    // Remove this line later for proper operation.
    throw new System.InvalidOperationException("A serious error occurred!");
    try
    {
        using (SPSite site = new SPSite(siteUrl))
        {
            using (SPWeb web = site.OpenWeb(webUrl))
            {
                // Reference the lists.
                SPList taskList = web.Lists["Tasks"];
                SPList announcementsList = web.Lists["Announcements"];

                // Add an announcement that the feature was deactivated.
                SPListItem listItem = announcementsList.Items.Add();
                listItem["Title"] = "Deactivated Feature: " + properties.Definition.DisplayName;
                listItem["Body"] = properties.Definition.DisplayName + " was deactivated on: " + DateTime.Now.ToString();
                listItem.Update();

                // Find the task that the feature receiver added to the Task list when the
                // feature was activated.
                SPQuery qry = new SPQuery();
                qry.Query = "<Where><Contains><FieldRef Name='Title' /><Value Type='Text'>Deactivate</Value></Contains></Where>";
                SPListItemCollection taskItems = taskList.GetItems(qry);

                foreach (SPListItem taskItem in taskItems)
                {
                    // Mark the task as complete.
                    taskItem["PercentComplete"] = 1;
                    taskItem["Status"] = "Completed";
                    taskItem.Update();
                }
            }
        }

    }

    catch (Exception e)
    {
        Console.WriteLine("Error: " + e.ToString());
    }
}

Public Overrides Sub FeatureDeactivating(ByVal properties As SPFeatureReceiverProperties)
    ' The following line induces an error to demonstrate debugging.
    ' Remove this line later for proper operation.
    Throw New System.InvalidOperationException("Serious error occurred!")
    Try
        Using site As New SPSite(siteUrl)
            Using web As SPWeb = site.OpenWeb(webUrl)
                ' Reference the lists.
                Dim taskList As SPList = web.Lists("Tasks")
                Dim announcementsList As SPList = web.Lists("Announcements")

                ' Add an announcement that the feature was deactivated.
                Dim listItem As SPListItem = announcementsList.Items.Add()
                listItem("Title") = "Deactivated Feature: " & Convert.ToString(properties.Definition.DisplayName)
                listItem("Body") = Convert.ToString(properties.Definition.DisplayName) & " was deactivated on: " & DateTime.Now.ToString()
                listItem.Update()

                ' Find the task that the feature receiver added to the Task list when the
                ' feature was activated.
                Dim qry As New SPQuery()
                qry.Query = "<Where><Contains><FieldRef Name='Title' /><Value Type='Text'>Deactivate</Value></Contains></Where>"
                Dim taskItems As SPListItemCollection = taskList.GetItems(qry)

                For Each taskItem As SPListItem In taskItems
                    ' Mark the task as complete.
                    taskItem("PercentComplete") = 1
                    taskItem("Status") = "Completed"
                    taskItem.Update()
                Next
            End Using

        End Using

    Catch e As Exception
        Console.WriteLine("Error: " & e.ToString())
    End Try

End Sub

プロジェクトをテストする

コードがフィーチャーレシーバーに追加され、データコレクターが実行されているので、SharePoint ソリューションを配置して実行し、それが正常に動作するかどうかをテストします。

重要

この例では、FeatureDeactivating イベントハンドラーでエラーがスローされます。このチュートリアルの後半で、データコレクターが作成した .iTrace ファイルを使用してこのエラーを特定します。

ソリューションを SharePoint に配置し、ブラウザーで SharePoint サイトを開きます。

フィーチャーは自動的にアクティブ化され、フィーチャーレシーバーによってお知らせとタスクが自動的に追加されます。
お知らせリストとタスク一覧の内容を表示します。

お知らせリストには Activated feature: IntelliTraceTest_Feature1 という名前の新しいお知らせがあり、タスク一覧には Deactivate feature: IntelliTraceTest_Feature1 という名前の新しいタスクがあります。このいずれかがない場合は、フィーチャーがアクティブになっているかどうかを確認します。アクティブになっていない場合は、アクティブにします。
次の手順を実行して、フィーチャーを非アクティブにします。
1. SharePoint の [サイトの操作] メニューで、[サイトの設定] を選択します。
2. [サイトの操作] で、[サイトのフィーチャーの管理] リンクをクリックします。
3. [IntelliTraceTest Feature1] の横にある [非アクティブ化] をクリックします。
4. 警告ページで、[この機能を非アクティブ化] リンクをクリックします。
  
  FeatureDeactivating() イベントハンドラーによってエラーがスローされます。

Microsoft Monitoring Agent を使用して IntelliTrace データを収集する

SharePoint が実行されているシステムに Microsoft Monitoring Agent をインストールすると、IntelliTrace から返されるジェネリック情報よりも具体的なデータを使用して、SharePoint ソリューションをデバッグできます。エージェントは、PowerShell コマンドレットを使用して Visual Studio 外で動作し、SharePoint ソリューションの実行中にデバッグ情報をキャプチャします。

Note

このセクションの構成情報は、この例に固有です。その他の構成オプションの詳細については、「IntelliTrace スタンドアロンコレクターの使用」を参照してください。

SharePoint を実行しているコンピューターで、Microsoft Monitoring Agent を設定し、ソリューションの監視を開始します。
フィーチャーを非アクティブ化します。
1. SharePoint の [サイトの操作] メニューで、[サイトの設定] を選択します。
2. [サイトの操作] で、[サイトのフィーチャーの管理] リンクをクリックします。
3. [IntelliTraceTest Feature1] の横にある [非アクティブ化] をクリックします。
4. 警告ページで、[この機能を非アクティブ化] リンクをクリックします。
  
  エラーが発生します (この場合は、FeatureDeactivating() イベントハンドラーでスローされたエラーが原因)。
PowerShell ウィンドウで Stop-WebApplicationMonitoring コマンドを実行することにより、.iTrace ファイルを作成し、監視を停止して、SharePoint ソリューションを再起動します。

Stop-WebApplicationMonitoring "<SharePointSite>\<SharePointAppName>"

SharePoint ソリューションをデバッグして修正する

この時点で、Visual Studio で IntelliTrace ログファイルを表示し、SharePoint ソリューションのエラーを見つけて修正することができます。

Visual Studio で、\IntelliTraceLogs フォルダーにある .iTrace ファイルを開きます。

[IntelliTrace の概要] ページが表示されます。エラーは処理されなかったので、SharePoint の相関 ID (GUID) が [分析] セクションのハンドルされない例外領域に表示されます。エラーが発生した呼び出し履歴を表示するには、[呼び出し履歴] をクリックします。
[例外のデバッグ] ボタンをクリックします。

プロンプトが表示されたら、シンボルファイルを読み込みます。 [IntelliTrace] ウィンドウで、例外が "スロー: 重大なエラーが発生しました" というテキストで強調表示されます。

[IntelliTrace] ウィンドウで、例外を選択して失敗したコードを表示します。
SharePoint ソリューションを開き、FeatureDeactivating() プロシージャの一番上にある throw ステートメントをコメントアウトまたは削除してエラーを修正します。
Visual Studio でソリューションをリビルドし、SharePoint に再配置します。
次の手順を実行して、フィーチャーを非アクティブにします。
1. SharePoint の [サイトの操作] メニューで、[サイトの設定] を選択します。
2. [サイトの操作] で、[サイトのフィーチャーの管理] リンクをクリックします。
3. [IntelliTraceTest Feature1] の横にある [非アクティブ化] をクリックします。
4. 警告ページで、[この機能を非アクティブ化] リンクをクリックします。
タスク一覧を開き、非アクティブ化タスクの [ステータス] が [完了] で、[達成率] が [100%] であることを確認します。

コードは、適切に実行されています。

次の方法で共有

チュートリアル: IntelliTrace を使用した SharePoint アプリケーションのデバッグ

必須コンポーネント

フィーチャーレシーバーを作成する

フィーチャーレシーバーにコードを追加する

プロジェクトをテストする

Microsoft Monitoring Agent を使用して IntelliTrace データを収集する

SharePoint ソリューションをデバッグして修正する

フィードバック

その他のリソース

次の方法で共有

チュートリアル: IntelliTrace を使用した SharePoint アプリケーションのデバッグ

必須コンポーネント

フィーチャー レシーバーを作成する

フィーチャー レシーバーにコードを追加する

プロジェクトをテストする

Microsoft Monitoring Agent を使用して IntelliTrace データを収集する

SharePoint ソリューションをデバッグして修正する

関連するコンテンツ

フィードバック

その他のリソース

フィーチャーレシーバーを作成する

フィーチャーレシーバーにコードを追加する