アプリパラメーター

概要

アプリパラメーターはアプリケーションのメトリックを監視する有用な機能です。アプリパラメーターでは、次の項目が監視可能です。

値の大きさを表す数値か、変数の出現頻度
値の大きさか、アプリケーションでの演算の出現頻度

たとえば、シンプルなWebリクエストで、API呼び出し1回、データベース操作1回、キャッシュヒット1回が発生するものとします。また、1回のリクエストが複数リソースにかかわったり、複数ユーザーが複数リクエストを同時に実行したりするものとします。アプリパラメーターを利用すれば、この例における、ある期間でのAPI呼び出しの頻度やDB操作の回数が、判定可能です。これによって、該当期間にCPUやメモリが過負荷になっていないかや、アプリのパフォーマンスに影響が出ていないか、判断が容易となります。

現実のアプリケーションでも、DB呼び出しへのヒット頻度、サービス呼び出し、ユーザー定義のフレームワーク呼び出しなどを監視する際、アプリパラメーター機能が有用です。ヒットの過負荷によるパフォーマンス低下は、アプリパラメーターのレポートにもとづき、トラブルシュート可能となります。

アプリパラメーターを使うにあたって

関与する演算

合計：ある間隔で1パラメーターに渡されるすべての値の合計です。
平均：指定間隔で1パラメーターに渡される値の平均です。

あらゆるパラメーターは出現状況を追跡できるよう、次のメトリックを付けて送信されます。

合計

パラメーター	説明
パラメーター名	アプリケーションでユーザーが指定するパラメーター名です。
合計値	ある間隔における対応パラメーターの集約値を示します。

平均

パラメーター	説明
パラメーター名	アプリケーションでユーザーが指定するパラメーター名です。
合計値	ある間隔における対応パラメーターの集約値を示します。
最小値	特定間隔で捕捉したうちの最小値です。
最大値	特定間隔で捕捉したうちの最大値です。
総数	ヒットの総数を表します。

メモ：アプリパラメーターAPIは、.NET、Java、Node.jsのエージェントでのみ利用できます。

.NETアプリケーションのインストールの手引き

APMインサイト.NETエージェントのインストール
インストールパスに見つかるDotNetAgent.Api.dllファイルを、お客さまアプリケーションへの参照に追加してください。
必要箇所に次のコードスニペットを記載します。

構文

合計：

あるパラメーターに特定期間に渡された値の合計を指します。合計が空白の場合、1ずつ増えます。

DotNetAgent.Api.CustomTracker.Increment("keyName");
DotNetAgent.Api.CustomTracker.Increment("keyName", value);

平均：

あるパラメーターに特定期間に渡された値の平均を示します。

DotNetAgent.Api.CustomTracker.Average("keyName", value);

例

public ActionResult Register()

{
DateTime st = DateTime.Now;
double myKeyValue = Convert.ToDouble(Request.QueryString["mykey"]);

// パラメーター"register"は1増え、合計として送信される
DotNetAgent.Api.CustomTracker.Increment("register");

// パラメーター"mykey"はmyKeyValueの分だけ増え、合計として送信される
DotNetAgent.Api.CustomTracker.Increment("mykey", myKeyValue);

double myKeyAvgValue = GetAverageValue();
// パラメーター"myavgkey"は値の分だけ増え、平均として送信される
DotNetAgent.Api.CustomTracker.Average("myavgkey", myKeyAvgValue);
return View();

}

アプリケーションを公開すると、パラメーターのトラッキングが始まります。

Javaアプリケーションのインストールの手引き

APMインサイトJavaエージェントのインストール
エージェント導入の要件に合うか確認ください。お客さまアプリケーションのビルドパスにあるAPI jar（apminsight-javaagent-api.jar）をバンドルしてください。WEB-INF/libに置くのが理想的です。
必要箇所に次のコードスニペットを記載します。

構文

合計：

キーの値は1増えます。キーはポーリング間隔ごとにクリアされます。

CustomMetric.increment("key_name")

キーの値は指定値だけ増えます。キーはポーリング間隔ごとにクリアされます。

CustomMetric.increment("key_name", value)

平均：

値は集約後、エージェントが集計し、Applications Managerのサーバーに送出します。

CustomMetric.average("key_name", value)

例

private void generateReport(String type){
CustomMetric.increment(type);
// その他のアプリケーションコード
double averageValue = getAverageValue();
CustomMetric.average(type, averageValue);
}

アプリケーションを公開すると、パラメーターのトラッキングが始まります。