概要

Datadog Real User Monitoring (RUM) を使用すると、アプリケーションの個々のユーザーのユーザージャーニーを視覚化して分析できます。

セットアップ

Datadog does not support Desktop (Windows, Mac, or Linux), console, or web deployments from Unity. If you have a game or application and want to use Datadog RUM to monitor its performance, create a ticket with Datadog support.

インストール

1. Install External Dependency Manager for Unity (EDM4U). This can be done using Open UPM.

2. Add the Datadog SDK Unity package from its Git URL at https://github.com/DataDog/unity-package. The package URL is https://github.com/DataDog/unity-package.git.

3. Configure your project to use Gradle templates, and enable both Custom Main Template and Custom Gradle Properties Template.

4. If you build and receive Duplicate class errors (common in Unity 2022.x), add the following block in the dependencies block in your mainTemplate.gradle:

   constraints {
        implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.0") {
            because("kotlin-stdlib-jdk8 is now a part of kotlin-stdlib")
        }
   }
   

UI でアプリケーションの詳細を指定

1. In Datadog, navigate to Digital Experience > Add an Application.
2. Choose Unity as the application type.
3. アプリケーション名を入力して一意の Datadog アプリケーション ID とクライアントトークンを生成します。
4. クライアント IP またはジオロケーションデータの自動ユーザーデータ収集を無効にするには、これらの設定のチェックボックスをオフにします。

データの安全性を確保するために、クライアントトークンを使用する必要があります。クライアントトークンの設定方法については、クライアントトークンのドキュメントを参照してください。

Specify Datadog settings in the Unity UI

After installing the Datadog Unity SDK, you need to set Datadog’s settings in the Unity UI. Navigate to your Project Settings and click on the Datadog section on the left hand side. You will see the following screen:

次のパラメーターを使用できます。

RUM セッションのサンプリング

You can control the data your application sends to Datadog RUM during instrumentation of the RUM Unity SDK. Specify the Session Sample Rate as a percentage between 0 and 100 in the Project Settings window in Unity.

Datadog の使用

追跡に関する同意の設定

データ保護とプライバシーポリシーに準拠するため、Datadog Unity SDK は追跡に関する同意の値の設定を求めます。

trackingConsent 設定は以下のいずれかの値で示されます。

• TrackingConsent.Pending: Unity SDK はデータの収集とバッチ処理を開始しますが、Datadog には送信しません。Unity SDK は新しい追跡に関する同意の値を待って、バッチされたデータをどうするかを決定します。
• TrackingConsent.Granted: Unity SDK はデータの収集を開始し、Datadog へ送信します。
• TrackingConsent.NotGranted: Unity SDK はデータを収集しません。ログが Datadog に送信されることはありません。

Datadog がデータを送信する前に、ユーザーの Tracking Consent を確認する必要があります。これは初期化時に TrackingConsent.Pending に設定され、Datadog が情報を送信する前に TrackingConsent.Granted に設定される必要があります。

DatadogSdk.Instance.SetTrackingConsent(TrackingConsent.Granted);

ロギング

プロジェクトの設定でオプションとしきい値を有効にすることで、Unity のデフォルトのデバッグロガーからログを傍受して送信できます。

Datadog は、Datadog の Logging Levels で Unity レベルを以下にマップします。

DatadogSdk.DefaultLogger プロパティを通して、このデフォルトのロガーにアクセスし、属性やタグを追加することができます。

また、しきい値、サービス名、ロガー名をより細かく制御すしたり、追加属性を供給するために、追加のロガーを作成することもできます。

var logger = DatadogSdk.Instance.CreateLogger(new DatadogLoggingOptions()
{
    NetworkInfoEnabled = true,
    DatadogReportingThreshold = DdLogLevel.Debug,
});
logger.Info("Hello from Unity!");

logger.Debug("Hello with attributes", new()
{
    { "my_attribute", 122 },
    { "second_attribute", "with_value" },
    { "bool_attribute", true },
    {
        "nested_attribute", new Dictionary<string, object>()
        {
            { "internal_attribute", 1.234 },
        }
    },
});

The following parameters are available when creating a new logger:

Real User Monitoring (RUM)

シーン (ビュー) の手動追跡

新しいシーン (Datadog では Views) を手動で追跡するには、StartView と StopView メソッドを使用します。

public void Start()
{
    DatadogSdk.Instance.Rum.StartView("My View", new()
    {
        { "view_attribute": "active" }
    });
}

新しいビューを開始すると、前のビューは自動的に終了します。

シーンの自動追跡

Project Settings で Enable Automatic Scene Tracking を設定すると、アクティブなシーンを自動的に追跡できるようになります。これは Unity の SceneManager.activeSceneChanged イベントを使用して、自動的に新しいシーンを開始します。

Web リクエスト / リソース追跡

Datadog offers DatadogTrackedWebRequest, which is a UnityWebRequest wrapper intended to be a drop-in replacement for UnityWebRequest. DatadogTrackedWebRequest enables Datadog Distributed Tracing.

Datadog 分散型トレーシングを有効にするには、プロジェクトの設定で First Party Hosts を分散型トレーシングをサポートするドメインに設定する必要があります。また、Tracing Sampling Rateを設定することで、分散型トレーシングのサンプリングレートを変更することができます。

First Party Hosts ではワイルドカードは使用できませんが、指定されたドメインの任意のサブドメインとマッチします。例えば、api.example.com は staging.api.example.com と prod.api.example.com にはマッチしますが、news.example.com にはマッチしません。