USC/Api-Keys: Unterschied zwischen den Versionen

Version vom 23. August 2023, 17:39 Uhr

API Keys für UTM Monitoring nutzen

Letzte Anpassung: 08.2023

Neu:

Der Wert für scrape_timeout in der Prometheus Beispiel Konfiguration wurde auf 30s erhöht
Der Wert für scrape_interval in der Prometheus Beispiel Konfiguration wurde auf 60s erhöht
Bestehendes Dashboard-Beispiel aktualisiert 07.2023
Neues Dashboard-Beispiele ergänzt 07.2023

notempty

Dieser Artikel bezieht sich auf eine Resellerpreview

Funktionsumfang

API Keys im USC Portal

API Keys ermöglichen für andere Anwendungen eine Authentifizierung im USC Portal.
Dabei haben die API Keys einen festgelegten Geltungsbereich der z.Zt. ausschließlich Metriken für ein Monitoring umfasst.

API Key hinzufügen

Beschriftung	Wert	Beschreibung
		Aussagekräftiger Name für den API-Key
Mandanten		Mandanten, für die die API Werte ausgibt. Wird kein Mandant angegeben, werden Werte für sämtliche Mandanten und den Reseller selbst ausgegeben! Dieses Feld kann nachträglich nicht geändert werden
Geltungsbereich		Geltungsbereich für den API-Key. Z.Zt. ausschließlich Metrics verfügbar Dieses Feld kann nachträglich nicht geändert werden
Ablaufdatum	Wählen Sie ein Datum	Es muss ein Ablaufdatum gewählt werden. Soll die Geltungsdauer später geändert werden, ist es lediglich möglich, den API-Key zu löschen. Dieses Feld kann nachträglich nicht geändert werden
Kommentar		Freies Textfeld
Speichern	Legt den API-Key an und schließt den Dialog. Die Werte für Mandanten, Geltungsbereich und Ablaufdatum können anschließend nicht mehr geändert werden.

In Zwischenablage kopieren Kopiert den API Key in die Zwischenablage. Von hier kann er in andere Anwendungen eingefügt werden.

Anwendungsbeispiel

Hinweis
Dieser Abschnitt beinhaltet Beschreibungen der Software von Drittanbietern und basiert auf dem Stand zum Zeitpunkt der Erstellung dieser Seite.
Änderungen an der Benutzeroberfläche durch den Hersteller sind jederzeit möglich und müssen in der Durchführung entsprechend berücksichtigt werden.
Alle Angaben ohne Gewähr.

Das folgende Beispiel setzt eine funktionsfähige Installation folgender Produkte voraus:

Linux VM
Prometheus (Opensource Monitroing)
Grafana (Open-Source-Anwendung zur grafischen Darstellung von Daten)
ngninx (Webserver)

notempty

Keine Unterstützung durch unseren Support für Fremdprodukte
Wir leisten keinerlei Support für diese Anwendungen und können keine Unterstützung für Installation oder Konfiguration geben.
Es werden hier lediglich Anwendungs-Szenarien für API Keys gezeigt.

Prometheus Konfiguration bearbeiten

Öffnen der Konfigurationsdatei von Prometheus z. B. mit Editor nano sudo nano /etc/prometheus/prometheus.yml

Abschnitt scrape_configs: scrape_configs: # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config. - job_name: 'securepoint_cloud_metrics' scrape_interval: 60s # Do not edit scrape_timeout: 30s metrics_path: /sms-mgt-api/api/2.0/metrics scheme: https bearer_token: 'eyJhbGciOiJIUzI1NiIsInR5...' static_configs: - targets: - portal.securepoint.cloud

Als bearer_token wird der Wert des API Keys (mit Hochkommata) eingetragen.

Anschließend Konfiguration speichern und den Dienst neu starten. sudo systemctl restart prometheus

Der Befehl sudo systemctl status prometheus.service zeigt, ob der Dienst korrekt starten konnte.

‍

Ein Aufruf der Prometheus-Seite im Menü Status / Targets im Browser sollte ein Ergebnis ähnlich dem nebenstehend gezeigten bieten.

Grafana Konfiguration

Datenquelle hinzufügen

Aufruf von Grafana im Webbrowser
Im Seitenmenü: Connections
‍
In älteren Versionen Burger Menü oben links
Menüpunkt Data soures
Schaltfläche: Add new data source
Prometheus wählen
URL des Prometheus-Servers mit Port angeben, z.B.: http://localhost:9090
Speichern mit Save & test

Grafana Dashboard konfigurieren

Beispiel 1

in der Menüleiste
Schaltfläche Import

Schaltfläche Load
Datenquelle wählen: Select a Prometheus data source
Schaltfläche Import

Beispiel 2

in der Menüleiste
Schaltfläche Import

Schaltfläche Load
Datenquelle wählen: Select a Prometheus data source
Schaltfläche Import

@@ Zeile 6: / Zeile 6: @@
 {{var	| neu--Beispiel1
 		| Bestehendes Dashboard-Beispiel aktualisiert
-		|  }}
+		| Existing dashboard examples updated }}
 {{var	| neu--Beispiel2
 		| Neues Dashboard-Beispiele ergänzt
-		|  }}
+		| New dashboard examples added }}
+{{var	| neu--timeout
+		| Der Wert für {{code|scrape_timeout}} in der [[#Prometheus_Konfiguration_bearbeiten | Prometheus Beispiel Konfiguration]] wurde auf 30s erhöht
+		| The value for {{code|scrape_timeout}} in the [[#Prometheus_Konfiguration_bearbeiten | Prometheus sample configuration]] was increased to 30s }}
+{{var	| neu--refresh
+		| Der Wert für {{code|scrape_interval}} in der [[#Prometheus_Konfiguration_bearbeiten | Prometheus Beispiel Konfiguration]] wurde auf 60s erhöht
+		| The value for {{code|scrape_timeout}} in the [[#Prometheus_Konfiguration_bearbeiten | Prometheus sample configuration]] was increased to 60s }}
-</div>{{TOC2}}{{Select_lang}}{{Header|07.2023|
-* {{#var:neu--Beispiel1}}
+</div>{{TOC2}}{{Select_lang}}{{Header|08.2023|
-* {{#var:neu--Beispiel2}}
+* {{#var:neu--timeout}}
+* {{#var:neu--refresh}}
+* {{#var:neu--Beispiel1}} <small>07.2023</small>
+* {{#var:neu--Beispiel2}} <small>07.2023</small>
 || {{Menu|list-allgemein||key|API Keys}} }}
@@ Zeile 62: / Zeile 71: @@
     # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
     - job_name: 'securepoint_cloud_metrics'
-      scrape_interval: 30s # Do not edit
+      scrape_interval: 60s # Do not edit
-      scrape_timeout: 10s
+      scrape_timeout: 30s
       metrics_path: /sms-mgt-api/api/2.0/metrics
       scheme: https
@@ Zeile 71: / Zeile 80: @@
         - portal.securepoint.cloud
 </nowiki></span><br clear=all>
-<li class="ist--element__alert list--element__hint"><{{#var:Bearer-Token--desc}}/li>
+<li class="list--element__alert list--element__hint">{{#var:Bearer-Token--desc}}</li>
 <br clear=all>