dotnet-カウンターdotnet-counters

この記事の対象: ✔️ .NET Core 3.0 SDK 以降のバージョンThis article applies to: ✔️ .NET Core 3.0 SDK and later versions

dotnet-counters のインストールInstall dotnet-counters

dotnet-counters NuGet パッケージの最新のリリース バージョンをインストールするには、次のように dotnet tool install コマンドを使用します。To install the latest release version of the dotnet-counters NuGet package, use the dotnet tool install command:

dotnet tool install --global dotnet-counters

構文Synopsis

dotnet-counters [-h|--help] [--version] <command>

説明Description

dotnet-counters は、アドホックな正常性監視と第 1 レベルのパフォーマンス調査のためのパフォーマンス監視ツールです。dotnet-counters is a performance monitoring tool for ad-hoc health monitoring and first-level performance investigation. EventCounter API を使用して公開されたパフォーマンス カウンターの値を監視できます。It can observe performance counter values that are published via the EventCounter API. たとえば、CPU 使用率や .NET Core アプリケーションでスローされる例外の発生率などを迅速に監視して、PerfView または dotnet-trace を使用した、より重大なパフォーマンス調査を開始する前に疑わしいものがあるかどうかを確認できます。For example, you can quickly monitor things like the CPU usage or the rate of exceptions being thrown in your .NET Core application to see if there's anything suspicious before diving into more serious performance investigation using PerfView or dotnet-trace.

オプションOptions

  • --version

    dotnet-counters ユーティリティのバージョンを表示します。Displays the version of the dotnet-counters utility.

  • -h|--help

    コマンド ライン ヘルプを表示します。Shows command-line help.

コマンドCommands

コマンドCommand
dotnet-counters collectdotnet-counters collect
dotnet-counters listdotnet-counters list
dotnet-counters monitordotnet-counters monitor
dotnet-counters psdotnet-counters ps

dotnet-counters collectdotnet-counters collect

選択されたカウンター値を定期的に収集し、後処理用に指定されたファイル形式にエクスポートします。Periodically collect selected counter values and export them into a specified file format for post-processing.

構文Synopsis

dotnet-counters collect [-h|--help] [-p|--process-id] [--refreshInterval] [counter_list] [--format] [-o|--output]

オプションOptions

  • -p|--process-id <PID>

    監視するプロセスの ID。The ID of the process to be monitored.

  • --refresh-interval <SECONDS>

    表示されているカウンターを更新するまでの遅延時間 (秒数)The number of seconds to delay between updating the displayed counters

  • counter_list <COUNTERS>

    カウンターのスペース区切りリスト。A space separated list of counters. カウンターは provider_name[:counter_name] で指定できます。Counters can be specified provider_name[:counter_name]. counter_name を修飾せずに provider_name を使用すると、すべてのカウンターが表示されます。If the provider_name is used without a qualifying counter_name, then all counters are shown. プロバイダーとカウンターの名前を検出するには、dotnet-counters list コマンドを使用します。To discover provider and counter names, use the dotnet-counters list command.

  • --format <csv|json>

    エクスポートされる形式。TThe format to be exported. 現在使用可能: csv、json。Currently available: csv, json.

  • -o|--output <output>

    出力ファイルの名前。The name of the output file.

使用例Examples

  • すべてのカウンターを更新間隔 3 秒で収集し、csv を出力として生成します。Collect all counters at a refresh interval of 3 seconds and generate a csv as output:

    > dotnet-counters collect --process-id 1902 --refresh-interval 3 --format csv
    
    counter_list is unspecified. Monitoring all counters by default.
    Starting a counter session. Press Q to quit.
    

dotnet-counters listdotnet-counters list

カウンターの名前と説明の一覧をプロバイダー別にグループ化して表示します。Displays a list of counter names and descriptions, grouped by provider.

構文Synopsis

dotnet-counters list [-h|--help]

Example

> dotnet-counters list

    Showing well-known counters only. Specific processes may support additional counters.
    System.Runtime
        cpu-usage                    Amount of time the process has utilized the CPU (ms)
        working-set                  Amount of working set used by the process (MB)
        gc-heap-size                 Total heap size reported by the GC (MB)
        gen-0-gc-count               Number of Gen 0 GCs / sec
        gen-1-gc-count               Number of Gen 1 GCs / sec
        gen-2-gc-count               Number of Gen 2 GCs / sec
        exception-count              Number of Exceptions / sec

dotnet-counters monitordotnet-counters monitor

選択したカウンターの定期的に更新される値を表示します。Displays periodically refreshing values of selected counters.

構文Synopsis

dotnet-counters monitor [-h|--help] [-p|--process-id] [--refreshInterval] [counter_list]

オプションOptions

  • -p|--process-id <PID>

    監視するプロセスの ID。The ID of the process to be monitored.

  • --refresh-interval <SECONDS>

    表示されているカウンターを更新するまでの遅延時間 (秒数)The number of seconds to delay between updating the displayed counters

  • counter_list <COUNTERS>

    カウンターのスペース区切りリスト。A space separated list of counters. カウンターは provider_name[:counter_name] で指定できます。Counters can be specified provider_name[:counter_name]. counter_name を修飾せずに provider_name を使用すると、すべてのカウンターが表示されます。If the provider_name is used without a qualifying counter_name, then all counters are shown. プロバイダーとカウンターの名前を検出するには、dotnet-counters list コマンドを使用します。To discover provider and counter names, use the dotnet-counters list command.

使用例Examples

  • 3 秒の更新間隔で System.Runtime のすべてのカウンターを監視します。Monitor all counters from System.Runtime at a refresh interval of 3 seconds:

    > dotnet-counters monitor --process-id 1902  --refresh-interval 3 System.Runtime
    
    Press p to pause, r to resume, q to quit.
      System.Runtime:
        CPU Usage (%)                                 24
        Working Set (MB)                            1982
        GC Heap Size (MB)                            811
        Gen 0 GC / second                             20
        Gen 1 GC / second                              4
        Gen 2 GC / second                              1
        Number of Exceptions / sec                     4
    
  • System.Runtime から CPU 使用率と GC ヒープ サイズのみを監視します。Monitor just CPU usage and GC heap size from System.Runtime:

    > dotnet-counters monitor --process-id 1902 System.Runtime[cpu-usage,gc-heap-size]
    
    Press p to pause, r to resume, q to quit.
      System.Runtime:
        CPU Usage (%)                                 24
        GC Heap Size (MB)                            811
    
  • ユーザー定義の EventSourceEventCounter 値を監視します。Monitor EventCounter values from user-defined EventSource. 詳しくは、「チュートリアル: How to measure performance for very frequent events using EventCounters」を参照してください。For more information, see Tutorial: How to measure performance for very frequent events using EventCounters.

    > dotnet-counters monitor --process-id 1902 Samples-EventCounterDemos-Minimal
    
    Press p to pause, r to resume, q to quit.
        request                                      100
    

dotnet-counters psdotnet-counters ps

監視できる dotnet プロセスの一覧を表示します。Display a list of dotnet processes that can be monitored.

構文Synopsis

dotnet-counters ps [-h|--help]

Example

> dotnet-counters ps
  
  15683 WebApi     /home/suwhang/repos/WebApi/WebApi
  16324 dotnet     /usr/local/share/dotnet/dotnet