WebOTX Manual V11.1 (第6版) 目次を表示

---

14.6. MicroProfile Metrics

14.6.1. 概要

　MicroProfile Metrics 3.0（以降、Metrics と記載）は、マイクロサービスの さまざまなデータを定量化し、定量化したデータを管理しやすいように加工して 提供するための仕様です。

Health では主に、アプリケーションが正常かどうかを UP/DOWN で通知しますが、 Metrics では、Heal の健全性を判断するために役立ちます。 例えば、ディスク容量が制限なしに増加していく、といったケースにおいて Metrics は問題の発見を容易にします。

14.6.2. メトリクスのアーキテクチャ

Metrics ではメタデータの保管場所を提供する必要があり、次の 3 つのスコープとして定義されています。

• base（ベース）・・・ 全てのベンダーが提供しなければならないメトリクス
• vendor（ベンダー）・・・ ベンダー固有のメトリクス（オプション）
• application（アプリケーション）・・・ アプリケーション固有のメトリクス

14.6.2.1. REST エンドポイント

　ここでは、監視エージェントがメトリクスを受信するために使用する REST-API について説明します。 REST-API では、JSON フォーマットと OpenMetrics フォーマットをサポートしています。以下では、それぞれについて説明します。

JSON フォーマット

　JSON フォーマットを使用した場合、サブリソース用のサブツリーをツリー形式のデータフォーマットで GET リクエストに応答します。 データを含まないサーブツリーは省略されます。

JSON 形式の取得例：

            {
              "thread.count" : 33,
              "thread.max.count" : 47,
              "memory.maxHeap" : 3817863211,
              "memory.usedHeap" : 16859081,
              "memory.committedHeap" : 64703546
            }

OpenMetrics フォーマット

JSON フォーマットとは異なり、OPTIONS リクエストはサポートしません。

OpenMetrics 形式の取得例：

            # TYPE base_foo_val_seconds gauge
            # HELP base_foo_val_seconds The average duration of foo requests during last 5 minutes
            base_foo_val_seconds{app="webshop"} 12.345
            # TYPE base_bar_val_bytes gauge
            base_bar_val_bytes{component="backend", app="webshop"} 42000

• メトリクス名は、CamelCase（単語の区切りで大文字にする記法）から、 snake_case（単語の区切りで _ を使って連結する記法）に変換されます。
• 説明文は HELP 行に出力されます。
• メトリクス名は、_ の付いたファミリの基本的な単位と定義されたラベルを取得します。

14.6.2.2. スコープ

ここでは、WebOTX V11.1 でサポートしている base、vendor、application スコープについて説明します。

base（ベース）スコープ

bese（ベース）メトリクスは、全ての MicroProfile 準拠ベンダーが提供しなければならないメトリクスの一覧です。 base（ベース）メトリクスは「/metrics/base」で公開されます。

WebOTX V11.1 で提供している base スコープの一覧は以下の通りです。

vendor（ベンダー）スコープ

vendor（ベンダー）メトリクスは、MicroProfile 準拠ベンダーが独自に提供するメトリクスの一覧です。 vendor（ベンダー）メトリクスは「/metrics/vendor」で公開されます。

WebOTX V11.1 で既定値として提供している vendor スコープの一覧は以下の通りです。
既定値では出力していない、マシンのCPU情報(*1)、JavaVM(基本情報/プロセス毎のメモリ情報/GC情報/クラスロード情報/スレッド情報)(*1)、 アプリケーションのデータソース情報(*2)/リクエスト数情報(*3)/HTTPセッション情報(*4) を出力するように設定することが可能です。
これらの情報を有効にするには次の定義ファイルでコメントアウト(行頭が#)しているものを項目単位で有効にしてください。ドメインを再起動することで設定を反映します。
　　・{ドメインディレクトリ}/config/vendor-metrics.properties

(*1) 予め対応するJVMのモニタリングレベルをHIGHに設定しておく必要があります。
(*2) 予め対応するJDBCデータソースのモニタリングレベルをHIGHに設定しておく必要があります。
(*3) 予め対応するHTTPサービスのモニタリングレベルをHIGHに設定しておく必要があります。
(*4) 予め対応するWebコンテナのモニタリングレベルをHIGHに設定しておく必要があります。
　　モニタリングレベルの変更については、構築・運用 > モニタリング > モニタリング情報の採取を参照してください。

14.6.2.3. application（アプリケーション）スコープ

アプリケーション固有のメトリクスは、実行時にアプリケーションにより提供されるもので、サーバーに固定されるものではありません。 このスコープは「/metrics/application」で公開されます。

アプリケーションスコープで公開できる値は、アプリケーション上で以下のようにアノテーションを定義することで /metrics/application から取得できるようになります。

@Gauge(name = "queueSize")
public int getQueueSize() {
  return queueSize;
}

アプリケーション上で使用できるアノテーションは、以下のものです。

（C=コンストラクタ、F=フィールド、M=メソッド、P=パラメータ、T=タイプ）

14.6.2.4. フィールド

全てのアノテーションは、メタデータフィールドに対応する次のフィールドを持っています。

14.6.2.5. アノテーションの命名規則

アノテートされたメトリクスは、アプリケーションの MetricRegistry にアノテーションの名前と絶対フィールドに基づく名前で登録されます。

例：

package com.example;

import javax.inject.Inject;
import org.eclipse.microprofile.metrics.Counter;
import org.eclipse.microprofile.metrics.annotation.Metric;

public class Colours {

  @Inject
  @Metric
  Counter redCount;

  @Inject
  @Metric(name="blue")
  Counter blueCount;

  @Inject
  @Metric(absolute=true)
  Counter greenCount;

  @Inject
  @Metric(name="purple", absolute=true)
  Counter purpleCount;
}

上記の bean は、MetricRegistry で次のエントリを生成します。

      com.example.Colours.redCount
      com.example.Colours.blue
      greenCount
      purple

14.6.2.6. @MetricRegistry

　MetricRegistry は、メトリクスとメタデータのコレクションを保持するために使用されます。 スコープ（アプリケーション、ベース、ベンダー）毎に MetricRegistry の共有シングルトンが 1 つ存在します。 アプリケーションを使用してメトリクスを登録すると、アプリケーション MetricRegistry にアノテーションの名前と絶対フィールドに基づく名前で登録されます。

　また、インジェクトすると、@RegistryType は修飾子として使用され、アプリケーション、ベース、ベンダーレジストリの いずれかを選択的にインジェクトします。 修飾子を使用しない場合、返却される既定値の MetricRegistry はアプリケーションレジストリです。

アプリケーションタイプとなる MetricRegistry の指定方法

アプリケーションタイプとして、MetricRegistry を指定する場合は、以下のようにします。

      @Inject
      MetricRegistry metricRegistry;

      @Inject
      @RegistryType(type=MetricRegistry.Type.APPLICATION)
      MetricRegistry metricRegistry;

ベースタイプとなる MetricRegistry の指定方法

ベースタイプとして、MetricRegistry を指定する場合は、以下のようにします。

      @Inject
      @RegistryType(type=MetricRegistry.Type.BASE)
      MetricRegistry baseRegistry;

14.6.3. Metrics の MBean 設定項目

Metrics には以下の設定項目があります。設定の反映には、ドメインの再起動が必要です。