SpringRESTAPIのメトリクス

投稿日: 2019-10-18 2022-11-06
タグ: Metrics, REST, Spring

1. 概要

このチュートリアルでは、の基本的な指標をSpring RESTAPIに統合します。

最初に単純なサーブレットフィルタを使用してメトリック機能を構築し、次にSpring Bootアクチュエータモジュールを使用して構築します。

2. web.xml

まず、フィルター「 MetricFilter 」を、アプリのweb.xmlに登録します。

<filter>
    <filter-name>metricFilter</filter-name>
    <filter-class>org.baeldung.metrics.filter.MetricFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>metricFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

着信するすべてのリクエストをカバーするようにフィルターをマッピングしていることに注意してください– “ / *” –もちろん完全に構成可能です。

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. メトリック–ステータスコードカウント

次へ–単純なInMemoryMetricServiceを見てみましょう。

@Service
public class MetricService {

    private Map<Integer, Integer> 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メソッドにマップします。

@GetMapping(value = "/status-metric")
@ResponseBody
public Map getStatusMetric() {
    return metricService.getStatusMetric();
}

そして、ここにサンプルの応答があります：

{  
    "404":1,
    "200":6,
    "409":1
}

5. メトリック–リクエスト別のステータスコード

次へ– リクエストごとのカウントのメトリックを記録しましょう：

@Service
public class MetricService {

    private Map<String, Map<Integer, Integer>> metricMap;

    public void increaseCount(String request, int status) {
        Map<Integer, Integer> 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を介してメトリックの結果を表示します。

@GetMapping(value = "/metric")
@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. メトリック–時系列データ

全体的なカウントはアプリケーションでいくらか役立ちますが、システムがかなりの時間実行されている場合–これらのメトリックが実際に何を意味するのかを判断するのは困難です。

データが意味をなし、簡単に解釈されるためには、時間のコンテキストが必要です。

次に、単純な時間ベースのメトリックを作成しましょう。次のように、1分あたりのステータスコードカウントの記録を保持します。

@Service
public class MetricService {

    private static final SimpleDateFormat DATE_FORMAT = 
      new SimpleDateFormat("yyyy-MM-dd HH:mm");
    private Map<String, Map<Integer, Integer>> timeMap;

    public void increaseCount(String request, int status) {
        String time = DATE_FORMAT.format(new Date());
        Map<Integer, Integer> 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<Integer> 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;
    Map<Integer, Integer> tempMap;
    for (Entry<String, Map<Integer, Integer>> 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++;
    }

    for (int k = 1; k < result[0].length; k++) {
        result[0][k] = result[0][k].toString();
    }

   return result; 
}

これをAPIにマッピングします。

@GetMapping(value = "/metric-graph-data")
@ResponseBody
public Object[][] getMetricData() {
    return metricService.getGraphData();
}

そして最後に、GoogleChartsを使用してレンダリングします。

<html>
<head>
<title>Metric Graph</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script type="text/javascript" src="https://www.google.com/jsapi"></script>
<script type="text/javascript">
google.load("visualization", "1", {packages : [ "corechart" ]});

function drawChart() {
$.get("/metric-graph-data",function(mydata) {
    var data = google.visualization.arrayToDataTable(mydata);
    var options = {title : 'Website Metric',
                   hAxis : {title : 'Time',titleTextStyle : {color : '#333'}},
                   vAxis : {minValue : 0}};

    var chart = new google.visualization.AreaChart(document.getElementById('chart_div'));
    chart.draw(data, options);

});

}
</script>
</head>
<body onload="drawChart()">
    <div id="chart_div" style="width: 900px; height: 500px;"></div>
</body>
</html>

7. SpringBoot1.xアクチュエータの使用

次のいくつかのセクションでは、Spring Bootのアクチュエーター機能に接続して、メトリックを表示します。

まず、アクチュエータの依存関係をpom.xmlに追加する必要があります。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

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<String> 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<List<Integer>> statusMetric;
    private List<String> statusList;
    
    @Scheduled(fixedDelay = 60000)
    private void exportMetrics() {
        Metric<?> metric;
        List<Integer> 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);
    }
}

1分あたりのステータスコードのカウントを保存していることに注意してください。

7.4. Spring Boot PublicMetrics

次のように、独自のフィルターを使用する代わりに、Spring Boot PublicMetricsを使用してメトリックをエクスポートすることもできます。

まず、1分あたりのメトリックをエクスポートするというスケジュールされたタスクがあります。

@Autowired
private MetricReaderPublicMetrics publicMetrics;

private List<List<Integer>> statusMetricsByMinute;
private List<String> statusList;
private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");

@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
    List<Integer> lastMinuteStatuses = initializeStatuses(statusList.size());
    for (Metric<?> counterMetric : publicMetrics.metrics()) {
        updateMetrics(counterMetric, lastMinuteStatuses);
    }
    statusMetricsByMinute.add(lastMinuteStatuses);
}

もちろん、HTTPステータスコードのリストを初期化する必要があります。

private List<Integer> initializeStatuses(int size) {
    List<Integer> counterList = new ArrayList<>();
    for (int i = 0; i < size; i++) {
        counterList.add(0);
    }
    return counterList;
}

次に、ステータスコードカウントで実際にメトリックを更新します。

private void updateMetrics(Metric<?> counterMetric, List<Integer> statusCount) {

    if (counterMetric.getName().contains("counter.status.")) {
        String status = counterMetric.getName().substring(15, 18); // example 404, 200
        appendStatusIfNotExist(status, statusCount);
        int index = statusList.indexOf(status);
        int oldCount = statusCount.get(index) == null ? 0 : statusCount.get(index);
        statusCount.set(index, counterMetric.getValue().intValue() + oldCount);
    }
}

private void appendStatusIfNotExist(String status, List<Integer> statusCount) {
    if (!statusList.contains(status)) {
        statusList.add(status);
        statusCount.add(0);
    }
}

ご了承ください：

PublicMeticsステータスカウンター名は「counter.status 」で始まります（例：「 counter.status.200.root 」）。
リストstatusMetricsByMinuteに1分あたりのステータスカウントの記録を保持します

収集したデータをエクスポートしてグラフに描画できます–次のようになります。

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() - (60000L * (rowCount - i))));
    }

    List<Integer> minuteOfStatuses;
    List<Integer> last = new ArrayList<Integer>();

    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<Integer> temp;
    for (int i = 1; i < rowCount; i++) {
        temp = statusMetric.get(i - 1);
        result[i][0] = dateFormat.format
          (new Date(current.getTime() - (60000L * (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（）です。

@GetMapping(value = "/metric-graph-data")
@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. SpringBoot2.xアクチュエータの使用

Spring Boot 2では、SpringアクチュエータのAPIに大きな変更が加えられました。 Spring独自のメトリックはMicrometerに置き換えられました。それでは、上記と同じメトリックの例をMicrometerで記述してみましょう。

**8.1. CounterServiceをMeterRegistryに置き換えます**

Spring Bootアプリケーションはすでにアクチュエータスターターに依存しているため、Micrometerはすでに自動構成されています。 CounterServiceの代わりにMeterRegistryを挿入できます。さまざまなタイプのMeterを使用してメトリックをキャプチャできます。 Counterはメーターの1つです。

@Autowired
private MeterRegistry registry;

private List<String> statusList;

@Override
public void increaseCount(int status) {
    String counterName = "counter.status." + status;
    registry.counter(counterName).increment(1);
    if (!statusList.contains(counterName)) {
        statusList.add(counterName);
    }
}

8.2. カスタムメトリックの表示

メトリックがMicrometerに登録されたので、まず、アプリケーション構成でメトリックを有効にします。これで、/actuator/metricsにあるActuatorエンドポイントに移動してそれらを表示できます。

{
  "names": [
    "application.ready.time",
    "application.started.time",
    "counter.status.200",
    "disk.free",
    "disk.total",
    .....
  ]
}

ここでは、counter.status.200メトリックが標準のアクチュエータメトリックの中にリストされていることがわかります。さらに、URIで /actuator/metrics/counter.status.200 としてセレクターを提供することにより、このメトリックの最新の値を取得することもできます。

{
  "name": "counter.status.200",
  "description": null,
  "baseUnit": null,
  "measurements": [
    {
      "statistic": "COUNT",
      "value": 2
    }
  ],
  "availableTags": []
}

**8.3. MeterRegistryを使用したカウントのエクスポート**

マイクロメータでは、 MeterRegistry：を使用してCounter値をエクスポートできます。

@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
    List<Integer> statusCount = new ArrayList<>();
    for (String status : statusList) {
        Search search = registry.find(status);
        Counter counter = search.counter();
         if (counter == null) {
             statusCount.add(0);
         } else {
             statusCount.add(counter != null ? ((int) counter.count()) : 0);
             registry.remove(counter);
         }
    }
    statusMetricsByMinute.add(statusCount);
}

8.3. メーターを使用したメトリクスの公開

MeterRegistryのメーターを使用してメトリクスを公開することもできるようになりました：

@Scheduled(fixedDelay = 60000)
private void exportMetrics() {
    List<Integer> lastMinuteStatuses = initializeStatuses(statusList.size());

    for (Meter counterMetric : publicMetrics.getMeters()) {
        updateMetrics(counterMetric, lastMinuteStatuses);
    }
    statusMetricsByMinute.add(lastMinuteStatuses);
}

private void updateMetrics(Meter counterMetric, List<Integer> statusCount) {
    String metricName = counterMetric.getId().getName();
    if (metricName.contains("counter.status.")) {
        String status = metricName.substring(15, 18); // example 404, 200
        appendStatusIfNotExist(status, statusCount);
        int index = statusList.indexOf(status);
        int oldCount = statusCount.get(index) == null ? 0 : statusCount.get(index);
        statusCount.set(index, (int)((Counter) counterMetric).count() + oldCount);
    }
}

9. 結論

この記事では、いくつかの基本的なメトリック機能をSpringWebアプリケーションに組み込むためのいくつかの簡単な方法について説明しました。

カウンターはスレッドセーフではないことに注意してください。そのため、原子番号などを使用しないと正確ではない可能性があります。これは、デルタを小さくする必要があり、100％の精度が目標ではなく、傾向を早期に発見することが目標であるという理由だけで意図されたものです。

もちろん、アプリケーションでHTTPメトリックを記録するためのより成熟した方法がありますが、これは、本格的なツールの余分な複雑さなしにそれを行うためのシンプルで軽量、そして非常に便利な方法です。

この記事の完全な実装は、GitHubプロジェクトにあります。

getdocs

13036