diff options
author | Ola Aunrønning <olaa@yahooinc.com> | 2023-10-17 16:06:24 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-10-17 16:06:24 +0200 |
commit | e3912ac2c435142575ff7e3f7b72c578e0ae1a63 (patch) | |
tree | 90ae9d2f8f927ecb603f030982eef5a104037e7a /metrics | |
parent | 1d4f18521b1563a83bc600b42ff6e387b320e1db (diff) | |
parent | a4e40c949e3696eced5a994209b82000eecdebb8 (diff) |
Merge pull request #28972 from vespa-engine/yngveaasheim/add-description-to-metric-set-reference-doc
Add a short description to metric set reference documentation
Diffstat (limited to 'metrics')
-rw-r--r-- | metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java | 8 |
1 files changed, 7 insertions, 1 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 b046d55c089..a15f2916091 100644 --- a/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java +++ b/metrics/src/main/java/ai/vespa/metrics/docs/MetricSetDocumentation.java @@ -45,8 +45,14 @@ public class MetricSetDocumentation { referenceBuilder.append(String.format(""" --- # 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() |