diff options
Diffstat (limited to 'metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java')
| -rw-r--r-- | metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java b/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java index bafefbfedd6..a15f2916091 100644 --- a/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java +++ b/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java @@ -1,3 +1,4 @@ +// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package ai.vespa.metrics.docs; import ai.vespa.metrics.Suffix; @@ -43,9 +44,15 @@ public class MetricSetDocumentation { 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. + # Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. + # Note: This file is generated by + # https://github.com/vespa-engine/vespa/blob/master/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java title: "%s Metric Set" - ---""", name)); + --- + <p> + This document provides reference documentation for the %s metric set, including suffixes present per metric. + If the suffix column contains "N/A" then the base name of the corresponding metric is used with no suffix. + </p>""", name, name)); metricsByType.keySet() .stream() .sorted() |