Статистика и мониторинг на PHP скриптове в реално време. ClickHouse и Grafana идват на помощ на Pinba

В тази статия ще ви кажа как да използвате pinba с clickhouse и grafana вместо pinba_engine и pinboard.

В PHP проект pinba е може би единственият надежден начин да разберете какво се случва с производителността. Вярно е, че pinba обикновено се прилага само когато вече се наблюдават проблеми и не е ясно „къде да копаем“.

Често никой няма представа колко пъти в секунда/минута се извиква този или онзи скрипт и те започват да оптимизират „чрез докосване“, започвайки от онези места, които изглеждат по-логични.

Някои анализират регистрационни файлове на nginx, докато други анализират бавни заявки към база данни.

Разбира се, pinba не би била излишна, но има няколко причини, поради които не всеки проект я има.

И първата причина е инсталацията.

За да получите повече или по-малко някакъв вид „изгорели газове“ от внедряването на Pinba, е много желателно да видите показатели не само за последните минути, но и за дълъг период от време (от дни до месеци).

За това имате нужда от:

• инсталирайте разширение за php (и може да искате модул за nginx)
• компилиране на разширение за mysql
• инсталирайте pinboard и конфигурирайте cron

Поради малкото информация за Pinba, много хора остават с впечатлението, че тя работи само на PHP5 и отдавна е нещо от миналото, но както ще видим по-късно, това не е така.

Първата стъпка е най-простата, всичко, което трябва да направите, е да изпълните командата:

apt install php-pinba

Това разширение е налично в хранилищата до и включително php 7.3 и не е необходимо да компилирате нищо.

След като изпълним инсталационната команда, веднага получаваме работещо разширение, което събира и изпраща метрики за всеки скрипт (време на изпълнение, памет и т.н.) във формат протобуф чрез udp до 127.0.0.1:30002.

Досега никой не е уловил или обработил тези UDP пакети, но това по никакъв начин не се отразява негативно на скоростта или стабилността на вашите PHP скриптове.

Доскоро единственото приложение, което можеше да хваща и обработва тези UDP пакети, беше pinba_engine. описание "прости и кратки" инсталацията обезсърчава желанието някога да я прочетете и да се задълбочите отново. Километричните списъци със зависимости съдържат както имена на пакети, така и имена на програми и линкове към отделни страници с тяхната инсталация, а те имат свои линкове към други зависимости. Никой няма време и желание да се занимава с тези глупости.

Процес на инсталиране pinba2 не особено по-лесно.

Може би някой ден ще бъде възможно да инсталирате pinba10 с една или две команди и да не се налага да четете куп материали, за да разберете как да го направите, но засега това не е така.

Ако инсталирате pinba_engine, това е само половината от битката. В крайна сметка без табла ще трябва да се ограничите до данни само от последните няколко минути или ще трябва сами да събирате, съхранявате и визуализирате данните. Добре е, че pinboard е доста лесен за използване инсталация.

Изглежда, защо такова страдание, ако всички показатели от php вече са изпратени до udp порта във формат protobuf и всичко, от което се нуждаете, е да напишете приложение, което да ги хване и да ги постави в някакъв вид хранилище? Очевидно онези разработчици, които излязоха с тази идея, веднага седнаха да напишат свои собствени идеи, някои от които се озоваха в GitHub.

Следва преглед на четири проекта с отворен код, които записват показатели в хранилище, от което тези данни могат лесно да бъдат извлечени и визуализирани, например с помощта на grafana.

olegfedoseev/pinba-сървър (ноември 2017 г.)

udp сървър в движение, който записва показатели в OpenTSDB. Може би, ако вече използвате OpenTSDB във вашия проект, тогава това решение ще ви подхожда, в противен случай препоръчвам да го подминете.

olegfedoseev/pinba-influxdb (юни 2018 г.)

udp сървър в движение, от същия habrowser, който този път съхранява показателите в InfluxDB. Много проекти вече използват InfluxDB за наблюдение, така че това решение може да е идеално за тях.

плюсове:

• InfluxDB Тя позволява на обобщете получените показатели и изтрийте оригинала след определено време.

против:

• Това решение не записва информация за таймери.
• InfluxDB ще съхранява адресите на страниците на сайта като тагове и ако имате много уникални адреси на страници, това ще доведе до повишена консумация оперативна памет. От определен момент той "ще започне да изяжда паметта като луд". (източник)

ClickHouse-Ninja/Протон (януари 2019 г.)

udp сървър в движение, който записва показатели в ClickHouse. Това е решението на моя приятел. След като се запознах с него, реших, че е време да се изправя срещу Pinbu и Clickhouse.

плюсове:

• Clickhouse е идеален за такива задачи; той ви позволява да компресирате данни толкова много, че можете да съхранявате всички необработени данни дори без агрегиране
• ако е необходимо, можете лесно да обобщите получените показатели
• готов шаблон за графана
• запазва информация за таймерите

против:

• фатален недостатък
• няма конфигурация, в която можете да конфигурирате името на базата данни и таблиците, адреса и порта на сървъра.
• при съхраняване на необработени данни се използва спомагателна речникова таблица за съхраняване на адреси на страници и домейни, което усложнява последващите заявки
• други малки неща, които следват от първия минус

pinba-сървър/pinba-сървър (април 2019 г.)

udp сървър в php, който записва метрики в ClickHouse. Това е моето решение, което е резултат от запознаването с pinba, ClickHouse и protobuf. Докато подреждах цялата тази група, написах „доказателство за концепцията“, което неочаквано за мен не изразходва значителни ресурси (30 MB RAM и по-малко от 1% от едно от осемте процесорни ядра), така че аз реши да го сподели с обществеността.

Предимствата са същите като предишното решение, използвах и обичайните имена от оригиналния pinba_engine. Добавих също конфигурация, която ви позволява да стартирате няколко копия на pinbase сървър наведнъж, за да запазите показатели в различни таблици - това е полезно, ако искате да събирате данни не само от php, но и от nginx.
Недостатъци - „фатален недостатък“ и онези малки неща, които няма да ви харесат лично, но моето решение е „просто като чехъл“ и се състои само от около 100 реда код, така че всеки PHP разработчик може да промени това, което не му харесва след няколко минути.

Принцип на действие

Прослушва се UDP порт 30002. Всички входящи пакети се декодират съгласно схемата protobuf и се агрегират. Веднъж на минута пакет се вмъква в clickhouse в таблицата pinba.requests. (всички параметри са конфигурирани в конфиг)

Малко за Clickhouse

Clickhouse поддържа различни машини за съхранение на данни. Най-често използваният е MergeTree.

Ако в даден момент решите да съхранявате обобщени данни за всички времена и необработени данни само за последното, тогава можете да създадете материализиран изглед с групиране и периодично да почиствате основната таблица pinba.requests, докато всички данни ще останат в материализиран изглед. Освен това, когато създавате таблицата pinba.requests, можете да посочите „engine = Null“, тогава необработените данни изобщо няма да бъдат записани на диска и в същото време те все още ще завършват в материализирания изглед и ще бъдат запазени обобщени . Използвам тази схема за метрики на nginx, защото на nginx имам 50 пъти повече заявки, отколкото на php.

И така, изминахте дълъг път и не бих искал да ви оставя наполовина, така че това, което следва, е подробно описание на инсталацията и конфигурацията на моето решение и всичко, от което се нуждаете, както и клопките, които са причинили повече от един кораб да се блъснеш. Целият процес на инсталиране е описан за Ubuntu 18.04 LTS и Centos 7; процесът може да се различава леко при други дистрибуции и версии.

Инсталация

Въведох всички необходими команди Докер файл за улесняване на възпроизводимостта на инструкциите. По-долу ще бъдат описани само клопките.

php-pinba

След инсталирането се уверете, че във файла /etc/php/7.2/fpm/conf.d/20-pinba.ini сте разкоментирали всички опции. При някои дистрибуции (напр. centos) те могат да бъдат коментирани.

extension=pinba.so
pinba.enabled=1
pinba.server=127.0.0.1:30002

clickhouse

По време на инсталацията clickhouse ще ви помоли да зададете парола за потребителя по подразбиране. По подразбиране този потребител е достъпен от всички IP адреси, така че ако нямате защитна стена на вашия сървър, не забравяйте да зададете парола за него. Това може да се направи и след инсталиране във файла /etc/clickhouse-server/users.xml.

Също така си струва да се отбележи, че clickhouse използва няколко порта, включително 9000. Този порт се използва и за php-fpm в някои дистрибуции (например centos). Ако вече използвате този порт, можете да го промените на друг във файла /etc/clickhouse-server/config.xml.

grafana с плъгин clickhouse

След като инсталирате Grafana, използвайте администратор за влизане и администратор за парола. Когато влезете за първи път, Grafana ще ви помоли да зададете нова парола.

След това отидете на менюто „+“ -> импортиране и посочете номера на таблото за импортиране 10011. Подготвих и качих това табло за управление, така че да не се налага да го правите отново сами.

Grafana поддържа работа с clickhouse чрез приставка на трета страна, но Grafana няма предупреждения за приставки на трети страни (има билет за това от няколко години).

pinba-сървър

Инсталирането на protobuf и libevent не е задължително, но подобрява производителността на pinba-сървъра. Ако инсталирате pinba-сървър в папка, различна от /opt, тогава ще трябва също да коригирате системен скрипт файл

pinba модул за nginx

За да компилирате модул, имате нужда от изходни кодове на същата версия на nginx, която вече е инсталирана на вашия сървър, както и същите опции за компилиране, в противен случай компилацията ще бъде успешна, но при свързване на модула ще бъде изведена грешка, че „модулът не е двоично съвместим.“ Опциите за компилиране могат да се видят с помощта на командата nginx -V

Лайф хакове

Всички мои сайтове работят само на https. Полето за схема става безсмислено, така че го използвам за разделяне на уеб/конзола.

В скриптове, които са достъпни от мрежата, използвам:

if (ini_get('pinba.enabled')) {
    pinba_schema_set('web');
}

И в конзолни скриптове (например cron скриптове):

if (ini_get('pinba.enabled')) {
    pinba_schema_set('console');
}

В таблото ми за управление в Графана има превключвател за уеб/конзола за отделно разглеждане на статистики.

Можете също така да изпратите своите маркери на Pinba, например:

pinba_tag_set('country', $countryCode);

Това е всичко.

Моля, отговорете на анкетите под статията.

Както обикновено, предупреждавам ви, че не съветвам и не помагам чрез лични съобщения в Habr и социалните мрежи.

Създайте билет в Github.

Също така, моля, подкрепете с харесвания Английска версия тази статия в Reddit.

В анкетата могат да участват само регистрирани потребители. Впиши се, Моля те.

Каква ОС използвате на сървъра?

• Ubuntu

• CentOS

• Debian

• Gentoo

• Кардинал

• Fedora

• OpenSUSE

• ШВЕЙЦАРИЯ

• Unix

• Windows

• друг

114 потребители гласуваха. 11 потребители се въздържаха.

Каква версия на php използвате на сървъра?

• 7.3

• 7.2

• 7.1

• 7.0

• 5

• друг

105 потребители гласуваха. 17 потребители се въздържаха.

Използвали ли сте някога pinba?

• да

• не, но бих искал

• не и не бих искал

• не и не съм чувал за нея

100 потребители гласуваха. 14 потребители се въздържаха.

Коя версия на Pinba сървър бихте искали да опитате?

• pinba_engine (mysql двигател)

• pinba2 (mysql двигател)

• pinboard (php + mysql)

• olegfedoseev/pinba-сървър (go + OpenTSDB)

• olegfedoseev/pinba-influxdb (go + influxdb)

• pinba-сървър/pinba-сървър (go + clickhouse)

• pinba-сървър/pinba-сървър (php + clickhouse)

• Аз сам ще напиша моите

• друг

39 потребители гласуваха. 47 потребители се въздържаха.

Източник: www.habr.com