Merge pull request #29 from gapitio/Feature/add-search-displayname

Feature/add search displayname

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog for grafana-metric
 
+## v1.1.1 (2022/01/07)
+
+### Features / enhancements
+
+- Check if field contains displayName if name fails [#29](https://github.com/gapitio/grafana-metric/pull/29)
+
 ## v1.1.0 (2021/08/03)
 
 ### Features / enhancements

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gapit/grafana-metric",
   "description": "Retrieves metric value",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.es.js",

src/utils/field.ts

@@ -41,12 +41,14 @@ export function field({
   calcs,
   labels,
   values = [],
+  displayName = null,
 }: {
   name: string;
   type: FieldType;
   calcs?: FieldCalcs;
   labels?: Labels;
   values?: number[];
+  displayName?: string | null;
 }): Field {
   return {
     name,
@@ -61,7 +63,7 @@ export function field({
       toArray: () => values,
     },
     state: {
-      displayName: null,
+      displayName,
       scopedVars: {},
       calcs,
     },

src/utils/getDataFieldsFromName.ts

@@ -27,6 +27,7 @@ function getValueField(
   return series.fields.find((field) =>
     [
       field.name,
+      field.state?.displayName,
       ...(searchLabels && field.labels ? [field.labels.name] : []),
     ].includes(name)
   );

src/utils/metricValue/getMetricValueFromName.test.ts

@@ -42,6 +42,12 @@ window.data = {
           calcs: { [ReducerID.last]: 300 },
           labels: { name: "label-1" },
         }),
+        field({
+          name: "Value",
+          type: FieldType.number,
+          calcs: { [ReducerID.last]: 400 },
+          displayName: "displayName-1",
+        }),
       ],
       length: 1,
     },
@@ -107,6 +113,12 @@ describe("getMetricValueFromName", () => {
     });
   });
 
+  describe("display name", () => {
+    it("gets correct value from display name", () => {
+      expect(getMetricValueFromName("displayName-1")).toEqual(400);
+    });
+  });
+
   describe("missing calcs", () => {
     it("gets correct value from label name", () => {
       expect(getMetricValueFromName("random-value-field")).toEqual(300);