aboutsummaryrefslogtreecommitdiffstats
path: root/metrics/src/main/java/ai/vespa/metrics/docs/MetricDocumentation.java
blob: fc46c785f0e475853bbbea4535e0d3792b5df22e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package ai.vespa.metrics.docs;

import ai.vespa.metrics.VespaMetrics;

import java.io.FileWriter;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * @author olaa
 */
public class MetricDocumentation {

    protected static void writeMetricDocumentation(String path, VespaMetrics[] metrics, String metricType) {
        var referenceBuilder = new StringBuilder();
        referenceBuilder.append(String.format("""
                        ---
                        # Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
                        title: "%s Metrics"
                        ---

                        <table class="table">
                          <thead>
                              <tr><th>Name</th><th>Description</th><th>Unit</th></tr>
                          </thead>
                          <tbody>
                        %s  </tbody>
                        </table>
                        """, metricType, htmlRows(metrics)));

        try (FileWriter fileWriter = new FileWriter(path + "/" + metricType.toLowerCase() + "-metrics-reference.html")) {
            fileWriter.write(referenceBuilder.toString());
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    private static String htmlRows(VespaMetrics[] metrics) {
        return Stream.of(metrics)
                .map(metric ->
                        String.format(
                                """
                                     <tr>
                                       <td><p id="%s">%s</p></td>
                                       <td>%s</td>
                                       <td>%s</td>
                                     </tr>
                                 """,
                                metric.baseName().replaceAll("\\.", "_"),
                                metric.baseName(),
                                metric.description(),
                                metric.unit().toString().toLowerCase())
                ).collect(Collectors.joining());
    }
}