Vlastní kolorovací filtr pro grc

19.9.2017 17:59 | Přečteno: 1563× | Za vším hledej Linux | | poslední úprava: 20.9.2017 10:38

Před dávnými časy jsem zde publikoval blogpost, jak si na terminálové konzoli pomocí utility "grc" obarvit zobrazované výstupy. Bylo to jenom letmé seznámení s aplikací, takže jsem tenkrát nezdůraznil to, že se výstup obarvuje na základě pravidel uvedených v kolorizačním filtru, který je závislý na tom, jaká se použije aplikace. Pokud použijete tuto utilitu na obarvení výstupu, co vrací kupř. "dig", použije kolorovací filtr 'conf.dig', pro obarvení výstupu z aplikace diff zase 'conf.diff', atp.

Pokud byste si si však chtěli tímto způsobem obarvit výstup ze své vlastní aplikace – tak s největší pravděpodobností ostrouháte, pokud teda zrovna nebude používat stejný formát výstupu, jaký umí obarvit některý z již existujících filtrů. Ovšem ani pak nemáte vyhráno. Ale k tomu se dostaneme.

Tento blogpost je tedy o tom, jak napsat a používat svůj vlastní kolorovací filtr pro grc.

Kolorovací filtry jsou uložené v adresáři /usr/share/grc. Každý se jmenuje conf a s příponou, kterou je buď jméno aplikace, či formát použití pro jaký je filtr určen. Vyjděmež tedy ze situace, kdy máte aplikaci (či skript) s názvem myapp, jejíž výstup vypadá zhruba takto:

08:28:00.037541386 stroj SET main() DEBUG –> -d7

Ačkoliv je výstup podobný logovacímu výstupu, nebude kolorovací filtr config.log fungovat, protože začátek řádky neodpovídá tomu co se očekává. Nicméně, právě proto, že je tento výstup podobný, můžeme tento filtr použít jako výchozí pro vlastní kolorizační filtr s názvem conf.myapp. Začneme tedy tím, že si nejprve vytvoříme kopii:

stroj:~# cd /usr/share/grc
stroj:/usr/share/grc# cp conf.log conf.myapp

Upravujeme conf.myapp

Struktura filtru je poměrně jednoduchá. Filtr je sestaven z několika bloků pravidel, které se vždy skládají ze tří proměnných:

regexp – Určuje formou regulárního výrazu, jak má vypadat kolorovaný řetězec. V případě, že byste použili původní filtr conf.log bez úpravy, narazíte, protože regulární výraz, kterým se obarvuje počátek řádku má úplně jiný formát. U standardního logu se uvádí na začátku řádky datum, které zde chybí. Tím pádem regulární výraz nesedí a nejspíš nebudou sedět ani další bloky pravidel.

Pro srovnání tedy uvedu jak vypadá regulární výraz pro zpracování začátku řádky u conf.log:

regexp=^... (\d| )\d \d\d:\d\d:\d\d(\s[\w\d]+?\s)

A takto vypadá regulární výraz, který zpracuje začátek řádku výše uvedeného výstupu:

regexp=^\d\d:\d\d:\d\d(.)(\d\d\d\d\d\d\d\d\d)(\s[\w\d]+?\s)

Jde o klasické regulární výrazy. Kde tečka zastupuje libovolný znak, stříška označuje začátek řádku, zpětné lomítko + d zastupuje číslo, zpětné lomítko + s libovolné písmeno a kulaté závorky specifikují jednotlivé řetězce.

Pokud bychom nepoužili kulaté závorky, obarvil by se celý řetězec vyhovující regulárnímu výrazu jednou barvou

colours – Obsahuje seznam barev, v pořadí jaké se má použít k obarvení řetězců. Barvy jsou uvedené slovně (anglicky) a jsou navzájem odděleny čárkou. Viz ukázka:

colours=green, cyan, yellow, red

V tomto případě se obarví první řetězec kde je uveden čas klasickým způsobem zeleně, tečka bude světle modrá, mikrosekundy žluté a hostname stroje (čtvrtý řetězec) červeně. Zbytek řádky zůstane neobarvený, resp. bude zpracován podle následujících bloků pravidel.

count – Udává, kolikrát se může kolorovaný řetězec na řádce vyskytnout. Může mít pouze dvě hodnoty once (tj. pouze jednou) a more (opakovaně).

Použití filtru conf.myapp

stroj:~# myapp -d7 list VM 2>&1 | grcat conf.myapp
…

V uvedeném příkladu je použito přesměrování výstupů, protože aplikace myapp vypisuje svoje debugovací zprávy na chybový výstup, kdežto grcat obarvuje pouze řetězce, které mu přicházejí na standardní vstup. Pokud by tedy nebyl výstup před odesláním do roury přesměrován, zůstal by neobarvený.

Konfigurační soubor /etc/grc.conf

Chcete-li se vyhnout psaní přesměrování a roury na řádce, musíte upravit konfigurační soubor /etc/grc.conf tak, že do něj přidáte pravidlo, aby grc věděl, že při použití myapp má použít filtr conf.myapp:

…
------------
# kvm
(^|[/\w\.]+/)myapp\s?
conf.myapp

Pak bude náš kolorovací filtr pro výstup skriptu myapp fungovat i při použití příkazu grc:

stroj:~# grc -e myapp -d7 list VM
…

Parametr -e zajišťuje u příkazu grc – podobně jako v předchozím případě, kdy se výstup obarvuje přes grcat přesměrování – přetočení chybového výstupu na standardní vstup.

       

Komentáře

[awk]

Barvičky :)). Ale teď vážně: asi dvakrát jsem dělal skript, kde byl výstupem takový hegeš, že jsem obarvoval o sto péro, abych se v tom alespoň trochu vyznal.

[Aleš Kapica]

Já jsem se k tomu musel uchýlit především z toho důvodu, že skript co dodělávám komunikuje s několika servery současně a při tom jsem potřeboval odlišit jednak na kterém stroji a co zrovna dělá, od toho co má být korektním výstupem. Ovšem s výsledkem jsem natolik spokojen, že jsem si ten konfigurák pro grc rovnou přihodil do repozitáře k tomu skriptu.