.NET でメモリ リークをデバッグする

  • [アーティクル]

この記事の対象: ✔️ .NET Core 3.1 SDK 以降のバージョン

目的のタスクを実行するために必要がなくなったオブジェクトをアプリで参照すると、メモリがリークすることがあります。 このようなオブジェクトを参照すると、使われているメモリをガベージ コレクターが再利用できなくなります。 その結果、パフォーマンスが低下し、OutOfMemoryException 例外がスローされる可能性があります。

このチュートリアルでは、.NET 診断 CLI ツールを使って .NET アプリのメモリ リークを分析するためのツールについて説明します。 Windows を使っている場合は、Visual Studio のメモリ診断ツールを使用して、メモリ リークをデバッグできます。

このチュートリアルでは、意図的にメモリをリークするサンプル アプリを演習として使います。 また、意図せずにメモリがリークするアプリを分析することもできます。

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

  • dotnet-counters を使用してマネージド メモリの使用量を確認します。
  • ダンプ ファイルを生成します。
  • ダンプ ファイルを使用してメモリ使用量を分析します。

前提条件

このチュートリアルでは次のものを使用します。

このチュートリアルでは、サンプルのアプリとツールがインストールされ、使用できる状態であることを前提としています。

マネージド メモリ使用量を確認する

このシナリオの根本原因を突き止めるのに役立つ診断データの収集を開始する前に、メモリ リーク (メモリの増加) が実際に発生していることを確認する必要があります。 それを確認するには、dotnet-counters ツールを使用できます。

コンソール ウィンドウを開き、サンプル デバッグ ターゲットをダウンロードして解凍したディレクトリに移動します。 ターゲットを実行します。

dotnet run

別のコンソールから、プロセス ID を見つけます。

dotnet-counters ps

出力は次のようになります。

4807 DiagnosticScena /home/user/git/samples/core/diagnostics/DiagnosticScenarios/bin/Debug/netcoreapp3.0/DiagnosticScenarios

次に、dotnet-counters ツールを使用してマネージド メモリ使用量を確認します。 --refresh-interval は、更新間隔を秒数で指定します。

dotnet-counters monitor --refresh-interval 1 -p 4807

ライブ出力は次のようになります。

Press p to pause, r to resume, q to quit.
    Status: Running

[System.Runtime]
    # of Assemblies Loaded                           118
    % Time in GC (since last GC)                       0
    Allocation Rate (Bytes / sec)                 37,896
    CPU Usage (%)                                      0
    Exceptions / sec                                   0
    GC Heap Size (MB)                                  4
    Gen 0 GC / sec                                     0
    Gen 0 Size (B)                                     0
    Gen 1 GC / sec                                     0
    Gen 1 Size (B)                                     0
    Gen 2 GC / sec                                     0
    Gen 2 Size (B)                                     0
    LOH Size (B)                                       0
    Monitor Lock Contention Count / sec                0
    Number of Active Timers                            1
    ThreadPool Completed Work Items / sec             10
    ThreadPool Queue Length                            0
    ThreadPool Threads Count                           1
    Working Set (MB)                                  83

次の行に焦点を当てます。

    GC Heap Size (MB)                                  4

スタートアップの直後、マネージド ヒープ メモリは 4 MB であることがわかります。

次に、URL https://localhost:5001/api/diagscenario/memleak/20000 に移動します。

メモリ使用量が 30 MB に増加していることに注意してください。

    GC Heap Size (MB)                                 30

メモリ使用量を監視することにより、メモリが増加していること、またはリークしていることを確実に知ることができます。 次の手順では、メモリ分析に適切なデータを収集します。

メモリ ダンプを生成する

メモリ リークの可能性を分析する場合は、アプリのメモリ ヒープにアクセスしてメモリの内容を分析する必要があります。 オブジェクト間の関係を確認して、メモリが解放されない理由についての理論を作成します。 一般的な診断データのソースは、Windows 上のメモリ ダンプ、または Linux 上の同等のコア ダンプです。 .NET アプリケーションのダンプを生成するには、dotnet-dump ツールを使用できます。

前に開始したサンプル デバッグ ターゲットを使用して、次のコマンドを実行し、Linux コア ダンプを生成します。

dotnet-dump collect -p 4807

結果として、同じフォルダーにコア ダンプが生成されます。

Writing minidump with heap to ./core_20190430_185145
Complete

Note

時間の経過に伴う比較では、最初のダンプを収集した後も、元のプロセスを引き続き実行し続け、2 番目のダンプも同様に収集します。 その後、一定期間にわたって 2 つのダンプが作成され、メモリ使用量が増加している場所を確認できます。

失敗したプロセスを再起動する

ダンプが収集されると、失敗したプロセスを診断するのに十分な情報が得られます。 失敗したプロセスが運用サーバーで実行されている場合は、今が、そのプロセスを再起動して短期的な修復を行うのに最適なタイミングです。

このチュートリアルでは、サンプル デバッグ ターゲットを終了したので、閉じることができます。 サーバーを起動したターミナルに移動して、Ctrl + C を押します。

コア ダンプを分析する

コア ダンプが生成されたので、dotnet-dump ツールを使用してダンプを分析します。

dotnet-dump analyze core_20190430_185145

ここで、core_20190430_185145 は、分析するコア ダンプの名前です。

Note

libdl.so が見つからないことを示すエラーが表示された場合は、libc6-dev パッケージのインストールが必要な可能性があります。 詳しくは、Linux での .NET の前提条件に関する記事をご覧ください。

SOS コマンドを入力できるプロンプトが表示されます。 一般的に、最初に調べる必要があるのは、マネージド ヒープの全体的な状態です。

> dumpheap -stat

Statistics:
              MT    Count    TotalSize Class Name
...
00007f6c1eeefba8      576        59904 System.Reflection.RuntimeMethodInfo
00007f6c1dc021c8     1749        95696 System.SByte[]
00000000008c9db0     3847       116080      Free
00007f6c1e784a18      175       128640 System.Char[]
00007f6c1dbf5510      217       133504 System.Object[]
00007f6c1dc014c0      467       416464 System.Byte[]
00007f6c21625038        6      4063376 testwebapi.Controllers.Customer[]
00007f6c20a67498   200000      4800000 testwebapi.Controllers.Customer
00007f6c1dc00f90   206770     19494060 System.String
Total 428516 objects

ここで、ほとんどのオブジェクトが String または Customer オブジェクトであることがわかります。

メソッド テーブル (MT) を指定して dumpheap コマンドを再び使用すると、すべての String インスタンスの一覧を取得できます。

> dumpheap -mt 00007f6c1dc00f90

         Address               MT     Size
...
00007f6ad09421f8 00007faddaa50f90       94
...
00007f6ad0965b20 00007f6c1dc00f90       80
00007f6ad0965c10 00007f6c1dc00f90       80
00007f6ad0965d00 00007f6c1dc00f90       80
00007f6ad0965df0 00007f6c1dc00f90       80
00007f6ad0965ee0 00007f6c1dc00f90       80

Statistics:
              MT    Count    TotalSize Class Name
00007f6c1dc00f90   206770     19494060 System.String
Total 206770 objects

次に、System.String インスタンスで gcroot コマンドを使って、このオブジェクトがルート指定されている方法と理由を確認できます。

> gcroot 00007f6ad09421f8

Thread 3f68:
    00007F6795BB58A0 00007F6C1D7D0745 System.Diagnostics.Tracing.CounterGroup.PollForValues() [/_/src/System.Private.CoreLib/shared/System/Diagnostics/Tracing/CounterGroup.cs @ 260]
        rbx:  (interior)
            ->  00007F6BDFFFF038 System.Object[]
            ->  00007F69D0033570 testwebapi.Controllers.Processor
            ->  00007F69D0033588 testwebapi.Controllers.CustomerCache
            ->  00007F69D00335A0 System.Collections.Generic.List`1[[testwebapi.Controllers.Customer, DiagnosticScenarios]]
            ->  00007F6C000148A0 testwebapi.Controllers.Customer[]
            ->  00007F6AD0942258 testwebapi.Controllers.Customer
            ->  00007F6AD09421F8 System.String

HandleTable:
    00007F6C98BB15F8 (pinned handle)
    -> 00007F6BDFFFF038 System.Object[]
    -> 00007F69D0033570 testwebapi.Controllers.Processor
    -> 00007F69D0033588 testwebapi.Controllers.CustomerCache
    -> 00007F69D00335A0 System.Collections.Generic.List`1[[testwebapi.Controllers.Customer, DiagnosticScenarios]]
    -> 00007F6C000148A0 testwebapi.Controllers.Customer[]
    -> 00007F6AD0942258 testwebapi.Controllers.Customer
    -> 00007F6AD09421F8 System.String

Found 2 roots.

String が Customer オブジェクトによって直接保持され、CustomerCache オブジェクトによって間接的に保持されていることがわかります。

オブジェクトのダンプを続けて、ほとんどの String オブジェクトが同様のパターンに従っていることを確認できます。 この時点で、コードの根本原因を特定するのに十分な情報が調査によって提供されています。

この一般的な手順では、主要なメモリ リークの原因を特定できます。

リソースをクリーンアップする

このチュートリアルでは、サンプル Web サーバーを開始しました。 このサーバーは、「失敗したプロセスを再起動する」セクションの説明に従ってシャットダウンされている必要があります。

また、作成されたダンプ ファイルを削除することもできます。

関連項目

次のステップ

.NET Core で高 CPU 使用率をデバッグする