Развој на приклучок за Grafana: историја на големи снимки

Здраво на сите! Пред неколку месеци го лансиравме нашиот нов проект со отворен код во производство - приклучокот Grafana за следење кубернети, кој го нарековме DevOpsProdigy KubeGraf. Изворниот код на приклучокот е достапен на јавно складиште на GitHub. И во оваа статија сакаме да ја споделиме со вас приказната за тоа како го создадовме приклучокот, кои алатки ги користевме и какви стапици наидовме во текот на процесот на развој. Да одиме!

Дел 0 - воведен: како стигнавме до оваа точка?

Идејата да напишеме сопствен додаток за Grafan ни дојде сосема случајно. Нашата компанија надгледува веб-проекти со различни нивоа на сложеност повеќе од 10 години. За ова време имаме акумулирано голема количина на експертиза, интересни случаи и искуство во користење на различни системи за следење. И во одреден момент се запрашавме: „Дали постои магична алатка за следење на Kubernetes, за, како што велат, „поставете го и заборавете го“?“. Индустрискиот стандард за следење на k8s, се разбира, одамна е Комбинација Прометеј + Графана. И како готови решенија за овој оџак, има голем сет на различни видови алатки: прометеј-оператор, сет на контролни табли kubernetes-mixin, grafana-kubernetes-app.

Приклучокот grafana-kubernetes-app изгледаше како најинтересна опција за нас, но не е поддржан повеќе од една година и, згора на тоа, не може да работи со новите верзии на node-exporter и kube-state-metrics. И во одреден момент решивме: „Зарем не треба да донесеме своја одлука?

Кои идеи решивме да ги имплементираме во нашиот приклучок:

• визуелизација на „апликациската карта“: практично прикажување на апликациите во кластерот, групирани по именски простори, распоредувања...;
• визуелизација на врски како „распоредување - услуга (+порти)“.
• визуелизација на дистрибуцијата на кластерските апликации низ кластерските јазли.
• збирка на метрика и информации од повеќе извори: Prometheus и k8s api сервер.
• следење и на инфраструктурниот дел (користење на време на процесорот, меморија, потсистем на диск, мрежа) и логика на апликацијата - подлоги за здравствен статус, број на достапни реплики, информации за полагање тестови за живост/подготвеност.

Дел 1: Што е „приклучок Grafana“?

Од техничка гледна точка, приклучокот за Grafana е аголен контролер, кој се чува во директориумот со податоци Grafana (/var/grafana/plugins/ /dist/module.js) и може да се вчита како SystemJS модул. Исто така, во овој директориум треба да има датотека plugin.json што ги содржи сите мета информации за вашиот приклучок: име, верзија, тип на приклучок, врски до складиштето/страницата/лиценцата, зависности итн.

модул.ts

приклучок.json

Како што можете да видите на сликата од екранот, наведовме plugin.type = app. Бидејќи приклучоците за Grafana можат да бидат од три вида:

панел: најчестиот тип на приклучок - тоа е панел за визуелизација на која било метрика, што се користи за изградба на различни контролни табли.
извор на податоци: приклучок за приклучок за некој извор на податоци (на пример, Prometheus-datasource, ClickHouse-datasource, ElasticSearch-datasource).
апликацијата: Приклучок кој ви овозможува да изградите своја сопствена апликација за преден дел во Grafana, да креирате сопствени html страници и рачно да пристапите до изворот на податоци за да визуелизирате различни податоци. Исто така, додатоците од други видови (извор на податоци, панел) и разни контролни табли може да се користат како зависности.

Примери за зависности од приклучоци со тип=апликација.

Можете да ги користите и JavaScript и TypeScript како програмски јазик (ние го избравме). Подготовки за hello-world приклучоци од кој било тип што можете најдете ја врската: ова складиште содржи голем број стартер-пакети (има дури и експериментален пример на приклучок во React) со претходно инсталирани и конфигурирани градители.

Дел 2: подготовка на локалната средина

За да работиме на приклучокот, природно ни треба кубернет кластер со сите претходно инсталирани алатки: прометеј, извозник на јазли, кубе-состојба-метрика, графана. Околината треба да се постави брзо, лесно и природно, а за да се обезбеди повторно вчитување, директориумот со податоци Grafana треба да се монтира директно од машината на развивачот.

Најзгодниот начин, според наше мислење, да се работи локално со кубернетите е миникубе. Следниот чекор е да ја инсталирате комбинацијата Prometheus + Grafana користејќи прометеј-оператор. ВО Оваа статија Детално е опишан процесот на инсталирање на прометеј-оператор на minikube. За да овозможите упорност, мора да го поставите параметарот упорност: точно во датотеката charts/grafana/values.yaml, додајте ги вашите сопствени PV и PVC и наведете ги во параметарот persistence.existingClaim

Нашата последна скрипта за лансирање на minikube изгледа вака:

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

Дел 3: вистински развој

Модел на објект

Како подготовка за имплементација на приклучокот, решивме да ги опишеме сите основни ентитети на Kubernetes со кои ќе работиме во форма на класи на TypeScript: pod, deployment, daemonset, statefulset, job, cronjob, услуга, јазол, именски простор. Секоја од овие класи наследува од заедничката класа BaseModel, која ги опишува конструкторот, деструкторот, методите за ажурирање и префрлување видливост. Секоја од класите опишува вгнездени врски со други ентитети, на пример, листа на подлоги за ентитет од тип на распоредување.

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 = [];
   }
}

Со помош на добивачи и поставувачи, можеме да ги прикажеме или поставиме метриките на ентитетите што ни се потребни во пригодна и читлива форма. На пример, форматиран излез на доделени процесорски јазли:

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

Страници со врски

Списокот на сите наши страници со приклучоци првично е опишан во нашиот pluing.json во делот за зависности:

Во блокот за секоја страница мораме да го наведеме ИМЕТО НА СТРАНАТА (тоа ќе се претвори во голтка со која оваа страница ќе биде достапна); името на компонентата одговорна за работата на оваа страница (листата на компоненти се извезува во module.ts); што ја означува улогата на корисникот за која е достапна работата со оваа страница и поставките за навигација за страничната лента.

Во компонентата одговорна за работата на страницата, мора да поставиме templateUrl, пренесувајќи ја патеката до html-датотеката со обележување. Внатре во контролорот, преку вбризгување на зависност, можеме да пристапиме до 2 важни аголни услуги:

• backendSrv - услуга која обезбедува интеракција со серверот Grafana API;
• datasourceSrv - услуга која обезбедува локална интеракција со сите извори на податоци инсталирани во вашата Grafana (на пример, методот .getAll() - враќа список на сите инсталирани извори на податоци; .get( ) - враќа примерен објект на одреден извор на податоци.

Дел 4: извор на податоци

Од гледна точка на Графана, изворот на податоци е потполно истиот приклучок како и сите други: има своја влезна точка module.js, има датотека со мета информации plugin.json. Кога развиваме додаток со тип = апликација, можеме да комуницираме и со постоечките извори на податоци (на пример, прометеј-извор на податоци) и со нашите, кои можеме да ги складираме директно во директориумот на приклучокот (dist/datasource/*) или да го инсталираме како зависност. Во нашиот случај, изворот на податоци доаѓа со кодот на приклучокот. Исто така, потребно е да имате шаблон config.html и контролер ConfigCtrl, кои ќе се користат за страницата за конфигурација на примерот на изворот на податоци и контролорот Datasource, кој ја имплементира оперативната логика на вашиот извор на податоци.

Во приклучокот KubeGraf, од гледна точка на корисничкиот интерфејс, изворот на податоци е пример од кластерот kubernetes што ги имплементира следните способности (изворниот код е достапен по ссылке):

• собирање податоци од k8s api-серверот (добивање листа на именски простори, распоредувања...)
• прокси барања до изворот на податоци на prometheus (кој е избран во поставките на приклучокот за секој специфичен кластер) и форматирање на одговорите за користење на податоци и во статични страници и во контролни табли.
• ажурирање податоци на статични страници со приклучоци (со поставена стапка на освежување).
• обработка на барања за генерирање на лист со шаблони во grafana-dashboards (метод metriFindQuery())

• тест за поврзување со конечниот кластер k8s.

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"};
       })
}

Посебна интересна точка, според наше мислење, е имплементацијата на механизам за автентикација и авторизација за изворот на податоци. Вообичаено, надвор од кутијата, можеме да ја користиме вградената компонента Grafana datasourceHttpSettings за да го конфигурираме пристапот до конечниот извор на податоци. Користејќи ја оваа компонента, можеме да го конфигурираме пристапот до изворот на податоци http со одредување на URL-то и основните поставки за автентикација/овластување: најава-лозинка или клиент-серт/клиент-клуч. За да ја имплементираме можноста за конфигурирање на пристапот со користење на носител токен (де факто стандард за k8s), моравме да направиме малку дотерување.

За да го решите овој проблем, можете да го користите вградениот механизам Grafana „Plugin Routes“ (повеќе детали на официјална страница за документација). Во поставките на нашиот извор на податоци, можеме да декларираме збир на правила за рутирање кои ќе бидат обработени од прокси-серверот grafana. На пример, за секоја поединечна крајна точка е можно да се постават заглавија или url со можност за шаблон, податоци за кои може да се преземат од полињата jsonData и safeJsonData (за складирање лозинки или токени во шифрирана форма). Во нашиот пример, прашања како /__прокси/api/v1/именски простори ќе биде проксирано на URL-то на формуларот
/api/v8/именски простори со заглавие на авторизација: носител.

Секако, за работа со k8s api серверот ни треба корисник со пристап само за читање, манифестации за креирање кои можете да ги најдете и во изворниот код на приклучокот.

Дел 5: ослободување

Откако ќе го напишете вашиот сопствен приклучок Grafana, природно ќе сакате да го направите јавно достапен. Во Графана ова е библиотека со приклучоци достапни овде grafana.com/grafana/plugins

За да може вашиот приклучок да биде достапен на официјалната продавница, треба да направите ПР ова складиштесо додавање на ваква содржина во датотеката repo.json:

каде што верзијата е верзијата на вашиот приклучок, url е врска до складиштето, а commit е хашот на commit за кој ќе биде достапна одредена верзија на приклучокот.

И на излезот ќе видите прекрасна слика како:

Податоците за него автоматски ќе бидат земени од вашите Readme.md, Changelog.md и датотеката plugin.json со опис на приклучокот.

Дел 6: наместо заклучоци

Не престанавме да го развиваме нашиот приклучок по објавувањето. И сега работиме на правилно следење на употребата на ресурсите на јазлите на кластерот, воведување нови функции за подобрување на UX, а исто така и собирање на голем број повратни информации добиени по инсталирањето на приклучокот и од нашите клиенти и од луѓето на GitHub (ако го напуштите ваше прашање или барање, јас ќе бидам многу среќен :)

Се надеваме дека оваа статија ќе ви помогне да разберете таква прекрасна алатка како Grafana и, можеби, да напишете свој приклучок.

Ви благодарам!)

Извор: www.habr.com