Entwécklung vun engem Plugin fir Grafana: eng Geschicht vu grousse Schëss

Moien alleguer! Virun e puer Méint hu mir eisen neien Open-Source Projet an d'Produktioun lancéiert - de Grafana Plugin fir d'Iwwerwaachung vu Kuberneten, dee mir genannt hunn DevOpsProdigy KubeGraf. De Plugin Quellcode ass verfügbar op ëffentleche Repository op GitHub. An an dësem Artikel wëlle mir mat Iech d'Geschicht deelen wéi mir de Plugin erstallt hunn, wéi eng Tools mir benotzt hunn a wéi eng Falen mir am Entwécklungsprozess begéint hunn. A lass!

Deel 0 - Aféierung: Wéi si mir op dëse Punkt komm?

D'Iddi fir eisen eegene Plugin fir Grafan ze schreiwen ass bei eis zimmlech zoufälleg komm. Eis Firma iwwerwaacht Webprojete vu verschiddene Komplexitéitsniveauen fir méi wéi 10 Joer. Wärend dëser Zäit hu mir eng grouss Quantitéit un Expertise gesammelt, interessant Fäll an Erfarung beim Gebrauch vu verschiddene Iwwerwaachungssystemer. An iergendwann hu mir eis gefrot: "Gëtt et e magescht Instrument fir d'Iwwerwaachung vu Kubernetes, sou datt, wéi se soen, "set et a vergiess et"? Prometheus + Grafana Kombinatioun. A wéi fäerdeg Léisunge fir dëse Stack gëtt et e grousse Set vu verschiddenen Tools: Prometheus-Operateur, eng Rei vu kubernetes-mixin Dashboards, Grafana-kubernetes-App.

De Grafana-kubernetes-App Plugin schéngt déi interessantst Optioun fir eis ze sinn, awer et ass net méi wéi engem Joer ënnerstëtzt ginn an och kann net mat neie Versioune vun Node-Exporter a Kube-State-Metriken funktionnéieren. An iergendwann hu mir décidéiert: "Sollte mir net eis eegen Entscheedung treffen?"

Wéi eng Iddien hu mir decidéiert an eisem Plugin ëmzesetzen:

• Visualiséierung vun der "Applikatiounskaart": praktesch Presentatioun vun Uwendungen am Cluster, gruppéiert no Nummraim, Deployment ...;
• Visualiséierung vu Verbindunge wéi "Deployment - Service (+Ports)".
• Visualiséierung vun der Verdeelung vu Clusterapplikatiounen iwwer Clusternoden.
• Sammlung vu Metriken an Informatioun aus verschiddene Quellen: Prometheus an k8s API Server.
• Iwwerwaachung vu béiden Infrastrukturen Deel (Notzung vun der CPU Zäit, Erënnerung, Disk Subsystem, Netzwierk) an Uwendungslogik - Gesondheetsstatus Pods, Zuel vun verfügbare Repliken, Informatioun iwwer d'Liewer / Bereetschaftstester.

Deel 1: Wat ass e "Grafana Plugin"?

Aus technescher Siicht ass de Plugin fir Grafana e Wénkelkontroller, deen am Grafana Datenverzeichnis (/var/grafana/plugins/ /dist/module.js) a kann als SystemJS Modul geluede ginn. Och an dësem Verzeechnes sollt et eng plugin.json Datei sinn, déi all Meta-Informatioun iwwer Äre Plugin enthält: Numm, Versioun, Plugin-Typ, Linken op de Repository/Site/Lizenz, Ofhängegkeeten, a sou weider.

module.ts

plugin.json

Wéi Dir am Screenshot gesitt, hu mir plugin.type = app spezifizéiert. Well Plugins fir Grafana kënnen vun dräi Aarte sinn:

Kompletéiert: déi allgemeng Aart vu Plugin - et ass e Panel fir all Metrik ze visualiséieren, benotzt fir verschidde Dashboards ze bauen.
Datenquell: Plugin Connector op eng Datenquell (zum Beispill Prometheus-Datenquelle, ClickHouse-Datenquelle, ElasticSearch-Datenquelle).
App: E Plugin deen Iech erlaabt Är eege Frontend-Applikatioun bannent Grafana ze bauen, Är eege HTML Säiten ze kreéieren an manuell op d'Datequelle ze kommen fir verschidden Donnéeën ze visualiséieren. Och Plugins vun aneren Typen (Datenquelle, Panel) a verschidde Dashboards kënnen als Ofhängegkeet benotzt ginn.

Beispill Plugin Ofhängegkeeten mat Typ = App.

Dir kënnt souwuel JavaScript wéi och TypeScript als Programméierungssprooch benotzen (mir hunn et gewielt). Virbereedunge fir Hallo-Welt Plugins vun all Typ Dir kënnt fannen de Link: Dëse Repository enthält eng grouss Zuel vu Starter-Päck (et gëtt souguer en experimentellt Beispill vun engem Plugin am React) mat virinstalléierten a konfiguréierte Builder.

Deel 2: Virbereedung vun der lokaler Ëmwelt

Fir um Plugin ze schaffen, brauche mir natierlech e Kubernetes-Cluster mat all de virinstalléierten Tools: Prometheus, Node-Exporter, Kube-State-Metrics, Grafana. D'Ëmfeld soll séier, einfach an natierlech ageriicht ginn, a fir Hot-Reload ze garantéieren, sollt de Grafana Dateverzeichnis direkt vun der Maschinn vum Entwéckler montéiert ginn.

Déi bequemste Manéier, eiser Meenung no, fir lokal mat kubernetes ze schaffen ass minikube. De nächste Schrëtt ass d'Prometheus + Grafana Kombinatioun mat Prometheus-Operator z'installéieren. IN dësen Artikel De Prozess vun der Installatioun vum Prometheus-Bedreiwer op Minikube gëtt am Detail beschriwwen. Fir Persistenz z'aktivéieren, musst Dir de Parameter setzen Persistenz: wouer an den Charts/grafana/values.yaml Datei, füügt Ären eegene PV a PVC derbäi a spezifizéiert se am Persistence.existingClaim Parameter

Eis lescht Minikube Startskript gesäit esou aus:

minikube start --kubernetes-version=v1.13.4 --memory=4096 --bootstrapper=kubeadm --extra-config=scheduler.address=0.0.0.0 --extra-config=controller-manager.address=0.0.0.0
minikube mount 
/home/sergeisporyshev/Projects/Grafana:/var/grafana --gid=472 --uid=472 --9p-version=9p2000.L

Deel 3: tatsächlech Entwécklung

Objektmodell

Als Virbereedung fir d'Ëmsetzung vum Plugin hu mir beschloss all Basis Kubernetes Entitéiten ze beschreiwen, mat deenen mir a Form vun TypeScript Klassen schaffen: Pod, Deployment, Daemonset, Statefulset, Job, Cronjob, Service, Node, Nummraum. All eenzel vun dëse Klassen ierft aus der gemeinsamer BaseModel Klass, déi beschreift de constructor, destructor, Methode fir Aktualiséierung opgetrueden an Wiessel Visibilitéit. Jiddereng vun de Klassen beschreift nested Relatiounen mat aneren Entitéite, Zum Beispill, eng Lëscht vun pods fir eng Entitéit vun Typ Deployment.

import {Pod} from "./pod";
import {Service} from "./service";
import {BaseModel} from './traits/baseModel';

export class Deployment extends BaseModel{
   pods: Array<Pod>;
   services: Array<Service>;

   constructor(data: any){
       super(data);
       this.pods = [];
       this.services = [];
   }
}

Mat der Hëllef vu Getters a Setzer kënne mir d'Entitéitsmetriken weisen oder setzen déi mir brauchen an enger praktescher a liesbarer Form. Zum Beispill, formatéiert Ausgang vun allocatable CPU Noden:

get cpuAllocatableFormatted(){
   let cpu = this.data.status.allocatable.cpu;
   if(cpu.indexOf('m') > -1){
       cpu = parseInt(cpu)/1000;
   }
   return cpu;
}

Säiten

Eng Lëscht vun all eise Plugin Säiten gëtt ufanks an eisem pluing.json an der Ofhängegkeetssektioun beschriwwen:

Am Block fir all Säit musse mir de PAGE NAME uginn (en gëtt dann an e Slug ëmgewandelt, duerch deen dës Säit zougänglech ass); den Numm vun der Komponent verantwortlech fir d'Operatioun vun dëser Säit (d'Lëscht vun de Komponenten gëtt op module.ts exportéiert); déi d'Benotzerroll uginn fir déi d'Aarbecht mat dëser Säit verfügbar ass an d'Navigatiounsastellunge fir d'Sidebar.

An der Komponent verantwortlech fir d'Operatioun vun der Säit, musse mir TemplateUrl setzen, de Wee an d'HTML-Datei mat Markup laanschtgoen. Bannen am Controller, duerch Ofhängegkeetsinjektioun, kënne mir bis zu 2 wichteg Wénkelservicer zougräifen:

• backendSrv - e Service deen Interaktioun mam Grafana API Server ubitt;
• datasourceSrv - e Service deen lokal Interaktioun mat all Datenquellen ubitt, déi an Ärem Grafana installéiert sinn (zum Beispill d'.getAll() Method - gëtt eng Lëscht vun all installéierten Datequellen zréck; .get( ) - gëtt en Instanzobjekt vun enger spezifescher Datenquell zréck.

Deel 4: Daten Quell

Vun Grafana Siicht, Datasource genee déi selwecht Plugin wéi all déi aner: et huet seng eege Entréen Punkt module.js, et gëtt e Fichier mat Meta Informatiounen plugin.json. Wann Dir e Plugin mat Typ = App entwéckelen, kënne mir souwuel mat existéierende Datequellen interagéieren (zum Beispill, prometheus-datasource) an eis eegen, déi mir direkt am Plugin-Verzeichnis späicheren (dist/datasource/*) oder als Ofhängegkeet installéieren. An eisem Fall kënnt d'Datenquelle mam Plugin Code. Et ass och noutwendeg eng config.html Schabloun an e ConfigCtrl Controller ze hunn, déi fir d'Datenquell Instanz Konfiguratiounssäit an den Datasource Controller benotzt gëtt, deen d'Logik vun Ärer Datequell implementéiert.

Am KubeGraf Plugin, aus der User-Interface Siicht, ass d'Datenquell eng Instanz vun engem kubernetes-Cluster deen déi folgend Fäegkeeten implementéiert (Quellcode ass verfügbar Link):

• sammelen Daten vum k8s api-Server (kréien eng Lëscht vun Nummraim, Deployment ...)
• Proxying Ufroe fir prometheus-Datenquelle (déi an de Plugin-Astellunge fir all spezifesche Cluster ausgewielt gëtt) an d'Formatéierung vun Äntwerte fir Daten souwuel op statesche Säiten an an Dashboards ze benotzen.
• d'Aktualiséierung vun Daten op statesche Plugin Säiten (mat engem festgeluegten Erfrëschungsrate).
• Veraarbechtung vun Ufroen fir e Schablounblat a Grafana-Dashboards ze generéieren (metriFindQuery () Method)

• Verbindung Test mat der Finale k8s Stärekoup.

testDatasource(){
   let url = '/api/v1/namespaces';
   let _url = this.url;
   if(this.accessViaToken)
       _url += '/__proxy';
   _url += url;
   return this.backendSrv.datasourceRequest({
       url: _url,
       method: "GET",
       headers: {"Content-Type": 'application/json'}
   })
       .then(response => {
           if (response.status === 200) {
               return {status: "success", message: "Data source is OK", title: "Success"};
           }else{
               return {status: "error", message: "Data source is not OK", title: "Error"};
           }
       }, error => {
           return {status: "error", message: "Data source is not OK", title: "Error"};
       })
}

En separaten interessante Punkt, eiser Meenung no, ass d'Ëmsetzung vun engem Authentifikatiouns- an Autorisatiounsmechanismus fir d'Datequelle. Typesch, aus der Këscht, kënne mir déi agebaute Grafana Komponent DatasourceHttpSettings benotzen fir den Zougang zu der definitiver Datequell ze konfiguréieren. Mat dëser Komponente kënne mir den Zougang zu der http Datenquell konfiguréieren andeems Dir d'URL an d'Basis Authentifikatioun / Autorisatioun Astellunge spezifizéiert: Login-Passwuert oder Client-cert/client-key. Fir d'Fäegkeet ze realiséieren den Zougang mat engem Bearer Token ze konfiguréieren (de de facto Standard fir k8s), hu mir e bëssen Tweaking misse maachen.

Fir dëse Problem ze léisen, kënnt Dir den agebaute Grafana "Plugin Routes" Mechanismus benotzen (méi Detailer op offiziell Dokumentatioun Säit). An den Astellunge vun eiser Datessource kënne mir eng Rei vu Routingregelen deklaréieren, déi vum Grafana Proxy Server veraarbecht ginn. Zum Beispill, fir all eenzel Endpunkt ass et méiglech Header oder URLen mat der Méiglechkeet vun Template ze setzen, Daten fir déi aus de jsonData a secureJsonData Felder geholl kënne ginn (fir Passwierder oder Tokens a verschlësselte Form ze späicheren). An eisem Beispill, Ufroen wéi /__proxy/api/v1/namespaces gëtt op d'URL vum Formulaire proxéiert
/api/v8/namespaces mat der Autorisatioun: Bearer Header.

Natierlech, fir mam k8s API Server ze schaffen, brauche mir e Benotzer mat nëmmen liesen Zougang, Manifestatiounen fir ze kreéieren déi Dir och fannt Plugin Quellcode.

Deel 5: Fräisetzung

Wann Dir Ären eegene Grafana Plugin geschriwwen hutt, wëllt Dir se natierlech ëffentlech verfügbar maachen. Zu Grafana ass dëst eng Bibliothéik vu Plugins déi hei verfügbar sinn grafana.com/grafana/plugins

Fir datt Äre Plugin am offiziellen Geschäft verfügbar ass, musst Dir e PR maachen dëse Repositoryandeems Dir Inhalt wéi dësen an d'repo.json Datei addéiert:

wou Versioun d'Versioun vun Ärem Plugin ass, URL ass e Link op de Repository, an commit ass den Hash vum Engagement fir deen eng spezifesch Versioun vum Plugin verfügbar ass.

An op der Ausgab gesitt Dir eng wonnerbar Bild wéi:

D'Donnéeën dofir ginn automatesch vun Ärem Readme.md, Changelog.md an der plugin.json Datei mat der Plugin Beschreiwung gegraff.

Deel 6: amplaz Conclusiounen

Mir hunn net opgehalen eise Plugin no der Verëffentlechung z'entwéckelen. An elo schaffe mir un der korrekter Iwwerwaachung vun der Notzung vu Ressourcen vu Clusternoden, nei Fonctiounen aféieren fir d'UX ze verbesseren, an och eng grouss Quantitéit vu Feedback erakommen, déi no der Installatioun vum Plugin souwuel vun eise Clienten wéi och vu Leit op GitHub (wann Dir verloosst) Är Fro oder Pull Ufro, ech wäert ganz frou sinn :)

Mir hoffen, datt dësen Artikel Iech hëlleft esou e wonnerbare Tool wéi Grafana ze verstoen an, vläicht, Ären eegene Plugin ze schreiwen.

Merci!)

Source: will.com