Add legacy names to label enum

1 files changed, 29 insertions, 18 deletions

diff --git a/metrics/src/main/java/ai/vespa/metrics/Labels.java b/metrics/src/main/java/ai/vespa/metrics/Labels.java
index dc17d0ada22..50748b7b421 100644
--- a/metrics/src/main/java/ai/vespa/metrics/Labels.java
+++ b/metrics/src/main/java/ai/vespa/metrics/Labels.java
@@ -1,6 +1,8 @@
 package ai.vespa.metrics;
 // Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
 
+import java.util.Set;
+
 /**
  * @author yngveaasheim
  */
@@ -10,34 +12,37 @@ public enum Labels {
     // We try to follow recommendations outlined in OpenTelemetry Semantic Conventions for these labels, https://opentelemetry.io/docs/specs/semconv/.
 
     // Labels to be decorated onto all tenant related metrics generated for Vespa Cloud.
-    CLUSTER("ai.vespa.cluster", "The name of a Vespa cluster."),
-    CLUSTER_TYPE("ai.vespa.cluster_type", "The type of a Vespa cluster, typically one of 'admin', 'container', 'content'."),
-    DEPLOYMENT_CLUSTER("ai.vespa.deployment_cluster", "Unique ID for a Vespa deployment cluster, in the format <tenant>.<application>.<instance>.<zone>.<cluster>."),
-    INSTANCE("ai.vespa.instance", "The id of a Vespa application instance in the format <tenant>.<application>.<instance>."),
-    GROUP("ai.vespa.group", "The group id of a Vespa content node. Samples values are 'Group 1', 'Group 2', etc."),
-    SYSTEM("ai.vespa.system", "The name of a managed Vespa system, sample values are 'public', 'publiccd'."),
-    ZONE("ai.vespa.zone", "The name of a zone in managed Vespa, in the format <environment>.<region>. Sample name 'prod.aws-us-west-2a'."),
-    PARENT("ai.vespa.parent", "The fully qualified name of the parent host on which a Vespa node is running."),
-    NODE("ai.vespa.node", "The fully qualified name of the Vespa node."),
+    APPLICATION("ai.vespa.application", "The name of a Vespa application.", Set.of("applicationName")),
+    CLUSTER("ai.vespa.cluster", "The name of a Vespa cluster.", Set.of("clusterid", "clustername", "cluster")),
+    CLUSTER_TYPE("ai.vespa.cluster_type", "The type of a Vespa cluster, typically one of 'admin', 'container', 'content'.", Set.of("clustertype")),
+    DEPLOYMENT_CLUSTER("ai.vespa.deployment_cluster", "Unique ID for a Vespa deployment cluster, in the format <tenant>.<application>.<instance>.<zone>.<cluster>.", Set.of("deploymentCluster")),
+    INSTANCE("ai.vespa.instance", "The name of a Vespa application instance", Set.of("instanceName")),
+    INSTANCE_ID("ai.vespa.instance_id", "The id of a Vespa application instance in the format <tenant>.<application>.<instance>.", Set.of("applicationId")),
+    GROUP("ai.vespa.group", "The group id of a Vespa content node. Samples values are 'Group 1', 'Group 2', etc.", Set.of("groupId")),
+    SYSTEM("ai.vespa.system", "The name of a managed Vespa system, sample values are 'public', 'publiccd'.", Set.of("system")),
+    TENANT("ai.vespa.tenant", "The name of a tenant.", Set.of("tenantName")),
+    ZONE("ai.vespa.zone", "The name of a zone in managed Vespa, in the format <environment>.<region>. Sample name 'prod.aws-us-west-2a'.", Set.of("zone")),
+    NODE("ai.vespa.node", "The fully qualified name of the Vespa node. This is identical to the value of 'host.name' for services running in the host environment.", Set.of("host")),
 
     // Labels used for a subset of the metrics only:
-    CHAIN("ai.vespa.chain", "The name of a search chain"),
-    DOCUMENT_PROCESSOR("ai.vespa.document_processor", "Document processor name."),
-    SERVICE("ai.vespa.service", "Vespa service name, e.g. 'container', 'distributor', 'searchnode'."),
-    THREAD_POOL("ai.vespa.thread_pool", "Thread pool name."),
-    VERSION("ai.vespa.version", "Version of Vespa running on a node."),
+    CHAIN("ai.vespa.chain", "The name of a search chain", Set.of("chain")),
+    DOCUMENT_PROCESSOR("ai.vespa.document_processor", "Document processor name.", Set.of("docproc")),
+    SERVICE("ai.vespa.service", "Vespa service name, e.g. 'container', 'distributor', 'searchnode'.", Set.of("service", "instance")),
+    THREAD_POOL("ai.vespa.thread_pool", "Thread pool name.", Set.of("threadpool")),
+    VERSION("ai.vespa.version", "Version of Vespa running on a node.", Set.of("vespaVersion")),
 
     // TODO: Add other labels used by the metrics in the summary dashboard: "api, gcName, gpu, interface, operation, protocol(verify, requestType, role, scheme, status(verify)
 
     // Labels defined by OpenTelemetry Semantic Conventions external to Vespa
     HOST_ARCH("host.arch", "The CPU architecture of a host, e.g. 'x86_64', 'arm64'. See also https://opentelemetry.io/docs/specs/semconv/resource/host/"),
-    HOST_NAME("host.name", "The fully qualified name of a host. See also https://opentelemetry.io/docs/specs/semconv/resource/host/"),
-    HOST_TYPE("host.type", "The type of a host. See also https://opentelemetry.io/docs/specs/semconv/resource/host/"),
-    HTTP_REQUEST_METHOD("http.request.method", "The HTTP request method specified. See also https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/"),
-    HTTP_RESPONSE_STATUS_CODE("http.response.status_code", "The HTTP response code. See also https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/");
+    HOST_NAME("host.name", "The fully qualified name of a host. This is the name of the host on which one or more nodes are running. See also https://opentelemetry.io/docs/specs/semconv/resource/host/", Set.of("parentHostname")),
+    HOST_TYPE("host.type", "The type of a host. See also https://opentelemetry.io/docs/specs/semconv/resource/host/", Set.of("flavor")),
+    HTTP_REQUEST_METHOD("http.request.method", "The HTTP request method specified. See also https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/", Set.of("httpMethod")),
+    HTTP_RESPONSE_STATUS_CODE("http.response.status_code", "The HTTP response code. See also https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/", Set.of("statusCode", "status-code"));
 
     private final String name;
     private final String description;
+    private final Set<String> legacyNames;
 
     public String getName() {
         return name;
@@ -49,5 +54,11 @@ public enum Labels {
     Labels(String name, String description) {
         this.name = name;
         this.description = description;
+        this.legacyNames = null;
+    }
+    Labels(String name, String description, Set<String> legacyNames) {
+        this.name = name;
+        this.description = description;
+        this.legacyNames = legacyNames;
     }
 }