Grafana
Interagiere mit Grafana-Dashboards, Alarmen und Anmerkungen
Grafana ist eine führende Open-Source-Plattform für Monitoring, Observability und Visualisierung. Sie ermöglicht Benutzern, Daten aus verschiedenen Quellen abzufragen, zu visualisieren, zu überwachen und zu analysieren, was sie zu einem wesentlichen Werkzeug für Infrastruktur- und Anwendungsmonitoring macht.
Mit Grafana kannst du:
- Daten visualisieren: Dashboards erstellen und anpassen, um Metriken, Logs und Traces in Echtzeit anzuzeigen
- Gesundheit und Status überwachen: Den Zustand deiner Grafana-Instanz und verbundener Datenquellen überprüfen
- Alarme und Anmerkungen verwalten: Alarmregeln einrichten, Benachrichtigungen verwalten und Dashboards mit wichtigen Ereignissen versehen
- Inhalte organisieren: Dashboards und Datenquellen in Ordnern organisieren für besseres Zugriffsmanagement
In Sim ermöglicht die Grafana-Integration deinen Agenten, direkt über die API mit deiner Grafana-Instanz zu interagieren, was Aktionen wie folgende ermöglicht:
- Überprüfung des Gesundheitsstatus von Grafana-Server, Datenbank und Datenquellen
- Abrufen, Auflisten und Verwalten von Dashboards, Alarmregeln, Anmerkungen, Datenquellen und Ordnern
- Automatisierung der Überwachung deiner Infrastruktur durch Integration von Grafana-Daten und Alarmen in deine Workflow-Automatisierungen
Diese Fähigkeiten ermöglichen es Sim-Agenten, Systeme zu überwachen, proaktiv auf Alarme zu reagieren und die Zuverlässigkeit und Sichtbarkeit deiner Dienste zu gewährleisten – alles als Teil deiner automatisierten Workflows.
Integriere Grafana in Workflows. Verwalte Dashboards, Alarme, Anmerkungen, Datenquellen, Ordner und überwache den Gesundheitsstatus.
Ein Dashboard anhand seiner UID abrufen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
dashboardUid | string | Ja | Die UID des abzurufenden Dashboards |
| Parameter | Typ | Beschreibung |
|---|
dashboard | json | Das vollständige Dashboard-JSON-Objekt |
meta | json | Dashboard-Metadaten (Version, Berechtigungen usw.) |
Suchen und auflisten aller Dashboards
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
query | string | Nein | Suchanfrage zum Filtern von Dashboards nach Titel |
tag | string | Nein | Nach Tag filtern (kommagetrennt für mehrere Tags) |
folderIds | string | Nein | Nach Ordner-IDs filtern (kommagetrennt) |
starred | boolean | Nein | Nur mit Stern markierte Dashboards zurückgeben |
limit | number | Nein | Maximale Anzahl der zurückzugebenden Dashboards |
| Parameter | Typ | Beschreibung |
|---|
dashboards | array | Liste der Dashboard-Suchergebnisse |
Ein neues Dashboard erstellen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
title | string | Ja | Der Titel des neuen Dashboards |
folderUid | string | Nein | Die UID des Ordners, in dem das Dashboard erstellt werden soll |
tags | string | Nein | Kommagetrennte Liste von Tags |
timezone | string | Nein | Dashboard-Zeitzone (z.B. browser, utc) |
refresh | string | Nein | Auto-Aktualisierungsintervall (z.B. 5s, 1m, 5m) |
panels | string | Nein | JSON-Array von Panel-Konfigurationen |
overwrite | boolean | Nein | Vorhandenes Dashboard mit gleichem Titel überschreiben |
message | string | Nein | Commit-Nachricht für die Dashboard-Version |
| Parameter | Type | Beschreibung |
|---|
id | number | Die numerische ID des erstellten Dashboards |
uid | string | Die UID des erstellten Dashboards |
url | string | Der URL-Pfad zum Dashboard |
status | string | Status der Operation (success) |
version | number | Die Versionsnummer des Dashboards |
slug | string | URL-freundlicher Slug des Dashboards |
Aktualisiert ein bestehendes Dashboard. Ruft das aktuelle Dashboard ab und führt Ihre Änderungen zusammen.
| Parameter | Type | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
dashboardUid | string | Ja | Die UID des zu aktualisierenden Dashboards |
title | string | Nein | Neuer Titel für das Dashboard |
folderUid | string | Nein | Neue Ordner-UID, um das Dashboard zu verschieben |
tags | string | Nein | Kommagetrennte Liste neuer Tags |
timezone | string | Nein | Dashboard-Zeitzone (z.B. browser, utc) |
refresh | string | Nein | Auto-Refresh-Intervall (z.B. 5s, 1m, 5m) |
panels | string | Nein | JSON-Array von Panel-Konfigurationen |
overwrite | boolean | Nein | Überschreiben auch bei Versionskonflikten |
message | string | Nein | Commit-Nachricht für diese Version |
| Parameter | Typ | Beschreibung |
|---|
id | number | Die numerische ID des aktualisierten Dashboards |
uid | string | Die UID des aktualisierten Dashboards |
url | string | Der URL-Pfad zum Dashboard |
status | string | Status der Operation (success) |
version | number | Die neue Versionsnummer des Dashboards |
slug | string | URL-freundlicher Slug des Dashboards |
Löschen eines Dashboards anhand seiner UID
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
dashboardUid | string | Ja | Die UID des zu löschenden Dashboards |
| Parameter | Typ | Beschreibung |
|---|
title | string | Der Titel des gelöschten Dashboards |
message | string | Bestätigungsnachricht |
id | number | Die ID des gelöschten Dashboards |
Alle Alarmregeln in der Grafana-Instanz auflisten
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
| Parameter | Typ | Beschreibung |
|---|
rules | array | Liste der Alarmregeln |
Eine bestimmte Alarmregel anhand ihrer UID abrufen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
alertRuleUid | string | Ja | Die UID der abzurufenden Alarmregel |
| Parameter | Typ | Beschreibung |
|---|
uid | string | Alarmregel-UID |
title | string | Alarmregel-Titel |
condition | string | Alarmbedingung |
data | json | Alarmregel-Abfragedaten |
folderUID | string | Übergeordnete Ordner-UID |
ruleGroup | string | Regelgruppenname |
noDataState | string | Status, wenn keine Daten zurückgegeben werden |
execErrState | string | Status bei Ausführungsfehler |
annotations | json | Alarmanmerkungen |
labels | json | Alarmlabels |
Eine neue Alarmregel erstellen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
title | string | Ja | Der Titel der Alarmregel |
folderUid | string | Ja | Die UID des Ordners, in dem der Alarm erstellt werden soll |
ruleGroup | string | Ja | Der Name der Regelgruppe |
condition | string | Ja | Die refId der Abfrage oder des Ausdrucks, der als Alarmbedingung verwendet werden soll |
data | string | Ja | JSON-Array von Abfrage-/Ausdrucksdatenobjekten |
forDuration | string | Nein | Wartezeit vor dem Auslösen (z.B. 5m, 1h) |
noDataState | string | Nein | Status, wenn keine Daten zurückgegeben werden (NoData, Alerting, OK) |
execErrState | string | Nein | Status bei Ausführungsfehler (Alerting, OK) |
annotations | string | Nein | JSON-Objekt von Anmerkungen |
labels | string | Nein | JSON-Objekt von Labels |
| Parameter | Typ | Beschreibung |
|---|
uid | string | Die UID der erstellten Alarmregel |
title | string | Titel der Alarmregel |
folderUID | string | UID des übergeordneten Ordners |
ruleGroup | string | Name der Regelgruppe |
Aktualisiert eine bestehende Alarmregel. Ruft die aktuelle Regel ab und führt Ihre Änderungen zusammen.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service-Account-Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
alertRuleUid | string | Ja | Die UID der zu aktualisierenden Alarmregel |
title | string | Nein | Neuer Titel für die Alarmregel |
folderUid | string | Nein | Neue Ordner-UID, um den Alarm zu verschieben |
ruleGroup | string | Nein | Neuer Name der Regelgruppe |
condition | string | Nein | Neue Bedingung refId |
data | string | Nein | Neues JSON-Array von Abfrage-/Ausdrucksdatenobjekten |
forDuration | string | Nein | Wartezeit vor dem Auslösen (z.B. 5m, 1h) |
noDataState | string | Nein | Status, wenn keine Daten zurückgegeben werden (NoData, Alerting, OK) |
execErrState | string | Nein | Status bei Ausführungsfehler (Alerting, OK) |
annotations | string | Nein | JSON-Objekt von Anmerkungen |
labels | string | Nein | JSON-Objekt von Labels |
| Parameter | Typ | Beschreibung |
|---|
uid | string | Die UID der aktualisierten Alarmregel |
title | string | Titel der Alarmregel |
folderUID | string | UID des übergeordneten Ordners |
ruleGroup | string | Name der Regelgruppe |
Löschen einer Alarmregel anhand ihrer UID
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service-Account-Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
alertRuleUid | string | Ja | Die UID der zu löschenden Alarmregel |
| Parameter | Typ | Beschreibung |
|---|
message | string | Bestätigungsnachricht |
Alle Alarmbenachrichtigungs-Kontaktpunkte auflisten
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service-Account-Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
| Parameter | Typ | Beschreibung |
|---|
contactPoints | array | Liste der Kontaktpunkte |
Eine Anmerkung auf einem Dashboard oder als globale Anmerkung erstellen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
text | string | Ja | Der Textinhalt der Anmerkung |
tags | string | Nein | Kommagetrennte Liste von Tags |
dashboardUid | string | Nein | UID des Dashboards, zu dem die Anmerkung hinzugefügt werden soll (optional für globale Anmerkungen) |
panelId | number | Nein | ID des Panels, zu dem die Anmerkung hinzugefügt werden soll |
time | number | Nein | Startzeit in Epochenmillisekunden (standardmäßig jetzt) |
timeEnd | number | Nein | Endzeit in Epochenmillisekunden (für Bereichsanmerkungen) |
| Parameter | Typ | Beschreibung |
|---|
id | number | Die ID der erstellten Anmerkung |
message | string | Bestätigungsnachricht |
Anmerkungen nach Zeitraum, Dashboard oder Tags abfragen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
from | number | Nein | Startzeit in Epochenmillisekunden |
to | number | Nein | Endzeit in Epochenmillisekunden |
dashboardUid | string | Nein | Nach Dashboard-UID filtern |
panelId | number | Nein | Nach Panel-ID filtern |
tags | string | Nein | Kommagetrennte Liste von Tags, nach denen gefiltert werden soll |
type | string | Nein | Nach Typ filtern (alert oder annotation) |
limit | number | Nein | Maximale Anzahl von zurückzugebenden Anmerkungen |
| Parameter | Typ | Beschreibung |
|---|
annotations | array | Liste der Anmerkungen |
Eine vorhandene Anmerkung aktualisieren
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service-Account-Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
annotationId | number | Ja | Die ID der zu aktualisierenden Anmerkung |
text | string | Ja | Neuer Textinhalt für die Anmerkung |
tags | string | Nein | Kommagetrennte Liste neuer Tags |
time | number | Nein | Neue Startzeit in Epochenmillisekunden |
timeEnd | number | Nein | Neue Endzeit in Epochenmillisekunden |
| Parameter | Typ | Beschreibung |
|---|
id | number | Die ID der aktualisierten Anmerkung |
message | string | Bestätigungsnachricht |
Eine Anmerkung anhand ihrer ID löschen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service-Account-Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
annotationId | number | Ja | Die ID der zu löschenden Anmerkung |
| Parameter | Type | Beschreibung |
|---|
message | string | Bestätigungsnachricht |
Alle in Grafana konfigurierten Datenquellen auflisten
| Parameter | Type | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
| Parameter | Type | Beschreibung |
|---|
dataSources | array | Liste der Datenquellen |
Eine Datenquelle anhand ihrer ID oder UID abrufen
| Parameter | Type | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
dataSourceId | string | Ja | Die ID oder UID der abzurufenden Datenquelle |
| Parameter | Type | Beschreibung |
|---|
id | number | Datenquellen-ID |
uid | string | Datenquellen-UID |
name | string | Name der Datenquelle |
type | string | Typ der Datenquelle |
url | string | Verbindungs-URL der Datenquelle |
database | string | Datenbankname (falls zutreffend) |
isDefault | boolean | Ob dies die Standard-Datenquelle ist |
jsonData | json | Zusätzliche Konfiguration der Datenquelle |
Alle Ordner in Grafana auflisten
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Grafana-Instanzen mit mehreren Organisationen |
limit | number | Nein | Maximale Anzahl der zurückzugebenden Ordner |
page | number | Nein | Seitennummer für Paginierung |
| Parameter | Typ | Beschreibung |
|---|
folders | array | Liste der Ordner |
Einen neuen Ordner in Grafana erstellen
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
apiKey | string | Ja | Grafana Service Account Token |
baseUrl | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com\) |
organizationId | string | Nein | Organisations-ID für Grafana-Instanzen mit mehreren Organisationen |
title | string | Ja | Der Titel des neuen Ordners |
uid | string | Nein | Optionale UID für den Ordner (wird automatisch generiert, wenn nicht angegeben) |
| Parameter | Typ | Beschreibung |
|---|
id | number | Die numerische ID des erstellten Ordners |
uid | string | Die UID des erstellten Ordners |
title | string | Der Titel des erstellten Ordners |
url | string | Der URL-Pfad zum Ordner |
- Kategorie:
tools
- Typ:
grafana
