.NET Framework アプリケーションのトレース

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

互換性要件

サポートされている .NET フレームワークのランタイム

.NET トレーサーは、.NET Framework 4.6.1 以上のインスツルメンテーションをサポートします。

Datadog の .NET Framework ライブラリとプロセッサアーキテクチャーのサポート一覧 (レガシーバージョンとメンテナンスバージョンを含む) については、互換性要件を参照してください。

インストールと利用開始

AWS Lambda または Azure Functions などの Serverless 環境で Datadog APM を設定するには、Serverless を参照してください。
注: Datadog 自動インスツルメンテーションは、.NET CLR Profiling API に依存します。この API に許可されるサブスクライバーは 1 つのみです (たとえば Datadog APM)。可視性を最大限に向上するため、アプリケーション環境で 1 つの APM ソリューションのみを実行してください。

インストール

作業を始める前に、Agent のインストールと構成が済んでいることを確認してください。

  1. SDK をインストールします。
  2. サービスの SDK を有効にします。
  3. ライブデータを表示します。

SDK のインストール

Datadog Agent をインストールして構成した後、次の手順として、アプリケーションに SDK を直接追加し、そのアプリケーションをインスツルメントします。互換性情報の詳細を確認してください。

Datadog .NET Tracer は、マシン上のすべてのサービスがインスツルメントされるようにマシン全体にインストールするか、アプリケーションごとにインストールし、開発者はアプリケーションの依存関係を通じてインスツルメンテーションを管理することができます。マシン全体のインストール手順を見るには、Windows タブをクリックします。アプリケーションごとのインストール手順を見るには、NuGet タブをクリックします。

    .NET Tracer をマシン全体にインストールするには

    1. .NET トレーサー MSI インストーラーをダウンロードします。64 ビット Windows を使用している場合は、x64 MSI インストーラーを使用します。これにより、64 ビットおよび 32 ビットアプリケーションの両方をインスツルメントできます。32 ビット Windows を使用している場合は、x86 インストーラーのみを選択します。弊社は 32 ビットオペレーティングシステムをサポートしていないため、v3.0.0 以降は x64 インストーラーのみが提供されます。

    2. 管理者権限で .NET トレーサー MSI インストーラーを実行します。

    PowerShell で次を実行することで、MSI セットアップをスクリプト化することもできます: Start-Process -Wait msiexec -ArgumentList '/qn /i datadog-apm.msi'

    注: このインストールは、IIS で動作するアプリケーションをインスツルメントするものではありません。IIS で実行されるアプリケーションについては、Windows マシン全体のインストールプロセスに従ってください。

    .NET Tracer をアプリケーション単位でインストールするには

    1. Datadog.Trace.Bundle NuGet パッケージをアプリケーションに追加します。

    サービスの SDK を有効にする

    サービスの .NET Tracer を有効にするには、必要な環境変数を設定し、アプリケーションを再起動します。

    環境変数の設定方法の違いについては、プロセス環境変数の構成を参照してください。

      Internet Information Services (IIS)

      1. .NET トレーサー MSI インストーラーは、必要な環境変数をすべて追加します。構成する必要のある環境変数はありません。

      2. IIS でホストされるアプリケーションを自動でインスツルメントするには、管理者として次のコマンドを実行して IIS を完全に停止してから起動します。

        net stop /y was
net start w3svc
# Also, start any other services that were stopped when WAS was shut down.
        注: SDK を有効にするために、必ず上記のコマンドを使用して IIS を完全に停止してから再起動してください。IIS Manager GUI アプリケーションまたは iisreset.exeまで。

      IIS 以外のサービス

      注: .NET ランタイムは .NET ライブラリをこれらの環境変数が設定時に開始したあらゆる .NETプロセスにロードしようとします。このため、インスツルメンテーションをインスツルメントされる必要があるアプリケーションのみに制限してください。ホストのすべての .NET プロセスがインスツルメントされることになるため、これらの環境変数をグローバルに設定しないでください。

      1. 自動インスツルメンテーションをアプリケーションにアタッチするために、以下の必要な環境変数を設定します。

        COR_ENABLE_PROFILING=1

      2. スタンドアロンアプリケーションや Windows サービスの場合は、手動でアプリケーションを再起動します。

      パッケージの Readme に書かれている手順に従ってください。dd-trace-dotnet リポジトリでも公開されています。 Docker のサンプルもリポジトリで公開されています。

      ライブデータを表示

      サービスの .NET Tracer を有効にした後:

      1. サービスを再起動します。

      2. アプリケーションロードを作成します。

      3. Datadog で APM > APM Traces の順に移動します。

      構成

      必要に応じて、Unified Service Tagging の設定など、アプリケーションパフォーマンスのテレメトリデータを送信するための SDK を構成します。詳細については、ライブラリの構成を参照してください。

      カスタムインスツルメンテーション

      カスタムインスツルメンテーションは、自動インスツルメンテーションによって異なり、メソッドによっては追加の手順が含まれます。

        注: v3.0.0以降、カスタムインスツルメンテーションを使用するには、自動インスツルメンテーションも使用する必要があります。自動インスツルメンテーションとカスタムインスツルメンテーションのパッケージバージョン (例: MSI や NuGet) の同期を維持し、パッケージのメジャーバージョンを混合しないようにする必要があります。

        .NET アプリケーションでカスタムインスツルメンテーションを使用するには

        1. 自動インスツルメンテーションを使用してアプリケーションをインスツルメントします。
        2. Datadog.Trace NuGet パッケージをアプリケーションに追加します。
        3. アプリケーションコードで、Datadog.Trace.Tracer.Instance プロパティを介してグローバルトレーサーにアクセスし、新しいスパンを作成します。

        .NET アプリケーションでカスタムインスツルメンテーションを使用するには

        1. アプリケーションコードで、Datadog.Trace.Tracer.Instance プロパティを介してグローバルトレーサーにアクセスし、新しいスパンを作成します。

        カスタムインスツルメンテーションのスパンやタグの追加について詳しくは、.NET カスタムインスツルメンテーションのドキュメントを参照してください。

        プロセス環境変数の構成

        サービスに自動インスツルメンテーションをアタッチするには、アプリケーションを起動する前に、必要な環境変数を設定してください。.NET Tracer のインストール方法に応じて設定する環境変数を特定するために、サービスの SDK を有効にするのセクションを参照し、以下の例に従って、インスツルメントされたサービスの環境に基づいて環境変数を正しく設定します。

        注: .NET ランタイムは .NET ライブラリをこれらの環境変数が設定時に開始したあらゆる .NETプロセスにロードしようとします。このため、インスツルメンテーションをインスツルメントされる必要があるアプリケーションのみに制限してください。ホストのすべての .NET プロセスがインスツルメントされることになるため、これらの環境変数をグローバルに設定しないでください。

        Windows サービス

          レジストリエディターで、HKLM\System\CurrentControlSet\Services\<SERVICE NAME> キーに Environment 複数の文字列値を作成します。

          COR_ENABLE_PROFILING=1
          レジストリエディターを使用して Windows サービスの環境変数を作成する
          Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\<SERVICE NAME> -Name Environment -Value 'COR_ENABLE_PROFILING=1'

          IIS

          MSI をインストールした後、IIS サイトを自動的にインスツルメンテーションするための追加構成は必要ありません。すべての IIS サイトに継承される追加の環境変数を設定するには、次の手順を実行します。

          1. レジストリエディターを開き、HKLM\System\CurrentControlSet\Services\WAS キーにある Environment という複数文字列の値を探し、1 行に 1 つずつ環境変数を追加します。例えば、ログの挿入とランタイムメトリクスを追加するには、値データに以下の行を追加します。
            DD_LOGS_INJECTION=true
DD_RUNTIME_METRICS_ENABLED=true
          2. 以下のコマンドを実行し、IIS を再起動します。
            net stop /y was
net start w3svc
# Also, start any other services that were stopped when WAS was shut down.
          レジストリエディターを使用してすべての IIS サイトの環境変数を作成する

          コンソールアプリケーション

          コンソールアプリケーションを自動的にインスツルメントするには、アプリケーションを起動する前に、バッチファイルから環境変数を設定します。

          rem Set required environment variables
SET COR_ENABLE_PROFILING=1

rem (Optionally) Set additional Datadog environment variables, for example:
SET DD_LOGS_INJECTION=true
SET DD_RUNTIME_METRICS_ENABLED=true

rem Start application
dotnet.exe example.dll

          参考資料

          お役に立つドキュメント、リンクや記事:

          .NET アプリケーションログとトレースの接続ドキュメント more more ランタイムメトリクスドキュメント more more Microsoft Azure App Service 拡張機能ドキュメント more more サービス、リソース、トレースの調査ドキュメント more more Datadog APM と分散型トレーシングを使用した .NET のモニタリングブログ more more コンテナ化された ASP.NET コアアプリケーションを監視するブログ more more AWS Fargate でコンテナ化された ASP.NET コアアプリケーションを監視するブログ more more Datadog Continuous Profiler で .NET アプリケーションのパフォーマンスを最適化するブログ more more カスタムインスツルメンテーションの例ソースコード more more ソースコードソースコード more more