Units stored in search type metrics

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/MayHaveUnit.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2020 Graylog, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ */
+package org.graylog.plugins.views.search.searchtypes.pivot;
+
+import org.graylog.plugins.formatting.units.model.UnitId;
+
+import java.util.Optional;
+
+public interface MayHaveUnit {
+
+    Optional<UnitId> unit();
+}

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Average.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Average.NAME)
 @JsonDeserialize(builder = Average.Builder.class)
-public abstract class Average implements SeriesSpec, HasField {
+public abstract class Average implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "avg";
 
     @Override
@@ -39,6 +42,9 @@ public abstract class Average implements SeriesSpec, HasField {
     @Override
     public abstract String id();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @Override
     @JsonProperty
     public abstract String field();
@@ -76,12 +82,14 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         @JsonProperty("whole_number")
         public abstract Builder wholeNumber(Boolean wholeNumber);
 
         abstract Optional<String> id();
         abstract String field();
-
         abstract Boolean wholeNumber();
         abstract Average autoBuild();
 

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Latest.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Latest.NAME)
 @JsonDeserialize(builder = Latest.Builder.class)
-public abstract class Latest implements SeriesSpec, HasField {
+public abstract class Latest implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "latest";
 
     @Override
@@ -39,6 +42,9 @@ public abstract class Latest implements SeriesSpec, HasField {
     @Override
     public abstract String id();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @JsonProperty
     public abstract String field();
 
@@ -72,6 +78,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract Latest autoBuild();

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Max.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Max.NAME)
 @JsonDeserialize(builder = Max.Builder.class)
-public abstract class Max implements SeriesSpec, HasField {
+public abstract class Max implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "max";
 
     @Override
@@ -39,6 +42,9 @@ public abstract class Max implements SeriesSpec, HasField {
     @Override
     public abstract String id();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @JsonProperty
     public abstract String field();
 
@@ -72,6 +78,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract Max autoBuild();

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Min.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Min.NAME)
 @JsonDeserialize(builder = Min.Builder.class)
-public abstract class Min implements SeriesSpec, HasField {
+public abstract class Min implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "min";
 
     @Override
@@ -39,6 +42,9 @@ public abstract class Min implements SeriesSpec, HasField {
     @Override
     public abstract String id();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @JsonProperty
     public abstract String field();
 
@@ -72,6 +78,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract Min autoBuild();

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Percentage.java

@@ -23,6 +23,8 @@
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
 import javax.annotation.Nullable;
@@ -31,7 +33,7 @@
 @AutoValue
 @JsonTypeName(Percentage.NAME)
 @JsonDeserialize(builder = Percentage.Builder.class)
-public abstract class Percentage implements SeriesSpec, HasOptionalField {
+public abstract class Percentage implements SeriesSpec, HasOptionalField, MayHaveUnit {
     public static final String NAME = "percentage";
 
     public enum Strategy {
@@ -45,6 +47,10 @@ public enum Strategy {
     @Override
     public abstract String id();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
+
     @JsonProperty
     public abstract Optional<Strategy> strategy();
 
@@ -64,7 +70,9 @@ public Percentage withId(String id) {
     }
 
     public static Builder builder() {
-        return new AutoValue_Percentage.Builder().type(Percentage.NAME);
+        return new AutoValue_Percentage.Builder()
+                .unit(new UnitId("percent", "%"))
+                .type(Percentage.NAME);
     }
 
     @AutoValue.Builder
@@ -84,6 +92,9 @@ public static Builder create() {
 
         public abstract Builder field(@Nullable String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         @JsonProperty("field")
         public Builder nonEmptyField(@Nullable String field) {
             return field(Strings.emptyToNull(field));

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Percentile.java

@@ -21,15 +21,18 @@
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Percentile.NAME)
 @JsonDeserialize(builder = Percentile.Builder.class)
-public abstract class Percentile implements SeriesSpec, HasField {
+public abstract class Percentile implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "percentile";
 
     @Override
@@ -41,6 +44,9 @@ public abstract class Percentile implements SeriesSpec, HasField {
     @JsonProperty
     public abstract String field();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @JsonProperty
     public abstract Double percentile();
 
@@ -77,6 +83,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder percentile(Double percentile);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract Double percentile();

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/StdDev.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(StdDev.NAME)
 @JsonDeserialize(builder = StdDev.Builder.class)
-public abstract class StdDev implements SeriesSpec, HasField {
+public abstract class StdDev implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "stddev";
 
     @Override
@@ -42,6 +45,9 @@ public abstract class StdDev implements SeriesSpec, HasField {
     @JsonProperty
     public abstract String field();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @Override
     public Optional<String> statsSubfieldName() {
         return Optional.of("std_deviation");
@@ -77,6 +83,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract StdDev autoBuild();

graylog2-server/src/main/java/org/graylog/plugins/views/search/searchtypes/pivot/series/Sum.java

@@ -22,15 +22,18 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.google.auto.value.AutoValue;
 import com.google.common.base.Strings;
+import org.graylog.plugins.formatting.units.model.UnitId;
 import org.graylog.plugins.views.search.searchtypes.pivot.HasField;
+import org.graylog.plugins.views.search.searchtypes.pivot.MayHaveUnit;
 import org.graylog.plugins.views.search.searchtypes.pivot.SeriesSpec;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 @AutoValue
 @JsonTypeName(Sum.NAME)
 @JsonDeserialize(builder = Sum.Builder.class)
-public abstract class Sum implements SeriesSpec, HasField {
+public abstract class Sum implements SeriesSpec, HasField, MayHaveUnit {
     public static final String NAME = "sum";
 
     @Override
@@ -42,6 +45,9 @@ public abstract class Sum implements SeriesSpec, HasField {
     @JsonProperty
     public abstract String field();
 
+    @Override
+    public abstract Optional<UnitId> unit();
+
     @Override
     public String literal() {
         return type() + "(" + Strings.nullToEmpty(field()) + ")";
@@ -72,6 +78,9 @@ public static Builder create() {
         @JsonProperty
         public abstract Builder field(String field);
 
+        @JsonProperty
+        public abstract Builder unit(@Nullable UnitId unit);
+
         abstract Optional<String> id();
         abstract String field();
         abstract Sum autoBuild();