独自のメトリックの定義

オペレーティング環境に固有のアセット・データを表示するには、ユーザー定義のメトリックまたはキー・パフォーマンス・インジケータ(KPI)を作成します。

  1. 「メニュー」「Menu」アイコンをクリックし、「構成」を選択します。
  2. 「Metrics」「メトリック」アイコンタブをクリックします。
  3. 「Add」「Add」アイコンをクリックします。
  4. 新しいメトリックを識別するための「名前」を入力します。
  5. メトリックを作成する必要がある「エンティティ・タイプ」(アセット・タイプ)を選択します。
    メトリックは、選択したアセット・タイプの各アセットに対して使用できます。メトリックは、ダッシュボードまたはマップ・ビューで、アセット全体で集計できます。
  6. 「メトリック・タイプ」を選択します。
    • 問合せ: センサー属性を問い合せるメトリックまたは指定した式に基づいて計算および集計されるメトリックが必要な場合に選択します。

    • コード: 一般的な分析サービスで提供される式のセットを超える計算を必要とするドメイン固有のメトリックに対して、カスタム・コード・メトリックを使用します。カスタム・コードKPIは、Sparkでコードを記述および管理できるアナリストやシステム・インテグレータなどの上級ユーザーを対象としています。

      カスタム・コード・メトリックにより、メトリック・コードを作成するために編集できるコード・スキャフォールディングまたはテンプレートが提供されます。KPIをMavenプロジェクトとしてエクスポートし、任意のIDEを使用してコードを編集することもできます。

      カスタム・コード・メトリックの作成の詳細は、特殊ケースでのカスタム・コード・メトリックの使用を参照してください。

  7. 「メトリック・タイプ」フィールドに対して「センサー値」を選択した場合は、「センサー属性」の値を指定します。
    アセット・タイプのデバイス・モデルに対応するセンサー属性を選択します。
    たとえば、HVACアセットでは、油粘度出力温度などの様々なセンサー属性を使用できます。
  8. 「メトリック・タイプ」フィールドに対して「問合せ」を選択した場合は、次の手順を実行します。
    1. 「計算スケジュール」を指定します。
      • 「ライブ」は、メトリックを2分ごとに計算します。

      • 「毎時」は、毎時のメトリックを集計します。

      • 「毎日」は、毎日のメトリックを集計します。

      • 「毎週」は、毎週のメトリックを集計します。

  9. 「式」エディタを使用して、新しいメトリックを計算する式を定義します。
    「式」エディタの要素を使用して演算を作成するか、「拡張」をクリックしてSQLに似た式を直接編集できます。

    最初に集計を選択します。たとえば、センサーの1時間ごとの平均温度を計算する場合は、「平均」を選択します。

    次の集計関数を使用できます。
    • Count

    • Sum

    • Average

    • Min (最小)

    • Max (最大)

    次に、プロパティ、演算子およびその他の関数を選択して式を作成します。

    次に式の例を示します。
    • AVG (FuelLevel): 指定した期間での平均FuelLevelを返します。

    • MIN(MaxPressure/2 + MinPressure/2): 最初にMaxPressureおよびMinPressureセンサー値を使用して平均圧力を計算した後で、指定した期間でのこの平均圧力の最小値を返します。

    式には、次の要素を含めることができます。
    • カッコ: カッコを使用して演算をグループ化し、優先度を示します。
    • 記号: 算術(+、-、*、/)、関係(=、<、>、<=、>=、!=)および論理(AND、OR、LIKE)演算子を使用できます。「記号」ボタンをクリックすると、式に追加演算子が表示されます。別の演算子を選択する場合は、「追加」アイコンをクリックして、リストから別の演算子を選択します。
    • 数値、テキストおよびブール値。
    • プロパティ: 独自のメトリックを作成するために使用できるシステム属性およびセンサー属性のリスト。このリストは、選択したアセット・タイプおよび関数に基づきます。
    メトリックの説明が、選択したプロパティおよび演算子に基づいて自動的に作成されます。

    「メトリックの作成」エディタの次の例は、2つのセンサー属性の合計の最大値を1時間ごとに返す計算されたメトリックを示しています。


    「メトリックの作成」エディタ

  10. 「保存」をクリックしてメトリックを保存します。
  11. 表示されるステータス・バナー・メッセージで「公開」をクリックします。
    公開により既存のKPIメトリックはすべて再作成されて公開されるため、再公開操作中に既存のKPI値がしばらく表示されなくなる可能性があります。個々のメトリックそれぞれを追加した後に再公開するのではなく、一連のメトリックの追加後に再公開することをお薦めします。

    「アナリティクス制御」領域の「再公開」ボタンを使用して、「設定」ページからメトリックを再公開することもできます。

これで、「ダッシュボード」または「マップ」ページにメトリックを追加できます。

特殊ケースでのカスタム・コード・メトリックの使用

カスタム・コード・メトリックを使用すると、結果を計算するためのSpark実装を提供するメトリックを定義できます。

一般的な分析サービスで提供される式のセットを超える計算を必要とするドメイン固有のキー・パフォーマンス・インジケータ(KPI)に対して、コード・メトリックを使用します。コード・メトリックは、Sparkでコードを記述および管理できるアナリストやシステム・インテグレータなどの上級ユーザーを対象としています。

メトリック名やアセット・タイプなどのメトリック詳細を指定すると、コード・メトリックにより、カスタム・コードを作成するために編集できるコード・スキャフォールディングまたはテンプレートが提供されます。コードをMavenプロジェクトとしてエクスポートし、任意のIDEを使用してコードを編集することもできます。

他のユーザー定義のメトリックと同様に、コード・メトリックを「マップ」「ダッシュボード」および「アセットの詳細」ページに追加できます。

コード・メトリックの作成

コード・メトリックを作成して、メトリック結果を計算するための独自のSpark実装を提供します。

  1. 「メニュー」「Menu」アイコンをクリックし、「構成」を選択します。
  2. 「Metrics」「メトリック」アイコンタブをクリックします。
  3. 「Add」「Add」アイコンをクリックします。
  4. 新しいメトリックを識別するための「名前」を入力します。
  5. メトリックを作成する必要がある「エンティティ・タイプ」(アセット・タイプ)を選択します。
    メトリックは、選択したアセット・タイプの各アセットに対して使用できます。メトリックは、ダッシュボードまたはマップ・ビューで、アセット全体で集計できます。
  6. 「メトリック・タイプ」で、「コード」を選択します。
  7. 「クラス名」で、メトリック・コードのカスタム・パッケージおよびクラス名を指定します。
    たとえば、com.mypackage.myclassです。
  8. 「ソース」で、メトリックのデータ・ソースを選択します。これは、センサーに関連付けられている永続的なデータ・ソースまたはコンテキスト・データ・ソースです。
  9. 「計算スケジュール」を指定します。
    • 「ライブ」は、メトリックを2分ごとに計算します。

    • 「毎時」は、毎時のメトリックを集計します。

    • 「毎日」は、毎日のメトリックを集計します。

    • 「毎週」は、毎週のメトリックを集計します。

  10. 「保存」をクリックしてメトリックを保存し、コード・テンプレートを生成します。
    メトリックに対して初期コード・テンプレートが生成され、コードはエディタで開かれて、そこで編集できます。
  11. 次のいずれかのオプションを使用します。
    • コードをCODEウィンドウでインライン編集します。

      コードには、前に定義したパッケージおよびクラス名が含まれます。テンプレートには、compute関数の下にユーザー・コード領域も含まれており、ここでコードを追加できます。

      コード・ウィンドウ: 周囲のテキストで説明されています。

    • 「プロジェクトのダウンロード」をクリックし、任意のIDEで開いて編集できるMavenプロジェクトzipファイルにコードを保存します。

      プロジェクトには、選択したデータ・ソースによって使用されるスキーマおよび属性の詳細が格納されたReadmeフォルダも含まれています。

  12. コードを編集したら、「保存」をクリックしてメトリックを保存します。
  13. 表示されるステータス・バナー・メッセージで「公開」をクリックします。
    再公開により既存のメトリックはすべて再作成されて公開されるため、再公開操作中に既存のメトリック値がしばらく表示されなくなる可能性があります。個々のメトリックそれぞれを追加した後に再公開するのではなく、一連のKPIの追加後に再公開することをお薦めします。

    「アナリティクス制御」領域の「再公開」ボタンを使用して、「設定」ページからメトリックを再公開することもできます。