Metriken verstehen

Gilt für die CoCoCo-Plattform v1.0.0-rc.31. Das Senden einer Metrik über MQTT und ihre Anzeige wurden auf dieser Version ausgeführt.

Was sind Metriken?

Eine Metrik ist eine Zeitreihe von Zahlenwerten, die zu einem Gerät gehört, zum Beispiel eine Temperatur, eine Geschwindigkeit oder ein Zähler. Jede Metrik hat einen Namen, eine Art und eine Einheit. Die Art heißt in der Nutzlast GAUGE, COUNTER, STATUS oder RATE; die Metrikseite zeigt sie mit deutschem Namen, eine Gauge etwa als Messgerät. Schickt ein Gerät einen Datenpunkt unter einem Namen, den es noch nicht benutzt hat, legt CoCoCo die Metrik automatisch an.

Metriken über MQTT senden

Bevor du anfängst: Das Gerät braucht ein MQTT-Protokoll und einen Geräte-Token (siehe Geräte-Tokens erstellen und verwalten).

1. Verbinde dich mit der MQTT URL aus dem Token-Dialog, weise dich mit Client certificate und Client key aus und vertraue der Server CA. Der Broker nimmt nur Verbindungen mit Zertifikat an.
2. Nutze die Suggested client ID aus dem Token-Dialog als MQTT-Client-ID.
3. Sende an das Topic s/metrics. Die Nutzlast ist ein Stapel aus einem oder mehreren Punkten:

{
  "points": [
    {
      "name": "temperature",
      "value": 21.5,
      "kind": "GAUGE",
      "unit": "CELSIUS",
      "tags": { "location": "hall-1" },
      "displayName": "Temperature"
    }
  ]
}

Feld
name	Pflicht — kennzeichnet die Metrik an diesem Gerät
value	Pflicht — eine endliche Zahl
kind	optional — GAUGE, COUNTER, STATUS oder RATE; nur beim Anlegen der Metrik benutzt; Standard GAUGE
unit	optional — zum Beispiel CELSIUS, PERCENT oder COUNT; nur beim Anlegen benutzt; Standard NONE. Für eine Einheit, die nicht in der Liste steht, etwa Bogen, CUSTOM verwenden
customUnit	optional — der Name der Einheit, wenn unit CUSTOM ist, zum Beispiel Bogen
tags	optional — Schlüssel-Wert-Paare zum Punkt; jeder Wert muss Text sein
timestamp	optional — ISO 8601; Standard ist der Eingangszeitpunkt
displayName	optional — lesbarer Name; nur beim Anlegen benutzt

Schreibe kind und unit in Großbuchstaben, verwende nur die vorgesehenen Werte und sende jeden Tag-Wert als Text. Eine Nachricht darf bis zu 10.000 Punkte enthalten.

Ein neuer Datenpunkt kann ein paar Sekunden brauchen, bis er erscheint.

Metriken ansehen

1. Klicke in der Seitenleiste unter IoT auf Metriken.
2. Klicke auf eine Metrik. Ihre Seite zeigt Art, Anzahl der Datenpunkte, das Gerät (Device) und ein Diagramm Zeitreihe. Den Zeitraum wählst du mit 1h, 6h, 24h, 7d, 30d oder all; beim Öffnen ist 24h gewählt. Unter dem Diagramm listet Aktuelle Datenpunkte die letzten Werte.

Für die Metrikliste brauchst du die Berechtigung, Metriken aufzulisten (metric:list).

Hinweis: Einzelne Beschriftungen der Metrikseite, etwa Device und all, sind in dieser Version auch bei deutscher Oberfläche englisch. Die Anleitung nennt die Texte so, wie sie auf dem Bildschirm stehen.