Add support for custom metrics (#1513)

* Add support for custom metrics

* Fix case where no firmware metadata exist and kills health header component

Author: elinol

lib/nerves_hub/devices/metrics.ex

@@ -4,7 +4,7 @@ defmodule NervesHub.Devices.Metrics do
   alias NervesHub.Devices.DeviceMetric
   alias NervesHub.Repo
 
-  @metric_types [
+  @default_metric_types [
     :cpu_temp,
     :load_15min,
     :load_1min,
@@ -14,7 +14,7 @@ defmodule NervesHub.Devices.Metrics do
     :used_percent
   ]
 
-  def metric_types, do: @metric_types
+  def default_metric_types, do: @default_metric_types
 
   @doc """
   Get all metrics for device
@@ -60,6 +60,27 @@ defmodule NervesHub.Devices.Metrics do
     |> Repo.all()
   end
 
+  def get_custom_metrics_for_device(device_id) do
+    default_metrics = Enum.map(@default_metric_types, &Atom.to_string/1)
+
+    DeviceMetric
+    |> where(device_id: ^device_id)
+    |> where([dm], dm.key not in ^default_metrics)
+    |> order_by(asc: :inserted_at)
+    |> Repo.all()
+  end
+
+  def get_custom_metrics_for_device(device_id, {time_unit, amount}) do
+    default_metrics = Enum.map(@default_metric_types, &Atom.to_string/1)
+
+    DeviceMetric
+    |> where(device_id: ^device_id)
+    |> where([dm], dm.key not in ^default_metrics)
+    |> where([d], d.inserted_at > ago(^amount, ^time_unit))
+    |> order_by(asc: :inserted_at)
+    |> Repo.all()
+  end
+
   def get_product_metrics_by_key(product_id, key) do
     DeviceMetric
     |> join(:left, [dm], d in assoc(dm, :device))
@@ -115,7 +136,7 @@ defmodule NervesHub.Devices.Metrics do
   Get map with latest values for all metric types. Also includes timestamp.
   """
   def get_latest_metric_set_for_device(device_id) do
-    @metric_types
+    @default_metric_types
     |> Enum.reduce(%{}, fn type, acc ->
       Map.put(acc, type, get_latest_value(device_id, Atom.to_string(type)))
     end)

lib/nerves_hub_web/components/device_health/health_header.ex

@@ -70,7 +70,7 @@ defmodule NervesHubWeb.Components.HealthHeader do
           </span>
         </div>
         <p>
-          <span :if={!@latest_health}>Never</span>
+          <span :if={!@latest_health.timestamp}>Never</span>
           <time
             :if={@latest_health.timestamp}
             id="last-reported-at"
@@ -93,7 +93,7 @@ defmodule NervesHubWeb.Components.HealthHeader do
       </div>
       <div>
         <div class="help-text mb-1">Platform</div>
-        <%= if is_nil(@device.firmware_metadata.platform) do %>
+        <%= if is_nil(@device.firmware_metadata) do %>
           <p>Unknown</p>
         <% else %>
           <p class="badge ff-m mt-0">

lib/nerves_hub_web/live/devices/device_health.ex

@@ -133,15 +133,49 @@ defmodule NervesHubWeb.Live.Devices.DeviceHealth do
       ) do
     latest_metrics = Metrics.get_latest_metric_set_for_device(device.id)
 
-    # Create graphs for metric types and assign to socket
-    Metrics.metric_types()
+    # Create graphs for default metric types and assign to socket
+    Metrics.default_metric_types()
     |> Enum.reduce(socket, fn type, socket ->
       graph =
         create_graph_for_type(device.id, type, chart_type, time_frame, latest_metrics.size_mb)
 
       socket |> assign(type, graph)
     end)
     |> assign(:latest_metrics, latest_metrics)
+    |> assign_custom_metrics()
+  end
+
+  def assign_custom_metrics(
+        %{
+          assigns: %{
+            device: device,
+            chart_type: chart_type,
+            time_frame: time_frame
+          }
+        } =
+          socket
+      ) do
+    custom_metrics =
+      device.id
+      |> Metrics.get_custom_metrics_for_device(time_frame)
+      |> Enum.group_by(& &1.key)
+      |> Enum.map(fn {key, metrics} ->
+        title =
+          key
+          |> String.replace("_", " ")
+          |> String.capitalize()
+
+        max_size = get_custom_max_value(metrics)
+
+        graph =
+          metrics
+          |> organize_metrics_for_contex()
+          |> create_chart(chart_type, max_size, time_frame)
+
+        %{title: title, graph: graph}
+      end)
+
+    socket |> assign(:custom_metrics, custom_metrics)
   end
 
   def create_graph_for_type(device_id, metric_type, chart_type, time_frame, memory_size) do
@@ -182,6 +216,12 @@ defmodule NervesHubWeb.Live.Devices.DeviceHealth do
     |> max(1)
   end
 
+  defp get_custom_max_value(data) do
+    data
+    |> Enum.max_by(& &1.value)
+    |> Map.get(:value)
+  end
+
   defp create_chart(data, _chart_type, _max_value, _time_unit)
        when data == [],
        do: raw("<p class=\"metrics-text\">No data for selected period</p>")

lib/nerves_hub_web/live/devices/device_health.html.heex

@@ -46,5 +46,9 @@
     <HealthSection.render title="Load Average - 15 min" svg={@load_15min} />
     <HealthSection.render title="CPU Temperature in Celcius" svg={@cpu_temp} />
     <HealthSection.render title="Memory Usage" svg={@used_mb} memory_size={@latest_metrics.size_mb} memory_usage={@latest_metrics.used_percent} />
+
+    <%= for metric <- @custom_metrics do %>
+      <HealthSection.render title={metric.title} svg={metric.graph} />
+    <% end %>
   </div>
 </div>

test/nerves_hub/device_metrics_test.exs

@@ -69,6 +69,23 @@ defmodule NervesHub.DeviceMetricsTest do
       assert [] = Metrics.get_device_metrics_by_key(device.id, "cpu_temp")
     end
 
+    test "get custom metrics for device", %{device: device} do
+      assert {:ok, %DeviceMetric{}} =
+               Metrics.save_metric(%{device_id: device.id, key: "custom_1", value: 12})
+
+      assert {:ok, %DeviceMetric{}} =
+               Metrics.save_metric(%{device_id: device.id, key: "custom_2", value: 13})
+
+      assert {:ok, %DeviceMetric{}} =
+               Metrics.save_metric(%{device_id: device.id, key: "cpu_temp", value: 13})
+
+      custom_metrics =
+        Metrics.get_custom_metrics_for_device(device.id)
+
+      # Should not include metrics with default metrics key
+      assert length(custom_metrics) == 2
+    end
+
     # test "get device metrics within time frame"
   end
 

test/nerves_hub_web/live/devices/health_test.exs

@@ -43,4 +43,23 @@ defmodule NervesHubWeb.Devices.HealthTest do
     |> visit("/org/#{org.name}/#{product.name}/devices/#{device.identifier}/health")
     |> assert_has("svg")
   end
+
+  test "Custom metrics", %{
+    conn: conn,
+    org: org,
+    product: product,
+    device: device
+  } do
+    assert {:ok, _} =
+             Metrics.save_metric(%{device_id: device.id, key: "custom_1", value: 12})
+
+    assert {:ok, _} =
+             Metrics.save_metric(%{device_id: device.id, key: "custom_2", value: 13})
+
+    conn
+    |> visit("/org/#{org.name}/#{product.name}/devices/#{device.identifier}/health")
+    |> assert_has(".help-text", text: "Custom 1")
+    |> assert_has(".help-text", text: "Custom 2")
+    |> assert_has("svg")
+  end
 end