VTuneアンプのタイムラインにAndroid Logcatメッセージを配置する

有名なことわざには、「1つの心が良い、2つの心が良い」とあります。 これは、日常の状況だけでなく、アプリケーションのデバッグの問題にも有効です。 さまざまなソフトウェアツールの「心」を組み合わせることで、定量的だけでなく定性的な利点も得られます。 たとえば、 Android LogcatとVTune Amplifierの 結合はまさにそのような場合です。



Android Logcatは強力なデバッグツールです。 その助けを借りて、タイムスタンプを参照して、システムまたはアプリケーションに関する多くの有用な情報を取得できます。 Androidは、データを記録するための標準APIを開発者に提供します。 これらのAPIは、アプリケーションを開発およびデバッグするときに使用すると便利です。対応するコマンドの呼び出しをプログラムコードの適切な場所に追加するだけです。 コマンドは、Logcatで表示可能なメッセージを表示します。



専用システム用のVTuneアンプは、プロファイリング用のソフトウェアパッケージです。 これにより、オペレーティングシステムとアプリケーションのパフォーマンスを分析および最適化できます。 VTuneアンプには、非常に便利なツールであるタイムラインパネルがあります。 開発者は、時間に関連するパフォーマンス情報を表示できます。



LogcatからVTune Amplifierタイムラインにメッセージをマッピングする方法は？ これにより、開発者はLogcatからのメッセージとVTune Amplifierタイムラインからのパフォーマンス情報を見ることができます。 その結果、特定の時間に何が起こったかを正確に把握し、このイベントまたはそのイベントによってシステムにどのような負荷がかかったか、それがパフォーマンスにどのように影響したかをすぐに理解できます。



Intel VTune Amplifierは、追加のパフォーマンス情報を処理し、組み込みツールを使用して取得した独自のデータセットに統合できます。 外部データコレクターを使用するか、テスト対象のアプリケーションを使用して取得できます。 VTuneアンプに外部データを追加するには、収集された情報がある特定の構造を持つCSVファイルが必要です。 このファイルは、さらに作業するために、VTuneアンプにロードする必要があります。



独自のCSVデータファイルの作成の詳細については、VTune Amplifier User Guideを参照してください。 特に、VTune Amplifier> User's Guide> External Data Importセクションには、そのようなファイルの作成方法に関する情報が含まれています。 内部構造の例もあります。 LogcatからのメッセージをVTuneタイムラインに表示するには、マニュアルに従ってメッセージをCSVファイルに変換し、結果のファイルをVTune Amplifierにロードする必要があります。

例

例を考えてみましょう。 アプリケーション「com.example.Thread1」があります。 重い計算を実行する機能があります。 一般的な用語では次のようになります。

void myfunction () { Log.v("MYTEST", "start block 1"); { ...//  1 } Log.v("MYTEST", "start block 2"); { ...//  2 } Log.v("MYTEST", "my computation finished"); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

VTune Amplifierを使用してAndroidアプリケーションをプロファイリングする前に、アプリケーションを準備する必要があることに注意してください。 つまり、AndroidManifest.xmlファイルの<application>セクションで、デバッグ機能を有効にする必要があります。

  <application android:debuggable="true" ... >
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

たとえば、標準のAndroid Studioツールを使用して、Androidデバイスにアプリケーションのデバッグバージョンをインストールできます。 そして、Android Studioアプリケーションをインストールした後、それを閉じる必要があります。そうしないと、VTune Amplifierはデータを収集できません。 LogcatメッセージのコレクションとVTune Amplifierでのプロファイリングを組み合わせるには、Logcatをコマンドラインから実行する必要があります。 Windowsで作業する人とLinuxを使用する人の両方に適した汎用ツールはbashシェルです。



Linuxシステムでは、デフォルトでbashが存在します。 ただし、ホストシステムがWindowsの場合、追加のソフトウェアが必要になります。 Cygwinをお勧めします 。 このアプリケーションを使用すると、Windowsでbash環境を使用できます。 コマンドラインからのLogcatの操作の詳細については、 こちらをご覧ください 。



デフォルトでは、たとえば、コマンド「$ adb logcat -v threadtime」でLogcatを起動すると、データが画面に表示されます。 出力を外部ファイルにリダイレクトする方がはるかに便利です。 これは、次のコマンドで実行されます。

 $ adb logcat -v threadtime > log.txt
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Logcatからの出力をlog.txtファイルにリダイレクトします。このファイルは現在のディレクトリに配置されます。

VTune Amplifierでプロファイリングを開始する前にLogcatデータの収集を開始し、その後で停止（コマンドラインでCtrl + C）する必要があります。



例に戻りましょう。 以下に示すVTuneアンプのタイムラインから判断すると、この機能は6回実行されました。 アプリケーションのメインスレッドIDは12271です。茶色の列は、VTune Amplifierを使用したプロファイリング中に収集されたパフォーマンス（CPU時間）情報です。





VTune Amplifierタイムラインでアプリケーション分析結果を表示



関数が実行されるたびに、「logcat -v threadtime」という形式のコマンドでLogcatメッセージを収集すると、以下に示すデータセットが取得されます。

 01-12 11:13:19.090 2174 2174 V MYTEST : start block 1 01-12 11:13:19.260 2174 2174 V MYTEST : start block 2 01-12 11:13:19.500 2174 2174 V MYTEST : my computation finished
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このデータを受け取ったら、VTuneアンプへのロードに適した適切な形式のCSVファイルに変換できます。 VTune Amplifierのドキュメントによると、必要なCSVファイルは次のようになります。

 name,start_tsc.UTC,end_tsc,pid,tid V/MYTEST : start block 1,2015-01-12 03:13:19.090,2015-01-12 03:13:19.090,2174,2174 V/MYTEST : start block 2,2015-01-12 03:13:19.260,2015-01-12 03:13:19.260,2174,2174 V/MYTEST:my computation finished,2015-01-12 03:13:19.500, 2015-01-12 03:13:19.500, 2174, 2174
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここでは、データ列の「名前」として、ロギング中に使用されるタグとメッセージ行が使用されます。 メッセージ時間は、start_tsc.UTCおよびend_tsc列に分類されます。 プロセスIDとストリームIDは、それぞれCSVファイルでpidとtidとして表されます。 フィールドはコンマで区切られます。



次に、VTuneアンプに移動して、[分析タイプ]> [CSVからインポート]コマンドを実行し、インポートするために作成したデータファイルを選択する必要があります。 アプリケーションはデータをダウンロードし、パフォーマンス情報とともにタイムラインにLogcatからメッセージを表示します。 次の図は、メッセージの場所を指す小さな黄色の三角形にマウスを移動すると、アプリケーションによって生成されたLogcatのデータがポップアップウィンドウに表示される様子を示しています。





VTuneアンプのタイムラインでLogcatメッセージを表示する



CSVファイルを作成するためのヒントを次に示します。

1. Logcatに表示されるタイムスタンプは、Android OSから取得されます。 これらは、デバイスに設定されているタイムゾーンに関連付けられています。 CSVファイルを作成するときは、UTC標準のタイムスタンプに変更する必要があります。 VTune Amplifierへのデータのインポートを成功させるために必要です。
   
   
   
   
2. CSVファイルの名前には、サードパーティアプリケーションを使用してデータが収集されるホスト名（ホスト名）が含まれている必要があります。 たとえば、ファイル名の構造は次のとおりです。[ユーザー定義] -hostname- <hostname-of-system> .csv。 Androidを実行しているターゲットデバイスの場合、ホスト名はファイル/ proc / sys / kernel / hostnameにあります。 ADBシェルを使用して表示できます。
   
   
   
   
3. 「名前」列にある文字列データは、開発者のニーズに応じてカスタマイズできます。 上記の例では、フリルなしで行いました。Logcatメッセージ全体が「名前」列に配置されました。 「name」列を対象とする文字列データにはコンマを含めないでください。 コンマは、行に表示されるべきではない予約済みの区切り文字です。
   
   
   
   
4. また、システムのカーネルからのメッセージをCSV形式（「dmesg」など）に変換し、VTune Amplifierにインポートして、タイムラインで表示することもできます。 この機能は、システムプログラマー、たとえばカーネルモジュールやデバイスドライバーを開発するユーザーにとって非常に便利です。 システムのカーネルからのメッセージの場合、プロセスIDとスレッドIDを0に設定する必要があります。システムメッセージ（たとえば、同じ「dmesg」からの）のカウントダウンは、システムが起動した瞬間から始まります。 メッセージ出力のUTC時間を示すように変換する必要があります。 たとえば、次の式を使用してメッセージのタイムスタンプを計算できます。「メッセージ時間」=「現在の時間」-「システムが動作を開始してからの時間」+「メッセージのタイムスタンプ」。 ここでの「現在時刻」とは、現在のシステム時刻を意味します。 ADBシェルの「date」コマンドを使用して取得できます。 「システムの開始からの時間」は、OSブートの開始から経過した時間です。 「/ proc / uptime」ファイルにあります。

ヘルパースクリプト

上記の手順を簡略化できる実験的なbashスクリプト（logcat2vtune.sh）を作成しました。 これを使用して、Logcatデータの収集とCSVファイルの作成を自動化できます。 スクリプトは、システムカーネルからのメッセージだけでなく、Logcatアプリケーションに表示されるメッセージを収集できます。 さらに、ターゲットシステムに関する情報を読み取り、ロギング結果を解析し、CSVファイルを自動的に生成します。



このスクリプトを使用するには、bash環境が必要です。 前述のように、Linuxシステムではこれは標準の作業環境であり、Windowsでは、たとえばCygwinを使用できます。

VTune Amplifierを使用してプロファイリング中にデータを含むCSVファイルを取得するには、以下を実行する必要があります。

1. コマンドラインから「adb」が使用可能かどうかを確認します。 その後、必要なキーを指定して、logcat2vtune.shスクリプトを実行します。 たとえば、次のようになります。> ./logcat2vtune.sh -c logcat -g MYTEST
   
   
   
   
2. VTune Amplifierでパフォーマンスデータ収集を実行します。 これは、アプリケーションウィンドウとコマンドラインの両方から実行できます。
   
   
   
   
3. VTune Amplifierでのデータ収集を停止します。
   
   
   
   
4. logcat2vtune.shが実行されているコマンドウィンドウの任意のボタンを押して、データ収集を停止します。 スクリプトは、収集されたログデータを読み取り、bash正規表現を使用して解析し、CSVファイルに変換します。 このファイルは、コマンドラインから作業している現在のフォルダーにあります。
   
   
   
   
5. 結果のCSVファイルをVTune Amplifierにダウンロードします。 Logcatメッセージをタイムラインで表示できるようになりました。

典型的なスクリプトの使用例を次に示します。

 $logcat2vtune.sh -c logcat -g MYTEST
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコマンドを使用すると、Logcatデータを収集し、文字列「MYTEST」を持つメッセージを選択して、CSVファイルを生成できます。 Logcatスクリプトは、次のコマンドを使用してデータを収集します。

 $adb shell logcat -v threadtime
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

「MYTEST」は、Logcatからのメッセージがフィルタリングされる行です。 Logcatは非常に長いメッセージのリストを表示できるため、開発者は通常、プロセスからのメッセージのみに関心があるため、フィルターの使用を強くお勧めします。 フィルターとして、Logcatメッセージタグ名、プロセスID、スレッドID、またはその他の文字列を使用できます。 ここでカンマを使用できます。複数の行を指定できます。 「-g」スイッチを使用してスクリプトを実行するときに指定された任意の行と一致するメッセージが選択され、CSVファイルとして整理されます。

 $logcat2vtune.sh -c dmesg -g MYDRIVER
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコマンドを使用すると、「dmesg」からメッセージを収集し、「MYDRIVER」行でフィルタリングしてCSVファイルを作成できます。

 $logcat2vtune.sh -c logcatk -g MYTEST,MYDRIVER
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコマンドを使用すると、Logcatからの通常のメッセージとカーネルからのメッセージの両方を収集し、「MYTEST」または「MYDRIVER」の行でフィルタリングしてCSVファイルを作成できます。 その結果、VTuneアンプのタイムラインでは、通常のユーザーレベルのアプリケーションからのメッセージと「dmesg」からのカーネルメッセージを表示できます。 スクリプトは、次のコマンドを使用してこのデータを収集します。

 >adb shell logcat -v threadtime -f /dev/kmsg | adb shell cat /proc/kmsg
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この場合、タイムライン上でTID 0のvmlinuxからのメッセージとTID 1922のLogcatからのユーザーレベルのログを表示できます。





VTune Amplifierタイムライン上のさまざまなストリームから受信したLogcatメッセージを表示する



スクリプトの操作の詳細については、「logcat2vtune.sh –h」コマンドを使用してください。



必要に応じて、独自のニーズに合わせてスクリプトをカスタマイズできます。 「logcat2vtune.sh」は実験的なプロジェクトであり、包括的なテストに合格していないことに注意してください。 彼と仕事をしているときに何か問題に遭遇したら、それについて教えてください。

結論

ここで説明した内容は、Intel System Studio 2015およびIntel System Studio 2016製品に適用され、Windows（IA-32、Intel 64）およびLinux（IA32、Intel 64）ホストシステムでの動作について説明しています。 Android OSはターゲットシステムと見なされます。



上記のツールと手法を使用して、Android Logcatの情報とVTune Amplifierのパフォーマンスデータを組み合わせることで、Androidアプリケーションのプロファイリングとデバッグをより高いレベルに進めることができます。 これにより、アプリケーションが生産性と費用対効果の新たな高みを征服するのに役立つことを願っています。