Spring REST APIのメトリック
1. 概要
このチュートリアルでは、basic Metrics into a Spring REST APIを統合します。
最初に単純なサーブレットフィルタを使用してメトリック機能を構築し、次にSpring BootActuatorを使用して構築します。
2. web.xml
まず、フィルター「MetricFilter」をアプリのweb.xmlに登録します。
metricFilter
org.example.web.metric.MetricFilter
metricFilter
/*
着信するすべてのリクエスト（“/*”）をカバーするようにフィルターをマッピングする方法に注意してください。これは、もちろん完全に構成可能です。
3. サーブレットフィルタ
それでは、カスタムフィルターを作成しましょう。
public class MetricFilter implements Filter {
private MetricService metricService;
@Override
public void init(FilterConfig config) throws ServletException {
metricService = (MetricService) WebApplicationContextUtils
.getRequiredWebApplicationContext(config.getServletContext())
.getBean("metricService");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws java.io.IOException, ServletException {
HttpServletRequest httpRequest = ((HttpServletRequest) request);
String req = httpRequest.getMethod() + " " + httpRequest.getRequestURI();
chain.doFilter(request, response);
int status = ((HttpServletResponse) response).getStatus();
metricService.increaseCount(req, status);
}
}フィルタは標準のBeanではないため、metricServiceを挿入するのではなく、ServletContextを介して手動で取得します。
また、ここでdoFilter APIを呼び出して、フィルターチェーンの実行を継続していることにも注意してください。
4. メトリック–ステータスコードカウント
次へ–単純なMetricServiceを見てみましょう。
@Service
public class MetricService {
private ConcurrentMap statusMetric;
public MetricService() {
statusMetric = new ConcurrentHashMap();
}
public void increaseCount(String request, int status) {
Integer statusCount = statusMetric.get(status);
if (statusCount == null) {
statusMetric.put(status, 1);
} else {
statusMetric.put(status, statusCount + 1);
}
}
public Map getStatusMetric() {
return statusMetric;
}
} メモリ内のConcurrentMapを使用して、各タイプのHTTPステータスコードのカウントを保持しています。
ここで、この基本的なメトリックを表示するために、Controllerメソッドにマップします。
@RequestMapping(value = "/status-metric", method = RequestMethod.GET)
@ResponseBody
public Map getStatusMetric() {
return metricService.getStatusMetric();
}次に、応答のサンプルを示します。
{
"404":1,
"200":6,
"409":1
}5. メトリック–リクエスト別のステータスコード
次へ–let’s record metrics for Counts by Request：
@Service
public class MetricService {
private ConcurrentMap> metricMap;
public void increaseCount(String request, int status) {
ConcurrentHashMap statusMap = metricMap.get(request);
if (statusMap == null) {
statusMap = new ConcurrentHashMap();
}
Integer count = statusMap.get(status);
if (count == null) {
count = 1;
} else {
count++;
}
statusMap.put(status, count);
metricMap.put(request, statusMap);
}
public Map getFullMetric() {
return metricMap;
}
} APIを介して指標の結果を表示します。
@RequestMapping(value = "/metric", method = RequestMethod.GET)
@ResponseBody
public Map getMetric() {
return metricService.getFullMetric();
}これらの指標は次のようになります。
{
"GET /users":
{
"200":6,
"409":1
},
"GET /users/1":
{
"404":1
}
}上記の例によると、APIには次のアクティビティがありました。
-
「GET/users」への「7」リクエスト
-
それらのうち「6」は「200」のステータスコード応答をもたらし、「409」のうちの1つのみが応答しました
6. メトリック–時系列データ
全体的なカウントは、アプリケーションではある程度役立ちますが、システムがかなりの時間実行されている場合–it’s hard to tell what these metrics actually mean。
データが意味を持ち、簡単に解釈されるためには、時間のコンテキストが必要です。
それでは、簡単な時間ベースの指標を作成しましょう。次のように、1分あたりのステータスコード数の記録を保持します。
@Service
public class MetricService{
private ConcurrentMap> timeMap;
private static SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
public void increaseCount(String request, int status) {
String time = dateFormat.format(new Date());
ConcurrentHashMap statusMap = timeMap.get(time);
if (statusMap == null) {
statusMap = new ConcurrentHashMap();
}
Integer count = statusMap.get(status);
if (count == null) {
count = 1;
} else {
count++;
}
statusMap.put(status, count);
timeMap.put(time, statusMap);
}
} そしてgetGraphData()：
public Object[][] getGraphData() {
int colCount = statusMetric.keySet().size() + 1;
Set allStatus = statusMetric.keySet();
int rowCount = timeMap.keySet().size() + 1;
Object[][] result = new Object[rowCount][colCount];
result[0][0] = "Time";
int j = 1;
for (int status : allStatus) {
result[0][j] = status;
j++;
}
int i = 1;
ConcurrentMap tempMap;
for (Entry> entry : timeMap.entrySet()) {
result[i][0] = entry.getKey();
tempMap = entry.getValue();
for (j = 1; j < colCount; j++) {
result[i][j] = tempMap.get(result[0][j]);
if (result[i][j] == null) {
result[i][j] = 0;
}
}
i++;
}
return result;
} これをAPIにマッピングします。
@RequestMapping(value = "/metric-graph-data", method = RequestMethod.GET)
@ResponseBody
public Object[][] getMetricData() {
return metricService.getGraphData();
}そして最後に、GoogleChartsを使用してレンダリングします。
Metric Graph
7. Spring Boot1.xアクチュエーターの使用
次のいくつかのセクションでは、Spring Bootのアクチュエーター機能にフックして、メトリックを提示します。
まず、アクチュエータの依存関係をpom.xmlに追加する必要があります。
org.springframework.boot
spring-boot-starter-actuator
7.1. MetricFilter
次に、MetricFilterを実際のSpringBeanに変換できます。
@Component
public class MetricFilter implements Filter {
@Autowired
private MetricService metricService;
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws java.io.IOException, ServletException {
chain.doFilter(request, response);
int status = ((HttpServletResponse) response).getStatus();
metricService.increaseCount(status);
}
}もちろん、これはマイナーな単純化ですが、以前は手動で行っていた依存関係の配線を取り除くために行う価値があります。
7.2. CounterServiceの使用
ここで、CounterServiceを使用して、各ステータスコードの発生をカウントしましょう。
@Service
public class MetricService {
@Autowired
private CounterService counter;
private List statusList;
public void increaseCount(int status) {
counter.increment("status." + status);
if (!statusList.contains("counter.status." + status)) {
statusList.add("counter.status." + status);
}
}
} 7.3. MetricRepositoryを使用してメトリックをエクスポートする
次に–MetricRepositoryを使用してメトリックをエクスポートする必要があります：
@Service
public class MetricService {
@Autowired
private MetricRepository repo;
private List> statusMetric;
private List statusList;
@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
Metric metric;
ArrayList statusCount = new ArrayList();
for (String status : statusList) {
metric = repo.findOne(status);
if (metric != null) {
statusCount.add(metric.getValue().intValue());
repo.reset(status);
} else {
statusCount.add(0);
}
}
statusMetric.add(statusCount);
}
} status codes per minuteのカウントを保存していることに注意してください。
7.4. Spring BootPublicMetrics
次のように、独自のフィルターを使用する代わりに、Spring BootPublicMetricsを使用してメトリックをエクスポートすることもできます。
まず、export metrics per minuteにスケジュールされたタスクがあります。
@Autowired
private MetricReaderPublicMetrics publicMetrics;
private List> statusMetricsByMinute;
private List statusList;
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
ArrayList lastMinuteStatuses = initializeStatuses(statusList.size());
for (Metric counterMetric : publicMetrics.metrics()) {
updateMetrics(counterMetric, lastMinuteStatuses);
}
statusMetricsByMinute.add(lastMinuteStatuses);
} もちろん、HTTPステータスコードのリストを初期化する必要があります。
private ArrayList initializeStatuses(int size) {
ArrayList counterList = new ArrayList();
for (int i = 0; i < size; i++) {
counterList.add(0);
}
return counterList;
} 次に、実際にメトリックをstatus code countで更新します。
private void updateMetrics(Metric counterMetric, ArrayList statusCount) {
String status = "";
int index = -1;
int oldCount = 0;
if (counterMetric.getName().contains("counter.status.")) {
status = counterMetric.getName().substring(15, 18); // example 404, 200
appendStatusIfNotExist(status, statusCount);
index = statusList.indexOf(status);
oldCount = statusCount.get(index) == null ? 0 : statusCount.get(index);
statusCount.set(index, counterMetric.getValue().intValue() + oldCount);
}
}
private void appendStatusIfNotExist(String status, ArrayList statusCount) {
if (!statusList.contains(status)) {
statusList.add(status);
statusCount.add(0);
}
} ご了承ください：
-
PublicMeticsステータスカウンター名は「counter.status」で始まります（例：「counter.status.200.root」）
-
リストstatusMetricsByMinuteに1分あたりのステータスカウントの記録を保持します
We can export our collected data to draw it in a graph –次のように：
public Object[][] getGraphData() {
Date current = new Date();
int colCount = statusList.size() + 1;
int rowCount = statusMetricsByMinute.size() + 1;
Object[][] result = new Object[rowCount][colCount];
result[0][0] = "Time";
int j = 1;
for (String status : statusList) {
result[0][j] = status;
j++;
}
for (int i = 1; i < rowCount; i++) {
result[i][0] = dateFormat.format(
new Date(current.getTime() - (60000 * (rowCount - i))));
}
List minuteOfStatuses;
List last = new ArrayList();
for (int i = 1; i < rowCount; i++) {
minuteOfStatuses = statusMetricsByMinute.get(i - 1);
for (j = 1; j <= minuteOfStatuses.size(); j++) {
result[i][j] =
minuteOfStatuses.get(j - 1) - (last.size() >= j ? last.get(j - 1) : 0);
}
while (j < colCount) {
result[i][j] = 0;
j++;
}
last = minuteOfStatuses;
}
return result;
} 7.5. メトリックを使用してグラフを描画する
最後に、これらのメトリックを2次元配列で表現して、グラフ化できるようにします。
public Object[][] getGraphData() {
Date current = new Date();
int colCount = statusList.size() + 1;
int rowCount = statusMetric.size() + 1;
Object[][] result = new Object[rowCount][colCount];
result[0][0] = "Time";
int j = 1;
for (String status : statusList) {
result[0][j] = status;
j++;
}
ArrayList temp;
for (int i = 1; i < rowCount; i++) {
temp = statusMetric.get(i - 1);
result[i][0] = dateFormat.format
(new Date(current.getTime() - (60000 * (rowCount - i))));
for (j = 1; j <= temp.size(); j++) {
result[i][j] = temp.get(j - 1);
}
while (j < colCount) {
result[i][j] = 0;
j++;
}
}
return result;
} そして、これがコントローラーメソッドgetMetricData()です：
@RequestMapping(value = "/metric-graph-data", method = RequestMethod.GET)
@ResponseBody
public Object[][] getMetricData() {
return metricService.getGraphData();
}次に、応答のサンプルを示します。
[
["Time","counter.status.302","counter.status.200","counter.status.304"],
["2015-03-26 19:59",3,12,7],
["2015-03-26 20:00",0,4,1]
]8. Spring Boot2.xアクチュエーターの使用
Spring Boot 2では、SpringActuatorのAPIに大きな変更が加えられました。 Spring’s own metrics have been replaced with Micrometer.では、上記と同じメトリックの例をMicrometerで記述しましょう。
8.1. CounterServiceをMeterRegistryに置き換える
Spring BootアプリケーションはすでにActuatorスターターに依存しているため、Micrometerはすでに自動構成されています。 CounterServiceの代わりにMeterRegistryを注入できます。 さまざまなタイプのMeterを使用して、メトリックをキャプチャできます。 Counterはメーターの1つです。
@Autowired
private MeterRegistry registry;
private List statusList;
@Override
public void increaseCount(final int status) {
String counterName = "counter.status." + status;
registry.counter(counterName).increment(1);
if (!statusList.contains(counterName)) {
statusList.add(counterName);
}
} 8.2. MeterRegistryを使用したカウントのエクスポート
マイクロメータでは、MeterRegistry:を使用してCounter値をエクスポートできます
@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
ArrayList statusCount = new ArrayList();
for (String status : statusList) {
Search search = registry.find(status);
if (search != null) {
Counter counter = search.counter();
statusCount.add(counter != null ? ((int) counter.count()) : 0);
registry.remove(counter);
} else {
statusCount.add(0);
}
}
statusMetricsByMinute.add(statusCount);
} 8.3. Metersを使用したメトリックの公開
これで、MeterRegistry’s Meters:を使用してメトリックを公開することもできます
@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
ArrayList lastMinuteStatuses = initializeStatuses(statusList.size());
for (Meter counterMetric : publicMetrics.getMeters()) {
updateMetrics(counterMetric, lastMinuteStatuses);
}
statusMetricsByMinute.add(lastMinuteStatuses);
}
private void updateMetrics(final Meter counterMetric, final ArrayList statusCount) {
String status = "";
int index = -1;
int oldCount = 0;
if (counterMetric.getId().getName().contains("counter.status.")) {
status = counterMetric.getId().getName().substring(15, 18); // example 404, 200
appendStatusIfNotExist(status, statusCount);
index = statusList.indexOf(status);
oldCount = statusCount.get(index) == null ? 0 : statusCount.get(index);
statusCount.set(index, (int)((Counter) counterMetric).count() + oldCount);
}
} 9. 結論
この記事では、いくつかの基本的なメトリック機能をSpring Webアプリケーションに組み込む簡単な方法をいくつか検討しました。
カウンターaren’t thread-safeに注意してください。したがって、原子番号などを使用しないと正確ではない可能性があります。 これは、デルタを小さくする必要があり、100％の精度が目標ではなく、傾向を早期に発見することが目標であるという理由だけで意図的に行われました。
もちろん、アプリケーションでHTTPメトリックスを記録するより成熟した方法がありますが、これは、本格的なツールの余分な複雑さなしに、それを行うためのシンプルで軽量で非常に便利な方法です。
この記事の完全な実装はthe GitHub projectにあります。