AppSignalカスタムメトリック入門：Gauge・Counter・Distributionの使い方

カスタムメトリックで、より深いインサイトを

AppSignalのgemでは、以前からカスタム計測（インストゥルメンテーション）を利用して、アプリケーションパフォーマンスに関する詳細な情報を取得できました。しかし、パフォーマンス以外の指標も追跡したいケースは少なくありません。

gemのバージョン1.0のリリースにより、AppSignalへカスタムメトリックを送信できるようになりました。新規アカウント数からデータベースのディスク使用量まで、アプリケーション内のあらゆるデータを追跡できます。カスタムメトリックはコード計測の代わりとなるものではなく、コード内の特定のデータをより扱いやすくし、時系列で測定可能にするための追加手段です。

3種類のメトリック

AppSignalが提供するメトリックは、次の3種類です。

AppSignalのgemには、それぞれのメトリックタイプに対応したメソッドが用意されており、これらを使ってデータを送信できます。

Gauge（ゲージ）

ゲージは、増加も減少もしうる値の計測に最適です。AppSignalでは、アクティブなアカウント数をグラフ化するためにゲージを使用しています。

count = Account.active.count
Appsignal.set_gauge('account_count', count)

Counter（カウンター）

名前のとおり、カウンターは「何かが起きた回数」を記録するのに便利な仕組みです。たとえば私たちのワーカーは、複数のデータポイントを含むペイロードを処理します。この場合、ジョブの実行回数だけでは、実際に処理したデータ量を正確に表せません。そこでカウンターを使い、処理したデータポイントごとに値を増加させています。

minute.metrics.each do |metric|
  Appsignal.increment_counter('metric_count', metric.length)
end

Distribution（ディストリビューション）

ディストリビューションは、コードの実行にかかる平均時間を測定するために使います。たとえば、1つのジョブが複数のmap/reduce処理を実行する場合、計測機能で全体の所要時間は追跡できても、個々の処理の平均時間までは把握できません。ディストリビューションを使えば、各ジョブの平均所要時間を見やすいグラフで確認できます。

Appsignal.add_distribution_value('mapreduce_duration', MapReduce::Minutely.new.run.time)

メトリックをグラフにする

メトリックをAppSignalへ送信することは、ゴールまでの道のりの半分にすぎません。送信したデータを可視化するには、グラフを作成する必要があります。グラフは「カスタムメトリック」ページのエディターで作成します。

カスタムメトリック機能では、グラフを配置した複数の画面（スクリーン）を作成できます。画面とグラフの構成は、YAML形式で定義するのが特徴です。

たとえば、アカウント数を表示するグラフを持つ画面を作成するには、次のようなYAMLを記述します。

- title: Account overview
  graphs:
    - title: "Number of accounts"
      kind: gauge
      format: number
      fields:
        - account_count

この設定を保存すると、次のようなページが生成されます。

また、フィールドを列挙する代わりに、1つ以上のメトリック名に一致する正規表現を指定することも可能です。次の例では、サードパーティAPIのレスポンスコードごとに線を引いたグラフが描画されます。

- title: API Responses
  graphs:
    - title: "API response codes"
      kind: count
      filter: "api_response_code_[0-9]+"
      format: number

ここで紹介したのは、AppSignalで追跡できる数多くの有用なメトリックのほんの一例です。カスタムメトリックの詳細についてはドキュメントをご覧ください。アカウントへの設定でお困りの場合は、お気軽にお問い合わせください。