CircleCI verbessert den Einblick und lässt Insights in die API einfließen

Das kalifornische Softwareunternehmen CircleCI hat den Insight-Dienst in die Ende 2019 vorgestellte API v2 integriert. Damit sollen Kunden künftig Daten auch in ihre eigenen Dashboards überführen können und seien nicht mehr an das hauseigene Dashboard des Continuous-Delivery-Anbieters gebunden. Mit dem Release der vier neuen Endpunkte habe die Schnittstelle für den Dienst nun einen stabilen Stand und die Produktionsreife erreicht.

CircleCI hatte sich nach eigener Auskunft bewusst für die Weiterentwicklung der Schnittstelle entschieden, statt das eigene Dashboard zu überarbeiten, und hatte Version 2 der API im Dezember 2019 erstmals vorgestellt. Die API-Endpunkte waren in den vergangenen Monaten in den Previews enthalten. Das Unternehmen geht davon aus, dass Entwickler und Administratoren zunehmend ihre eigenen Dashboards verwenden möchten.

Vier neue Endpunkte für feingranulare und aggregierte Einblicke

Bei den vier präsentierten Endpunkten handelt es sich um zwei feingranulare und zwei aggregierte Neuerungen. Nutzer können jetzt basierend auf den Messungen von CircleCI Insights ihren Guthabenverbrauch in der Cloud und die Dauer von Prozessen in eigene Dashboards überführen, und zwar auf der Ebene von Workflows sowie wahlweise auch auf der Ebene einzelner Jobs. Zum Aufruf dient folgender Code:

GET https://circleci.com/api/v2/insights/{project-slug}/workflows  
GET https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}/jobs

Damit lassen sich aggregierte Daten für Projekte und Workflows unter anderem mit Feldern für Name, Start und Ende des Aggregationsfensters, und die Erfolgsquote abrufen. Mit folgendem Befehl lassen sich die Ausführungsdaten von Aufträgen und Workflows der letzten 250 Durchläufe bzw. der letzten 90 Tage innerhalb eines ausgewählten Projektarms anzeigen:

GET https://circleci.com/api/v2/insights/{project slug}/workflows/{workflow-name}
GET https://circleci.com/api/v2/insights/{project slug}/workflows/{workflow-name}/jobs/{job-name}

Die Ausgabe enthält Angaben zu ID, Status, verwendetem Guthaben, der Dauer in Sekunden, dem Erstellungsdatum und dem Enddatum.

Hintergrund zu CircleCI

CircleCIs Dienst ermöglicht es, den Workflow in der Pipeline bei der Softwareentwicklung als Ganzes zu überwachen und Schwachstellen zu identifizieren sowie anstehende Änderungen zu priorisieren. Die Anwendungen von CircleCI messen und dokumentieren Erfolgsraten, Gesamtdurchsatz der fehlgeschlagenen Läufe und die Zeit bis zur Wiederherstellung. Integriert ist auch ein Tool zum Überwachen und Planen des verbrauchten Datenvolumens in der Cloud, das laut Anbieter beim Kalkulieren der Kosten behilflich sein soll. Die Dienste dokumentieren die Dauer einzelner Prozesse und sollen dabei unterstützen, Arbeitsabläufe der Softwareentwicklung im Bereich CI/CD (Continuous Integration/ Continuous Delivery) zu beschleunigen.

Mehr Details zu den neuen Endpunkten der API v2 lassen sich der Dokumentation entnehmen. Die volle Ankündigung zur Produktionsreife befindet sich im Blogeintrag von CircleCI. Die erste Ankündigung der API v2 steht ebenfalls in dem Blog. (sih)