ネットワークリクエストの自動インストルメンテーションのカスタマイズ

自動ネットワーク リクエスト インストルメンテーションが有効になっている場合、ウィーバはプロジェクトで HttpClient または Refit 使用のすべての新しいインスタンスを検索します。見つかったインスタンスで、エージェント インストルメンテーション コードが HttpClient または Refit リクエストに挿入されます。

プロジェクトレベルまたはクラスレベルで自動インストルメンテーションをさらにカスタマイズできます（以下のセクションを参照してください）。たとえば、次のようにすることができます。

1. FodyWeavers.xml ファイルからプロジェクトレベルで自動インストゥルメンテーションを有効にして、DisableNetworkInstrumentation 属性を使用してクラスレベルで一部のファイルを除外する。

2. FodyWeavers.xmlEnableNetworkInstrumentationファイルからプロジェクトレベルで自動インストゥルメンテーションを無効にして、属性を使用してクラスレベルで一部のファイルを含める。

プロジェクトレベルでの有効化/無効化

FodyWeavers.xml ファイル内の NetworkInstrumentationEnabled フラグを使用して、プロジェクトレベルで自動インストゥルメンテーションを有効または無効にすることができます。

例：

<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
... Existing weavers ...
<AppDynamics.Agent.AutoInstrument NetworkInstrumentationEnabled="true"/>
</Weavers>

クラスレベルでの有効化/無効化

クラスごとに次の属性のいずれかを使用して、クラスレベルで自動インストルメンテーションを有効または無効にすることができます。

1. [EnableNetworkInstrumentation]

   [EnableNetworkInstrumentation]
   public class MyClass
   {
   ...
   }

2. [DisableNetworkInstrumentation]

   [DisableNetworkInstrumentation]
   public class MyClass
   {
   ...
   }

推奨事項

• 手動のネットワーク リクエスト トラッキングを使用している場合は、同じネットワークリクエストに対して重複したエントリが表示されます。手動 HTTP トラッキングこれを回避するには、手動インストルメンテーションを削除するか、そのクラスで 属性を使用します。

• HTTP リクエストが別のプロジェクトで処理される場合は、インストゥルメンテーションを機能させるために、AppDynamics.Agent と AppDynamics.Agent.AutoInstrument.Fody の両方をそのプロジェクトにも追加する必要があります。
• 別のライブラリで生成された HttpClient インスタンスを使用している場合は、インストゥルメンテーションを機能させるために必要なことは、同じプロジェクト内でインスタンスを作成して使用することのみです。自動インストルメンテーションは、プロジェクト内の新しいHttpClient インスタンスを対象とすることで機能します。

自動ページ トラッキング インストルメンテーションのカスタマイズ

自動ページ トラッキング インストゥルメンテーションが有効になっている場合、ウィーバはプロジェクト内のすべての Xamarin.Forms Page のインスタンスを検索し、インストゥルメンテーション コードを挿入します。

プロジェクトレベルでの有効化/無効化

FodyWeavers.xml ファイル内の PageTrackingInstrumentationEnabled フラグを使用して、プロジェクトレベルで自動ページ トラッキング インストゥルメンテーションを有効または無効にすることができます。

<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
... Existing weavers ...
<AppDynamics.Agent.AutoInstrument PageTrackingInstrumentationEnabled="true"/>
</Weavers>

クラスレベルでの有効化/無効化

クラスごとに次の属性のいずれかを使用して、クラスレベルで自動インストルメンテーションを有効または無効にすることができます。

1. [EnablePageTracking]

   [EnablePageTracking]
   public class MyPage : Xamarin.Forms.ContentPage
   {
   ...
   }

2. [DisableUITRacking]

   [DisablePageTracking]
   public class MyPage : Xamarin.Forms.ContentPage
   {
   ...
   }

自動 UI トラッキング インストルメンテーション

自動 UI トラッキング インストゥルメンテーションが有効になっている場合、ウィーバはプロジェクト内のすべての Xamarin.Forms Button、Entry および ListView のインスタンスを検索し、インストゥルメンテーション コードを挿入します。

プロジェクトレベルでの有効化/無効化

FodyWeavers.xml ファイル内の UITrackingInstrumentationEnabled フラグを使用して、プロジェクトレベルで自動インストゥルメンテーションを有効または無効にすることができます。

例：

<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
... Existing weavers ...
<AppDynamics.Agent.AutoInstrument UITrackingInstrumentationEnabled="true"/>
</Weavers>

クラスレベルでの有効化/無効化

クラスごとに次の属性のいずれかを使用して、クラスレベルで自動インストルメンテーションを有効または無効にすることができます。

1. [EnableUITracking]

   [EnableUITracking]
   public class MyPage : Xamarin.Forms.ContentPage
   {
   ...
   }

2. [DisableUITRacking]

   [DisableUITracking]
   public class MyPage : Xamarin.Forms.ContentPage
   {
   ...
   }

自動 UI トラッキングと XAML

自動 UI トラッキングは、XAML と分離コード UI 要素の両方で機能します。ただし、分離コード UI は自動的にインストゥルメント化されますが、XAML を自動インストゥルメント化するには追加の手順が必要です。.csproj ファイルに次の設定を追加します。

<PropertyGroup>
<FodyDependsOnTargets>
XamlC
</FodyDependsOnTargets>
</PropertyGroup>

自動 UI トラッキングは、事前にコンパイルされた XAML でのみ機能するため、XamlCompilationOptions.Compile を使用する必要があります。

[XamlCompilation(XamlCompilationOptions.Compile)]

デフォルトでは、Visual Studio Xamarin.Forms テンプレートを使用して作成されたプロジェクトには、これがすでに含まれています。詳細については、「XAML Compilation in Xamarin.Forms」を参照してください。

半自動 HTTP トラッキング

HttpMessageHandler は、すべてのトラッキングとエラー処理を処理します。ロギングなどの他の目的ですでにカスタム HttpMessageHandler を使用している場合は、他の内部ハンドラを含めることもできます。

半自動トラッキングを追加するには、HttpClient をインスタンス化し、HttpRequestTrackerHandler を渡します。

var client = new HttpClient(new HttpRequestTrackerHandler());

その後、クライアントを使用して送信されたすべてのリクエストがインストルメント化されます。

response = await client.GetAsync(uri);

var loggingHandler = new MyLoggingHandler();
var client = new HttpClient(new HttpRequestTrackerHandler(loggingHandler));

手動 HTTP トラッキング

AppDynamics.Agent.HttpRequestTracker クラスを使用してネットワークリクエストを手動で報告できます。

次の例では、System.Net.Http.HttpClient クラスで HttpRequestTracker を使用しています。tracker オブジェクトは、ネットワークリクエストおよびネットワークエラーを同期的にキャプチャして報告します。

using AppDynamics.Agent;
...
public async Task<string> Fetch(Uri uri) {
var client = new HttpClient();
// Create AppDynamics Tracker
var tracker = HttpRequestTracker.Create(uri);
// Add AppDynamics Server Correlation Headers
foreach (var header in ServerCorrelationHeaders.Generate) {
// Each header could have multiple values
foreach (var value in header.Value) {
client.DefaultRequestHeaders.Add(header.Key, value);
}
}
HttpResponseMessage response = null;
try {
response = await client.GetAsync(uri);
} catch (Exception ex) {
// Capture any network errors.
tracker.Exception = ex;
tracker.ReportDone();
throw ex; //you decide to throw it or not
}
if (!response.Equals(null)) {
// Capture request information such as the
// status code, status message, and headers.
tracker.ResponseCode = (int)response.StatusCode;
tracker.StatusLine = response.ReasonPhrase;
tracker.ResponseHeaderFields = response.Headers;
tracker.ReportDone();
return await response.Content.ReadAsStringAsync();
}
return null;
}

ネットワークリクエストへのカスタム ユーザー データ プロパティの追加

HttpRequestTracker にユーザーデータを追加することで、特定のネットワークリクエストに HttpRequestTracker カスタム ユーザー データ プロパティを追加できます。

public HttpRequestTracker withUserData(String key, String value)
public HttpRequestTracker withUserLong(String key, Long value)
public HttpRequestTracker withUserBoolean(String key, Boolean value)
public HttpRequestTracker withUserDouble(String key, Double value)
public HttpRequestTracker withUserDate(String key, Date value)

例

public byte[] sendRequest(URL url) throws HttpException {
HttpRequestTracker tracker = Instrumentation.beginHttpRequest(url);
try {
// implementation omitted
tracker.withResponseCode(theResponseCode)
.withResponseHeaderFields(theResponseHeaderFields)
.withUserData("key", "value")
.withUserLong("number", 100)
.withUserBoolean("boolean", true)
.withUserDouble("double", 1.1234)
.withUserDate("date", 1609488000)
.reportDone();
return responseBody;
} catch (UnderlyingException e) {
tracker.withException(e)
.reportDone();
throw new HttpException(e);
}
}

shutdownAgent

shutdownAgentコールはコレクタへの発信データを停止し、デバイスにデータを保持しません。

using AppDynamics.Agent;
...
Instrumentation.shutdownAgent();

• このコールは、エージェントからのトラフィックのみを停止します。
• エージェントが初期化されると、コールは削除できず、ライセンスが消費されます。
• この状態をデバイスで永続的にする場合は、UserDefaults にコードを追加して状態を保存し、そのフラグを使用してコード内のエージェントを条件付きで初期化します。

restartAgent

エージェントを再度有効にして shutdownAgent を無効にする場合は、restartAgent を使用します。

using AppDynamics.Agent;
...
Instrumentation.restartAgent();

• このコールは、同様にリモートでエージェントをシャットダウンできるサーバ側のコールにも対応します。
• コールは、アプリケーションの実行中にのみ有効です。
• エージェントがリモートで無効になっている場合、コールは無視されます。
• コールがメモリから削除され、アプリケーションが再起動されるか、デバイスが再起動されると、エージェントは通常どおり初期化されます。

使用例

次に、ISessionFrame API の一般的な使用例を示します。

• 1 つの画面で複数の関数を実行し、個々の関数をより詳細に追跡する必要があります。
• ユーザフローは、複数の画面またはユーザのインタラクションに及びます。たとえば、API を使用してセッションフレーム「Login」、「Product Selection」、および「Purchase」を作成して、ユーザが購入のためにフローを記録することができます。
• ユーザの操作に基づいて動的情報をキャプチャし、オーダー ID などのセッションフレームに名前を付けることができます。

ISessionFrame API

次の表に、セッションフレームで使用できる 2 つのメソッドと 1 つのプロパティを示します。つまり、StartSessionFrame を使用してセッションフレームを開始してから、返された ISessionFrame オブジェクトを使用してセッションフレームの名前を変更し、終了します。

static ISessionFrame StartSessionFrame(string sessionFrameName)

string Name

static void End()

セッションフレームの例

次の例では、ISessionFrame API を使用し 、チェックアウトプロセス中のユーザアクティビティを追跡します。

using AppDynamics.Agent;
...
namespace ShoppingApp {
public partial class ShoppingCart : ContentPage {
private ISessionFrame sessionFrame;
private string orderId;
...
void checkoutCartButtonClicked(object sender, EventArgs e) {
// The checkout starts when the user clicks the checkout button.
// This may be after they have updated quantities of items in their cart, etc.
sessionFrame = Instrumentation.StartSessionFrame("Checkout");
}
void confirmOrderButtonClicked(object sender, EventArgs e) {
// Once they have confirmed payment info and shipping information, and they
// are clicking the "Confirm" button to start the backend process of checking out,
// we may know more information about the order itself, such as an order ID.
sessionFrame.Name = $"Checkout: Order ID {this.orderId}";
}
void processOrderCompleted(object sender, EventArgs e) {
// Once the order is processed, the user is done "checking out" so we end
// the session frame.
sessionFrame.End();
}
void checkoutCancelled(object sender, EventArgs e) {
// If they cancel or go back, you'll want to end the session frame also, or else
// it will be left open and appear to have never ended.
sessionFrame.End();
}
}
}

例

var config = AppDynamics.Agent.AgentConfiguration.Create("<#Your App Key#>");
config.JsAgentEnabled = true;
config.JsAgentAjaxEnabled = false;
AppDynamics.Agent.Instrumentation.InitWithConfiguration(config);

注

WebView は、Xamarin iOS では自動的にインストゥルメント化されます。Xamarin Android で WebView インストルメンテーションを使用するには、次のオプションを使用します。

1. InstrumentedWebView：AppDynamics.Agent.Forms.InstrumentedWebView を使用します。
2. Xamarin.Forms.WebView またはカスタム WebView 用にレンダラをグローバルにエクスポートします。

[assembly: ExportRenderer(typeof(WebView), typeof(AppDynamics.Droid.InstrumentedWebViewRenderer))]

Android プロジェクトの MainActivity の上でこれを行うことができます。

[assembly: ExportRenderer(typeof(WebView), typeof(AppDynamics.Droid.InstrumentedWebViewRenderer))]
namespace MyProject.Droid
{
public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity
{
...
}
}

例

class MyFragment : Fragment
{
public override View OnCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
{
...
}
public override void OnStart()
{
base.OnStart();
Instrumentation.TrackFragmentStart(this);
}
public override void OnStop()
{
base.OnStop();
Instrumentation.TrackFragmentEnd(this);
}
}

例

public partial class MyViewController : UIViewController
{
...
public override void ViewDidAppear(bool animated)
{
base.ViewDidAppear(animated);
Instrumentation.TrackViewControllerDidAppear(this);
}
public override void ViewDidDisappear(bool animated)
{
base.ViewDidDisappear(animated);
Instrumentation.TrackViewControllerDidDisappear(this);
}
}

ページトラッキング

Xamarin.Forms を使用すると、ページの使用状況をトラッキングし、セッションタイムラインでユーザがアプリケーションをどのように操作しているかを確認できます。

ページをトラッキングするには、モニタする各ページのコンストラクタから TrackPage を呼び出す必要があります。

public partial class MyPage : ContentPage
{
public MyPage()
{
InitializeComponent();
AppDynamics.Agent.Forms.PageTracker.TrackPage(this);
}
}

UI 要素のトラッキング

次の UI 要素とのユーザインタラクションをトラッキングできます。

• ボタン
• エントリ（Entries）
• リストビュー

UI 要素をインストゥルメント化するには、次の手順を実行します。

1. ビューにプロパティをアタッチします。

   appd:UiInstrumentation.IsInstrumented="True"

2. 名前空間を追加します。

   xmlns:appd="clr-namespace:AppDynamics.Agent.Forms;assembly=AppDynamics.Agent.Forms"

例

インストゥルメント化された UI 要素を含む xaml ファイルの例：

<ContentPage
xmlns:appd="clr-namespace:AppDynamics.Agent.Forms;assembly=AppDynamics.Agent.Forms" >
<StackLayout>
<Button appd:UiInstrumentation.IsInstrumented="True" Clicked="OnButtonClicked" />
<Entry
appd:UiInstrumentation.IsInstrumented="True" />
<ListView
appd:UiInstrumentation.IsInstrumented="True">
<ListView.ItemsSource>
<x:Array Type="{x:Type x:String}">
<x:String>Item l</x:String>
<x:String>Item 2</x:String>
</x:Array>
</ListView.ItemsSource>
</ListView>
</StackLayout>
</ContentPage>

また、コードビハインド（xaml.cs ファイル）からプロパティをインストゥルメント化することもできます。

using AppDynamics.Agent.Forms;
...
var button = new Button();
button.SetValue(UiInstrumentation.IsInstrumentedProperty, true);

IsInstrumented プロパティは、次のイベントをトラッキングします。

1. ボタン：ボタンがクリックされる
2. リストビュー：項目が選択される
3. エントリ：エントリがフォーカス/フォーカス解除される