SYSTEMTAP(8)                System Manager's Manual               SYSTEMTAP(8)

JMENO
       systemtap - systemtap initskript sluzba



POUZITI
       service systemtap COMMAND [OPTIONS] [SCRIPT...]


POPIS
       SystemTap initskript sluzba umoznuje spoustet systemtap skripty jako
       systemove sluzby a pohodlne je ovladat.  Skripty mohou byt nastartovany
       na individualni zadost, nebo pri startu systemu.  Na systemech, ktere
       vyuzivaji dracut je take mozne umistit skripty do initramfs a mit je
       spustene behem boot procesu.

       Existuji volby a parametry, ktere ovlivnuji globalni chovani sluzby
       nebo jednotlivych skriptu.  Mezi skripty lze vytvorit zavislosti, tak
       ze nastartovani jednoho automaticky zpusobi nastartovani jineho.

       Konfiguracni soubor initskriptu se nachazi v /etc/systemtap/config.
       Prijatelne parametry jsou detailne popsany v sekci GLOBALNI PARAMETRY.

       Skript musi byt umisten v adresari /etc/systemtap/script.d a musi mit
       priponu .stp.  Poznamenejme, ze kdyz se systemtap skripty pousteji z
       prikazove radky, jak je obvykle, neni pripona .stp povinna.  Jmeno
       skriptu smi obsahovat jen alfanumericke znaky a '_', a nesmi zacinat
       cislem.  Adresar pro skripty lze zmenit nastavenim parametru
       SCRIPT_PATH v konfiguracnim souboru.


PRIKAZY
       Musi byt uveden jeden z nasledujici prikazu:


       start  Start skriptu.  Pokud zadne skripty nebyly urceny, nastartuji se
              skripty urcene nastavenim DEFAULT_START.  Pokud DEFAULT_START
              neni nastaveno, nastartuji se vsechny skripty v adresari
              skriptu.  Pro skripty, ktere jiz bezi se prikaz "start"
              ignoruje.  Prikaz "start" selze, pokud start skriptu selze (viz
              tez nastaveni PASSALL).

              Pokud je zapnuta volba AUTOCOMPILE, prikaz se pokusi sestavit
              (nebo obnovit sestaveni) skriptu v pripade, ze je platna jedna z
              nasledujicich podminek:

              - Cache se zkompilovanymi skripty neexistuje.

              - Cas modifikace (mtime) puvodniho skriptu se zmenil.

              - Skript se spousti s jinymi volbami.

              - Zmenil se vystup `uname -a`.


       stop   Zastavit skripty.  Pokud zadne skripty nebyly urceny, zastavi se
              vsechny bezici skripty.  Pro skripty, ktere nebezi, se tento
              prikaz bude ignorovat.  Prikaz selze pokud selze zastaveni
              nektereho ze skriptu (viz tez nastaveni PASSALL).


       restart
              Zastavit a opet nastartovat skripty.


       status Zobrazit stav skriptu a jejich zavislosti.


       compile
              Prelozit skripty, ale nestartovat je.  Pokud skripty jiz byly
              prelozeny, dotazat se na potvrzeni drive, nez dojde k prepsani
              cache.  Kompilovat pro bezici jadro, nebo pro jadro urcene
              prostrednictvim volby -r.


       onboot Ucinit urcene skripty soucasti initramfs, aby mohly byt spusteny
              behem startu stroje.  Tento prikaz je dostupny jen na systemech,
              ktere pouzivaji dracut.  Pokud se neurci zadny skript, vsechny
              systemtap skripty se z initramfs odstrani.

              Initramfs se vytvari pro aktualni jadro, nebo pro jadro urcene
              volbou -r.  Vychozi umisteni initramfs je /boot/initramfs-
              KVER.img, kde KVER odpovida vystupu `uname -r`.  Prikaz "onboot"
              dale obnovi nastaveni zavadece systemu tak, aby byl pouzit novy
              initramfs.  Pokud se ma vytvorit initramfs v jinem umisteni,
              pouzijte volbu -o.  V tomto pripade se nastaveni zavadece
              systemu nezmeni.

              Pokud vystupni soubor jiz existuje, bude prepsan pokud neni dan
              prepinac -b , kdy se puvodnimu souboru prida pripona .bak
              namisto prepsani.  Pokud ale .bak soubor jiz existuje, nebude
              prepsan.

              UPOZORNENI: Nepouzivejte volbu -o prikazu stap(1) u "onboot"
              skriptu, protoze skript pobezi drive, nez se namountuje korenovy
              souborovy system.  Pokud potrebujete vice mista pro vystup,
              zvetsete velikost bufferu.


       cleanup
              Odstranit specifikovane skripty z cache.  Pokud neni
              specifikovan zadny skript, budou smazany vsechny.  Smaze se jen
              cache pro aktualni jadro, nebo pro jadro urcene volbou -r.  Pred
              smazanim cache bude pozadovano potvrzeni.


VOLBY
       Nektere prikazy prijimaji volby.  Nicmene, protoze uzivatele nemohou
       predavat volby pri zavadeni OS, jsou volby urceny pouze pro ovladani
       skriptu bezicich az po nabootovani systemu a pro testovani.


       -c CONFIG_FILE
              Urcuje alternativni konfiguracni soubor.


       -R     Pri pouziti s start a stop prikazy znaci, ze maji byt vzaty v
              potaz zavislosti mezi skripty a to rekurzivne.


       -r KERNEL_RELEASE
              Pri pouziti s compile, onboot, a cleanup prikazy, urcuje cilove
              jadro.  Format KERNEL_RELEASE musi odpovidat formatu `uname -r`.


       -y     Odpovez ano na vsechny dotazy.


       -o PATH.IMG
              Pri pouziti s prikazem onboot urcuje umisteni initramfs.  Pokud
              se urci, konfigurace zavadece se nezmeni.  Pokud urcen neni,
              konfigurace zavadece se zmeni tak, aby byl pri nasledujicim
              startu pouzit novy initramfs.


       -b     Pri pouziti s prikazem onboot, zazalohuje existujici initramfs
              pripojenim pripony .bak namisto aby existujici initramfs
              prepsal, coz se stane neni-li tato volba pouzita.


GLOBALNI PARAMETRY
       Tyto parametry ovlivnuji obecne chovani sluzby.  Nastavuji se v
       konfiguracnim souboru.


       SCRIPT_PATH
              Urcuje absolutni cestu adresare pro skripty, se kterymi muze
              sluzba pracovat.  Skripty musi mit priponu .stp.  Vychozi
              hodnota je /etc/systemtap/script.d.


       CONFIG_PATH
              Urcuje absolutni cestu adresare pro konfiguracni soubory
              skriptu.  Tyto konfiguracni soubory obsahuji volby specificke
              pro jednotlive skripty.  Musi mit priponu .conf.  Vychozi
              umisteni je /etc/systemtap/conf.d.


       CACHE_PATH
              Umisteni cache adresare.  Vychozi umisteni je
              /var/cache/systemtap.


       TEMP_PATH
              Umisteni docasneho adresare, kam systemtap odklada docasne
              soubory, ktere vznikaji pri kompilaci systemtap jaderneho
              modulu.  Vychozi umisteni je /tmp.


       STAT_PATH
              Absolutni cesta k adresari se stavovymi soubory pro jednotlive
              skripty.  Vychozi umisteni je /var/run/systemtap.


       LOG_FILE
              Absolutni cesta k logovacimu souboru.  Vsechny zpravy se
              posilaji do tohoto souboru (vcetne kompilacnich chybovych
              hlaseni a hlaseni o chybach behu).  Vychozi umisteni je
              /var/log/systemtap.log.


       PASSALL
              Pokud tato volba je nastavena (yes), pak systemtap sluzba
              pracujici s mnoha skripty zahlasi chybu, pokud kterykoliv ze
              skriptu zhavaruje.  Pokud tato volba neni nastavena (no) vypise
              systemtap sluzba v takovem pripade jen varovani.



       RECURSIVE
              Pokud tato volba je nastavena (yes), sluzba systemtap bude brat
              v potaz zavislosti mezi skripty a to rekurzivne (odpovida volbe
              -R).  Tato volba je platna jen pokud byly na prikazove radce
              urceny skripty.  Vychozi hodnota je no.


       AUTOCOMPILE
              Pokud je tato volba nastavena (yes), sluzba systemtap se pokusi
              zkompilovat urcene skripty pokud nenalezne odpovidajici validni
              polozky v cache.  Jinak souvisejici prikaz selze.  Vychozi
              hodnota je yes.


       DEFAULT_START
              Urcuje skripty, ktere se maji nastartovat jako vychozi.  Pokud
              je tato volba vynechana (nebo nastavena na prazdnou hodnotu),
              nastartuji se vsechny skripty v adresari.  Vychozi hodnota je
              "".


       ALLOW_CACHEONLY
              Pokud je tato volba nastaveba (yes), sluzba umozni nastartovani
              take skriptum, pro nez existuji v cache validni data, ale v
              adresari pro skripty jejich zdrojovy kod chybi.  Vychozi hodnota
              je no.

              VAROVANI: S touto volbou muze sluzba nastartovat neocekavane
              skripty nachazejici se v cache.  Pred startem sluzby je vhodne
              obsah cache zkontrolovat.


       LOG_BOOT_ERR
              Protoze "boot-time" skripty se spousteji drive nez je
              namountovan korenovy souborovy system, nelze chybovy vystup
              programy staprun posilat do LOG_FILE jak je obvykle.  Nicmene
              log lze presmerovat do /run/systemtap/$script.log nastavenim
              LOG_BOOT_ERR na yes.  Pokud STAT_PATH je odlisna od vychozi
              hodnoty, budou logovaci soubory presunuty na pozadovane misto
              drive, nez se spusti jakykoliv prikaz sluzby.  Vychozi hodnota
              je no.


       Zde je ukazka konfiguracniho souboru.

              SCRIPT_PATH=/var/systemtap/script.d/
              PASSALL=yes
              RECURSIVE=no



PARAMETRY SKRIPTU
       Tyto parametry ovlivnuji kompilaci skriptu, nebo jejich chovani za
       behu.  Nastavuji se v konfiguracnich souborech umistenych v adresari
       CONFIG_PATH.


       <SCRIPT>_OPT
              Urcuje volby, ktere se predaji prikazu stap(1) pred vykonanim
              skriptu.  Zde SCRIPT je jmeno skriptu bez pripony .stp.
              Poznamenejme, ze volba -F se pouzije vzdy.

              Pri kompilaci skriptu se ignoruji nasledujici volby: -p, -m, -r,
              -c, -x, -e, -s, -o, -h, -V, -k.

              Pri spousteni skriptu se ignoruji nasledujici volby: -h, -V, -v,
              -t, -p, -I, -e, -R, -r, -m, -k, -g, -P, -D, -b, -u, -q, -w, -l,
              -d, -L, -F, a vsechny dlouhe volby.


       <SCRIPT>_REQ
              Urcuje zavislosti skriptu (t.j. urcuje, ktery skript je
              vyzadovan danym skriptem).  Pokud foo.stp vyzaduje (nebo
              potrebuje bezet po) bar.stp, nastavte

              foo_REQ="bar"

Vice skriptu lze nastavit jako mezerami oddeleny seznam.


       Priklad konfiguracniho souboru:

              script1_OPT="-o /var/log/script1.out"
              script2_OPT="-o /var/log/script2.out"
              script2_REQ="script1"



PRIKLADY
       INSTALACE SKRIPTU
              Nakopirujme SystemTap skript (napr. "script1.stp") do
              relevantniho adresare:

              # cp script1.stp /etc/systemtap/script.d/

Pak muzeme nastavit volby pro dany skript.  Napriklad:

              # vi /etc/systemtap/conf.d/group1
              script1_OPT="-o /var/log/group1.out"

Pokud pote nainstalujeme skript, napr. "script2.stp", ktery ma byt spusten po
"script1.stp", mame zde zavislost mezi skripty.  Tu osetrime nasledovne:

              # cp script2.stp /etc/systemtap/script.d/
              # vi /etc/systemtap/conf.d/group1
              script2_OPT="-o /var/log/group2.out"
              script2_REQ="script1"

V tomto pripade, pokud stap(1) selze pri startu, sluzba SystemTap se ani
nepokusi nastartovat script2.


       TESTOVANI
              Po nainstalovani skriptu muzeme overit, ze funguji takto:

              # service systemtap start
              # service systemtap stop

Mohli bychom byt konkretnejsi, napriklad takto:

              # service systemtap start script1
              # service systemtap stop script1

Pokud nenastaly chyby, mame vse pripraveno k pouziti.


       ZAPNUTI SLUZBY
              Jakmile jsme spokojeni se skripty a testovani dopadlo uspesne,
              muzeme SystemTap sluzbu zapnout tak, aby se automaticky
              nastartovala po zavedeni systemu:

              # chkconfig systemtap on



       MAZANI SKRIPTU
              Skripty se smazou prostym jejich odstranenim z adresare pro
              skripty a take odstranenim jejich konfiguracnich souboru plus
              pripadne relevantnich nastaveni:

              # rm /etc/systemtap/script.d/script2.stp
              # vi /etc/systemtap/conf.d/group1

Pokud skript stale bezi, meli bychom jej zastavit:

              # service systemtap stop script2

Take muzeme smazat relevantni cache:

              # service systemtap cleanup script2



       PRIPRAVA NA POVYSENI JADRA
              Obvykle neni treba delat nic neobvykleho kdyz se startuje nove
              jadro.  Sluzba SystemTap pozna, ze verze jadra se lisi proti
              obsahu cache a rekompiluje skripty.  Kompilaci lze provest
              predem, abychom se vyhnuli kompilaci v dobe zavadeni systemu:

              # service systemtap compile myscript -r <NEW_KERNEL_VERSION>



       IMPORT ZKOMPILOVANYCH SKRIPTU
              V prostredi, kde nejsou k dispozici kompilacni nastroje (napr.
              kompilator, nebo ladici informace), jako je napr. produkcni
              system, lze skripty prelozit na jinem (vyvojarskem) stroji:

              # service systemtap compile myscript -r \
              >   <KERNEL_VERSION_OF_TARGET_MACHINE>
              # tar czf stap-scripts-<kernel-version>.tar.gz \
              >   /var/cache/systemtap/<kernel-version> \
              >   /etc/systemtap/conf.d/<configfile>

A pote je presunout na cilovy stroj.


       STARTOVANI SKRIPTU V DOBE ZAVADENI SYSTEMU (ONBOOT PROBING)
              luzba SystemTap umoznuje take nastartovat skripty pobliz zacatku
              procesu zavadeni OS tim, ze vytvori initramfs obsahujici
              systemtap modul pro dany skript.  Tato funkcionalita je dostupna
              jen na systemech, ktere pouzivaji dracut.  Spusteni skriptu v
              teto casne fazi startu OS zpristupnuje informace, ktere je jinak
              obtizne ziskat.

              Nejdrive nainstalujeme skript do odpovidajiciho adresare a
              provedeme potrebna nastaveni:

              # cp myscript.stp /etc/systemtap/script.d
              # vi /etc/systemtap/conf.d/myscript.conf

Pro pridani skriptu do initramfs pouzijeme prikazonboot:

              # service systemtap onboot myscript

Pokud dany skript neni zkompilovany a ulozeny v cache, dojde ke kompilaci.  Ve
vychozim umisteni bude vytvoren novy initramfs.  Mohli bychom pouzit volbu -b
pro vytvoreni zalohy puvodniho initramfs.  Nyni muzeme restartovat system.


       POUZITI ALTERNATIVNIHO INITRAMFS
              Pokud bychom chteli nastartovat skript behem nasledujiciho
              bootu, ale ne pozdeji, muzeme pouzit volbu -o k urceni
              alternativniho umisteni initramfs:

              # service systemtap onboot myscript \
              >   -o /boot/special_initramfs.img

Jakmile je initramfs vytvoren, je mozne jej pouzit prostou upravou parametru
jadra pri startu systemu.


       VYTVORENI INITRAMFS PRO JINE JADRO
              Stejne jako u prikazu compile, muzeme i zde pouzit volbu -r,
              abychom urcili jadro pro ktere chceme vytvorit initramfs.  To
              muze byt uzitecne napr.  chceme-li se pripravit na upgrade.
              Napriklad:

              # service systemtap onboot myscript \
              >   -r 3.12.6-200.fc19.x86_64



       ODSTRANENI SKRIPTU Z INITRAMFS
              K odstraneni skriptu z initramfs staci spustit prikaz onboot bez
              parametru:

              # service systemtap onboot

Takto se vytvori novy initramfs bez SystemTap modulu.


       HLEDANI CHYB ONBOOT MECHANIZMU
              Pridanim parametru 'rdinitdebug' mezi parametry jadra lze zvysit
              upovidanost programu dracut.  Dalsi informace lze ziskat z
              dmesg/journalctl -ae.  Chybovy vystup programu staprun lze
              ziskat nastavenim LOG_BOOT_ERR na yes.


VIZ TEZ
       stap(1) dracut(8) new-kernel-pkg(8)


CHYBY
       Pouzijte projektovou bugzillu, nebo mailing list.
       http://sourceware.org/systemtap/, <systemtap@sourceware.org>.

       error::reporting(7stap),
       https://sourceware.org/systemtap/wiki/HowToReportBugs


                                                                  SYSTEMTAP(8)