メトリクスダッシュボードを使用したメトリクスデータの収集と確認

メモ

メトリクスダッシュボードをモデルのサイズ、アーキテクチャ、複雑度の解析にのみ現在使用している場合は、代わりにモデル保守性ダッシュボードを使用できます。詳細については、Migrating from Metrics Dashboard to Model Maintainability Dashboardを参照してください。

メトリクスダッシュボードでは、複数のモデルベースデザインツールから品質メトリクスデータを収集して統合し、プロジェクトの品質ステータスを評価できます。ダッシュボードを開くには、次の手順を実行します。

アプリギャラリーで [メトリクスダッシュボード] をクリックします。
コマンドラインに metricsdashboard(system) と入力します。system は、モデル名、またはサブシステムへのブロックパスです。システムを Configurable Subsystem ブロックにすることはできません。

メトリクスデータは、ダッシュボードを使用するか、slmetric.Engine API を使用してプログラムによって収集できます。特定のモデルのメトリクスデータを以前に収集したことがある場合は、ダッシュボードを開いたときに、データベース内の既存のデータが取り込まれます。

ダッシュボードを使用してメトリクスデータを収集 (または再収集) する場合は、ツールバーで以下を行います。

[オプション] メニューを使用して、モデル参照およびモデルライブラリをデータ収集に含めるかどうかを指定します。
[すべてのメトリクス] をクリックします。モデルのコンパイルが必要なメトリクスを収集しない場合は、[コンパイルなしのメトリクス] をクリックします。

メトリクスダッシュボードには、システム名とデータ収集のタイムスタンプが表示されます。データ収集時に問題があった場合は、警告アイコンをクリックして警告を確認します。

モデルまたはサブシステムごとに、一度に 1 つのダッシュボードのみ開くことができます。また、あるモデルまたはサブシステムのダッシュボードが開いているときに、そのモデルまたはサブシステムのメトリクスデータをプログラムにより収集すると、ダッシュボードは自動的に閉じます。

Metrics Dashboard for the model sf_car

メトリクスダッシュボードのウィジェット

メトリクスダッシュボードにはウィジェットが含まれており、サイズ、モデリングガイドラインの準拠、アーキテクチャの各カテゴリのメトリクスデータが可視化されます。データを詳細に確認するには、個々のメトリクスウィジェットをクリックします。選択したメトリクスに関して、モデルのコンポーネントレベルの値、集計値および測定値 (該当する場合) がテーブルに表示されます。ダッシュボードのこのテーブルから、データソースへのトレーサビリティとハイパーリンクを使用して、詳細な結果および問題のトラブルシューティングに推奨されるアクションを確認できます。詳細データを確認する場合は、次の点に注意してください。

メトリクスダッシュボードはメトリクスデータをコンポーネントごとに計算します。コンポーネントは、モデル、サブシステム、チャート、または MATLAB Function ブロックです。
[テーブル] ビューまたは [ツリー] ビューで結果を表示できます。[高信頼性] および [MAB] 準拠ウィジェットの場合は、[グリッド] ビューを選択することもできます。強調表示された結果を表示するには、グリッドビューでセルをクリックします。
値または集計値を基準として結果を並べ替えるには、対応する値の列ヘッダーをクリックします。
[高信頼性] および [MAB] 準拠ウィジェット以外のメトリクスに関して、結果をフィルターできます。結果をフィルターするには、[テーブル] ビューで、[タイプ]、[コンポーネント]、[パス] の列ヘッダーの右側でコンテキストメニューを選択します。[タイプ] メニューから、該当するコンポーネントを選択します。[コンポーネント] メニューと [パス] メニューから、コンポーネント名またはパスを検索バーに入力します。メトリクスダッシュボードにウィジェットのフィルターが保存されるため、他のウィジェットのメトリクスの詳細を表示しても、フィルターされた結果に戻ることができます。
[テーブル] ビューと [ツリー] ビューでは、値または集計値が n/a の場合、そのコンポーネントについての結果が使用できないことを示します。値または集計値が n/a の場合、[テーブル] ビューにはコンポーネントがリストされません。[ツリー] ビューには、そのようなコンポーネントがリストされます。
収集されるメトリクスデータは、同じモデルのインスタンスも含めて、システム全体を定量化します。集計値の場合、メトリクスエンジンによって、参照階層のモデルの各インスタンスからデータが集計されます。たとえば、システム階層で同じモデルが 2 回参照される場合、そのブロック数は、全体的なシステムブロック数に 2 回寄与します。
サブシステム、チャートまたは MATLAB Function ブロックがパラメーターを使用する場合や、問題を示すフラグが付けられている場合は、親コンポーネントのパラメーター数または問題数が増加します。
メトリクスダッシュボードはバリアントを解析します。

カスタムメトリクスの場合、ダッシュボードに追加するウィジェットを指定できます。ウィジェットを削除することもできます。メトリクスダッシュボードのカスタマイズの詳細については、メトリクスダッシュボードのレイアウトおよび機能のカスタマイズを参照してください。

サイズ

次の表は、システムのサイズの全体像を提供するメトリクスダッシュボードのウィジェットのリストです。ウィジェットで詳細を調べると、この表には利用可能な詳細情報も表示されます。

ウィジェット	メトリクス	詳細データ
ブロック	Simulink ブロックの個数 (`mathworks.metrics.SimulinkBlockCount`)	コンポーネントごとのブロック数
モデル	モデルファイル数 (`mathworks.metrics.ModelFileCount`)	コンポーネントごとのモデルファイル数
ファイル	ファイル数 (`mathworks.metrics.FileCount`)	コンポーネントごとのモデルファイルおよびライブラリファイル数
MATLAB LOC	MATLAB コードの有効行数 (`mathworks.metrics.MatlabLOCCount`)	コンポーネントごとの、Stateflow の MATLAB Function ブロック関数および MATLAB 関数の有効行数
Stateflow LOC	Stateflow ブロックのコードの有効行数 (`mathworks.metrics.StateflowLOCCount`)	コンポーネントごとの Stateflow ブロックのコードの有効行数
システムインターフェイス	入出力数 (`mathworks.metrics.ExplicitIOCount`) パラメーター数 (`mathworks.metrics.ParameterCount`)	コンポーネントごとの入出力数 (トリガー端子を含む) コンポーネントごとのパラメーター数

モデリングガイドラインの準拠

この特定のシステムでは、モデルの準拠性に関するウィジェットが、業界標準およびガイドラインへの準拠のレベルを示します。次の表は、モデリングガイドラインの準拠に関連するメトリクスダッシュボードのウィジェットと、ウィジェットで詳細を調べたときに確認できる詳細情報のリストです。

ウィジェット	メトリクス	詳細データ
[高信頼性] 準拠	モデルアドバイザー標準チェックの準拠 - 高信頼性 (`mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178`)	コンポーネントごとの: パスしたチェックの割合各チェックのステータスモデルアドバイザーとの統合による詳細な結果。
[MAB] 準拠	モデルアドバイザー標準チェックの準拠 - MAB (`mathworks.metrics.ModelAdvisorCheckCompliance.maab`)	コンポーネントごとの: パスしたチェックの割合各チェックのステータスモデルアドバイザーとの統合による詳細な結果。
[高信頼性] チェックの問題	モデルアドバイザー標準の問題 - 高信頼性 (`mathworks.metrics.ModelAdvisorCheckIssues.hisl_do178`)	コンポーネントごとの準拠チェック問題の数 (以下のメモを参照)。問題のないコンポーネントや集約された問題はリストされません。
[MAB] チェックの問題	モデルアドバイザー標準の問題 - MAB (`mathworks.metrics.ModelAdvisorCheckIssues.maab`)	コンポーネントごとの準拠チェック問題の数 (以下のメモを参照)。問題のないコンポーネントや集約された問題はリストされません。
コードアナライザーの警告	MATLAB コードアナライザーからの警告 (`mathworks.metrics.MatlabCodeAnalyzerWarnings`)	コンポーネントごとのコードアナライザーの警告数
診断の警告	Simulink 診断警告数 (`mathworks.metrics.DiagnosticWarningsCount`)	コンポーネントごとの Simulink 診断の警告数。警告がある場合、診断ビューアーを開くハイパーリンクがダッシュボードの上部に表示されます。

メモ

コンフィギュレーションパラメーターを解析する準拠チェックの問題は、チェックに失敗したモデルの問題数に加算されます。

メトリクスダッシュボードを使用して、モデルアドバイザーの独自のチェックグループに対して準拠性および問題がないかのチェックを行うことができます。詳細については、メトリクスダッシュボードのレイアウトおよび機能のカスタマイズを参照してください。

アーキテクチャ

以下のウィジェットには、システムアーキテクチャが表示されます。

[可能な再利用]/[実際の再利用] ウィジェットには、クローンであるサブコンポーネントの合計数の割合と、ライブラリブロックにリンクされているコンポーネントの合計数の割合が表示されます。オレンジは再利用の可能性があることを示します。青は実際の再利用を示します。
その他のシステムアーキテクチャウィジェットでは値を尺度として使用します。メトリクスの値範囲ごとに、色分けされたバーが、該当する範囲に含まれるコンポーネントの数を示します。色が濃いほど、コンポーネントの数が多いことを示します。

次の表は、アーキテクチャに関連するメトリクスダッシュボードのウィジェットと、ウィジェットを選択したときに確認できる詳細情報のリストです。

ウィジェット	メトリクス	詳細データ
可能な再利用/実際の再利用	[可能な再利用] (`mathworks.metrics.CloneContent`) および [実際の再利用] (`mathworks.metrics.LibraryContent`)	クローンであるサブコンポーネントの合計数のパーセンテージで表された割合リンクされているライブラリブロックであるコンポーネントの合計数のパーセンテージで表された割合 [変換ツールを開く] ボタンをクリックして、モデリングクローンの特定ツールに統合します。
モデルの複雑度	循環的複雑度 (`mathworks.metrics.CyclomaticComplexity`)	コンポーネントごとのモデルの複雑度
ブロック	Simulink ブロックの個数 (`mathworks.metrics.SimulinkBlockCount`)	コンポーネントごとのブロック数
Stateflow LOC	Stateflow ブロックのコードの有効行数 (`mathworks.metrics.StateflowLOCCount`)	コンポーネントごとの Stateflow ブロックのコードの有効行数
MATLAB LOC	MATLAB コードの有効行数 (`mathworks.metrics.MatlabLOCCount`)	コンポーネントごとの、Stateflow の MATLAB Function ブロック関数および MATLAB 関数の有効行数

メトリクスのしきい値

モデルの複雑度、モデリングガイドラインの準拠、および再利用の各ウィジェットについて、メトリクスダッシュボードには既定のしきい値が含まれています。これらの値は、データが準拠か、または確認が必要か (警告) を示します。準拠データは、ウィジェットに緑で表示されます。警告データは、ウィジェットに黄色で表示されます。メトリクスのしきい値をもたないウィジェットの場合、青で表示されます。

モデリングガイドラインの準拠のメトリクスでは、モデルアドバイザーの問題数のしきい値は 0 です。モデルに問題が存在する場合、ウィジェットには黄色で表示されます。問題が存在しない場合、ウィジェットには緑で表示されます。
モデルに警告が存在する場合、[コードアナライザー] ウィジェットおよび [診断] ウィジェットは黄色となります。警告が存在しない場合、ウィジェットには緑で表示されます。
[再利用] ウィジェットのメトリクスのしきい値は 0 です。モデルに潜在的クローンが存在する場合、ウィジェットには黄色で表示されます。潜在的なクローンが存在しない場合、ウィジェットには緑で表示されます。
[モデルの複雑度] ウィジェットのメトリクスのしきい値は 30 です。モデルの循環的複雑度が 30 より大きい場合、ウィジェットには黄色で表示されます。値が 30 以下の場合、ウィジェットには緑で表示されます。

メトリクスダッシュボードのすべてのウィジェットについて、独自のメトリクスのしきい値を指定できます。非準拠範囲に対応する値を指定することもできます。詳細については、メトリクスダッシュボードのレイアウトおよび機能のカスタマイズを参照してください。

ダッシュボードの制限

メトリクスダッシュボードを使用するときは、以下の点を考慮してください。

メトリクスダッシュボードの解析ルートを Configurable Subsystem ブロックにすることはできません。
メトリクスダッシュボードがデータ収集に使用するツールであるモデルアドバイザーでは、モデル 1 つにつき複数のセッションを開くことはできません。このため、ダッシュボードでデータを収集するときは、モデルアドバイザーの既存のセッションが閉じられます。
sl_customization.m ファイルを使用してモデルアドバイザーチェックをカスタマイズする場合、カスタマイズによってダッシュボードの結果が変わる可能性があります。たとえば、ダッシュボードがメトリクスの収集に使用するモデルアドバイザーチェックを非表示にすると、ダッシュボードでは該当するメトリクスの結果が収集されません。
メトリクスダッシュボードは、ブロックに関連しない MAB チェックを問題としてカウントしません。例として、フォント書式やファイル名に関して警告するチェックがあります。[モデルアドバイザーチェックの問題] ウィジェットでは、MAB 問題がゼロと報告される場合がありますが、MAB の [モデリングガイドラインの準拠] ウィジェットでは問題が報告されます。これらの問題の詳細については、MAB の [モデリングガイドラインの準拠] ウィジェットをクリックしてください。