Zum Inhalt springen

API Prometheus Jobs und Targets Observability

Zuletzt aktualisiert am

So erstellen Sie einen Prometheus-Job und ein Target

Abschnitt betitelt „So erstellen Sie einen Prometheus-Job und ein Target“

Sie benötigen Ihre Projekt-ID und die Instanz-ID von STACKIT Observability, um mit der Observability-API zu interagieren.
Beispiel-URL: https://argus.api.eu01.stackit.cloud/v1/projects/[projectId]/instances/[instanceId]/scrapeconfigs
Bitte lesen Sie die offizielle API-Dokumentation für detaillierte Informationen zur erwarteten Anfrage.

Mit dem folgenden HTTP-Message-Body haben Sie die Minimalkonfiguration für einen neuen Job und ein Target:

{
"staticConfigs": [
{
"targets": [
"your-url-which-delivers-your-metrics.com:9100"
]
}
],
"jobName": "Job-1",
"scheme": "http",
"scrapeInterval": "5m",
"scrapeTimeout": "2m",
"metricsPath": "/metrics"
}

Senden Sie diese Anfrage als HTTP-POST-Methode, um Ihren ersten Job und Ihr Target zu konfigurieren.

So ändern Sie einen Prometheus-Job und ein Target

Abschnitt betitelt „So ändern Sie einen Prometheus-Job und ein Target“

Anstelle der HTTP-POST-Methode benötigen wir in diesem Fall HTTP-PATCH, um unseren bestehenden Job und unser Target zu patchen.
Beispiel-URL: https://argus.api.eu01.stackit.cloud/v1/projects/[projectId]/instances/[instanceId]/scrapeconfigs.

Bitte lesen Sie die offizielle API-Dokumentation für detaillierte Informationen zur erwarteten Anfrage.

Mit dem folgenden Body haben Sie die Minimalkonfiguration für einen geänderten Job und ein Target:

{
"staticConfigs": [
{
"targets": [
"your-changed-url-which-delivers-your-metrics.com:9100"
]
}
],
"jobName": "Job-1",
"scheme": "http",
"scrapeInterval": "15m",
"scrapeTimeout": "1m",
"metricsPath": "/metrics"
}

Senden Sie diese PATCH-Anfrage und Ihr Job sowie Ihr Target werden auf die neue URL, auf ein Scrape-Intervall von 15 Minuten und einen Scrape-Timeout von 1 Minute geändert.

Sie müssen den Namen des Jobs, den Sie löschen möchten, in der folgenden URL angeben: https://argus.api.eu01.stackit.cloud/v1/projects/[projectId]/instances/[instanceId]/scrapeconfigs/[jobName].

Anschließend können Sie eine HTTP-DELETE-Anfrage senden.

Bitte lesen Sie die offizielle API-Dokumentation für detaillierte Informationen zur erwarteten Anfrage.

Hierfür können Sie die Delete-Anfrage nicht verwenden, da diese nur zum Löschen eines gesamten Jobs möglich ist. Um ein Target zu löschen, müssen Sie den Job ändern.