xymon - Online in de cloud

PROGRAMMA:

NAAM

xymon - Xymon-clientcommunicatieprogramma

KORTE INHOUD

xymon [Opties] ONTVANGER Bericht

PRODUCTBESCHRIJVING

xymon(1) is het clientprogramma dat wordt gebruikt om te communiceren met een Xymon-server. Het is vaak
gebruikt door Xymon-clientsystemen om statusberichten en semafoonwaarschuwingen over lokale tests in te sturen.

In Xymon wordt het programma xymon ook gebruikt voor administratieve doeleinden, bijvoorbeeld om or te hernoemen
hosts verwijderen of hosts uitschakelen die voor langere tijd niet beschikbaar zijn.

OPTIES EN PARAMETERS

--debuggen
Foutopsporing inschakelen. Hiermee worden details afgedrukt over hoe de verbinding met de Xymon
server wordt opgezet.

--proxy=http://PROXYSERVER:PROXYPOORT/
Gebruik bij het verzenden van de statusberichten via HTTP deze server in plaats daarvan als een HTTP-proxy
rechtstreeks verbinding maken met de Xymon-server.

--timeout=Nee
Specificeert de time-out voor het verbinden met de Xymon-server, in seconden. De standaard
is 5 seconden.

--antwoord
Het xymon-hulpprogramma weet normaal gesproken wanneer het een reactie van de server kan verwachten, dus dit
optie is niet vereist. Het zal echter elke reactie van de server veroorzaken
weergegeven.

--samenvoegen
Voeg de berichttekst van de opdrachtregel samen met de gegevens die op standaardinvoer worden verstrekt, en
stuur het resultaat naar de Xymon-server. De berichttekst op de opdrachtregel
wordt de eerste regel van het samengevoegde bericht.

ONTVANGER
De ONTVANGER parameter definieert welke server het bericht ontvangt. Als ONTVANGER is
gegeven als "0.0.0.0", wordt het bericht verzonden naar alle servers die worden vermeld in de
XYMSERVERS omgevingsvariabele.

Gewoonlijk gebruikt een client "$XYMSRV" voor de ONTVANGER parameter, zoals dit is
gedefinieerd zodat de clientscripts automatisch de juiste waarde bevatten.

De ONTVANGER parameter kan een URL zijn voor een webserver die de xymoncgimsg.cgi heeft
of vergelijkbaar script geïnstalleerd. Dit tunnelt de Xymon-berichten naar de Xymon-server
met behulp van het standaard HTTP-protocol. De xymoncgimsg.cgi(8) CGI-tool (inbegrepen in Xymon)
moet op de webserver zijn geïnstalleerd om het HTTP-transport te laten werken.

BERICHT
De Bericht parameter is het bericht dat naar de Xymon-server moet worden verzonden.
Berichten moeten tussen aanhalingstekens worden geplaatst, maar hierdoor kunnen ze meerdere regels beslaan.
De maximale grootte van een bericht wordt bepaald door de maximaal toegestane lengte van uw
shell's opdrachtregel, en is meestal 8-32 KB.

Als u langere statusberichten moet verzenden, kunt u "@" als bericht specificeren:
xymon leest dan het statusbericht van zijn stdin.

XYMON BERICHT SYNTAXIS

In dit gedeelte vindt u de meest gebruikte berichten in het Xymon-protocol.

Elk bericht moet beginnen met een van de Xymon-commando's. Waar een HOSTNAME is gespecificeerd, is het
moeten alle punten in de hostnaam zijn gewijzigd in komma's als de Xymon FQDN-instelling is ingeschakeld
(wat de standaard is). Dus de host "www.foo.com" zou bijvoorbeeld rapporteren als
"www,foo,com".

status[+LIFETIME][/group:GROUP] HOSTNAAM.TESTNAAM KLEUR
Dit stuurt een statusbericht voor een enkele test (kolom) op een enkele host.
TESTNAME is de naam van de kolom waar deze test zal verschijnen; elke naam is geldig
behalve dat het gebruik van punten in de testnaam niet zal werken. KLEUR moet een van de zijn
geldige kleuren: "groen", "geel", "rood" of "helder". De kleuren "blauw" en "paars"
- hoewel geldige kleuren - mogen niet in een statusbericht worden verzonden, zoals deze zijn
speciaal behandeld door de Xymon-server. Als speciaal geval (voor ondersteuning van oudere
clients), kan "client" worden gebruikt als de naam van de kleur. Dit veroorzaakt de status
bericht dat door Xymon moet worden behandeld als een "client"-gegevensbericht, en de TESTNAME
parameter wordt gebruikt als de "collector-id".
De "aanvullende tekst" bevat normaal gesproken een lokaal tijdstempel en een samenvatting van de test
resultaat op de eerste regel. Alle regels die volgen op de eerste zijn vrije vorm en kunnen
voeg alle informatie toe die nuttig kan zijn om een ​​diagnose te stellen van het gemelde probleem.
De LIFETIME bepaalt hoe lang deze status geldig is na ontvangst door de
Xymon-server. De standaard is 30 minuten, maar u kunt elke gewenste periode instellen. Bijv
voor een aangepaste test die eenmaal per uur wordt uitgevoerd, wilt u dit instellen op minimaal 60
minuten - anders wordt de status na 30 minuten paars. Het is een goed idee
om de LIFETIME in te stellen op iets langer dan het interval tussen uw tests, tot
houd rekening met variaties in de tijd die uw test nodig heeft om te voltooien. De LEVENSDUUR is binnen
minuten, tenzij u een "h" (uren), "d" (dagen) of "w" (weken) toevoegt onmiddellijk na
het nummer, bijv. "status+5h" voor een status die 5 uur geldig is.
De optie GROEP wordt gebruikt om waarschuwingen van de status naar een specifieke groep te sturen. Het
wordt momenteel gebruikt voor status die wordt gegenereerd op basis van de gegevens van de Xymon-clients, bijvoorbeeld om te sturen
waarschuwingen voor een "procs"-status aan verschillende mensen, afhankelijk van precies welk proces
is uit de lucht.

HOSTNAME.TESTNAME op de hoogte stellen
Dit activeert een informatief bericht dat moet worden verzonden naar degenen die waarschuwingen ontvangen
deze HOSTNAAM+TESTNAAM-combinatie, volgens de regels gedefinieerd in waarschuwingen.cfg(5)
Deze wordt gebruikt door de enadis.cgi(1) tool om mensen te informeren over hosts die zijn uitgeschakeld
of ingeschakeld, maar kan ook dienen als algemene manier om serverbeheerders op de hoogte te stellen.

data HOSTNAAM.DATANAME
Met het "data"-bericht kunnen tools gegevens over een host verzenden, zonder dat het verschijnt als
een column op de Xymon-webpagina's. Dit wordt bijvoorbeeld gebruikt om statistieken te rapporteren
over een host, bijvoorbeeld vmstat-gegevens, die op zichzelf niet iets vertegenwoordigen dat
heeft een rode, gele of groene identiteit. Het wordt onder andere gebruikt door RRD-onderaanvoermodules
anderen. In Xymon worden databerichten standaard alleen verwerkt door de xymond_rrd(8)
moduul. Als u databerichten wilt afhandelen met een externe applicatie, dan kan dat
wilt inschakelen xymond_filestore(8) module voor data-berichten, om data op te slaan
berichten in een formaat dat compatibel is met hoe de Big Brother-daemon doet.

schakel HOSTNAME.TESTNAME DURATION uit
Schakelt een specifieke test gedurende DURATION minuten uit. Dit zal de status hiervan veroorzaken
test om als "blauw" op de Xymon-server te worden vermeld, en geen waarschuwingen voor deze host/test
zal worden gegenereerd. Als DUUR wordt gegeven als een getal gevolgd door s/m/u/d, is dat zo
geïnterpreteerd als respectievelijk in seconden/minuten/uren/dagen. Om een ​​uit te schakelen
test totdat het OK wordt, gebruik "-1" als de DUUR. Om alle tests uit te schakelen voor a
host, gebruik een asterisk "*" voor TESTNAME.

schakel HOSTNAME.TESTNAME in
Schakelt een test die was uitgeschakeld opnieuw in.

vraag HOSTNAME.TESTNAME
Vraag de Xymon-server naar de laatste status die voor deze specifieke test is gerapporteerd. Als
de host-/teststatus is bekend, het antwoord is de eerste regel van het statusrapport
- de huidige kleur is het eerste woord op de regel. Extra regels tekst
die mogelijk op het statusbericht staan, kunnen niet worden opgehaald.
Hierdoor kan elke Xymon-client de status van een bepaalde test bepalen
het is er een die betrekking heeft op de host waarop de client draait, een andere host, of
misschien het resultaat van een gecombineerde test van meerdere hosts beheerd door combostatus(1)
Dit is meestal handig voor scripts voor Xymon-clientextensies, die dat nodig hebben
de status van andere hosts bepalen, bijvoorbeeld om te beslissen of een automatic
herstelactie moet worden gestart.

config BESTANDSNAAM
Haal een van de Xymon-configuratiebestanden op van de server. Deze opdracht staat toe
een client om bestanden uit de $XYMONHOME/etc/ directory op de server te halen, waardoor
voor semi-automatische updates van de clientconfiguratie. Sinds de configuratie
bestanden zijn ontworpen om een ​​gemeenschappelijk bestand te hebben voor de configuratie van alle hosts in de
systeem - en dit is in feite de aanbevolen manier om uw klanten te configureren - dit
maakt het eenvoudiger om de configuratiebestanden gesynchroniseerd te houden.

laat HOSTNAAM vallen
Verwijdert alle gegevens die zijn opgeslagen over de host HOSTNAME. Er wordt aangenomen dat je dat hebt
de host is al verwijderd uit het configuratiebestand hosts.cfg.

drop HOSTNAME TESTNAAM
Verwijder gegevens over een enkele test (kolom).

hernoem OUDEHOSTNAAM NIEUWEHOSTNAAM
Hernoem alle gegevens voor een host waarvan de naam is gewijzigd. Dit moet je daarna doen
het wijzigen van de hostnaam in het configuratiebestand hosts.cfg.

hernoem HOSTNAAM OUDETESTNAAM NIEUWETESTNAAM
Hernoem gegevens over een enkele test (kolom).

xymondlog HOSTNAAM.TESTNAAM
Haal het Xymon-statuslogboek op voor een enkele test. De eerste regel van het antwoord
bevat een reeks velden gescheiden door een pipe-teken:

hostname De naam van de gastheer

test naam De naam van de proef

kleur Statuskleur (groen, geel, rood, blauw, helder, paars)

testvlaggen Voor netwerktests zijn de vlaggen die details over de test aangeven (gebruikt door
xymongeen).

laatste wijziging Unix-tijdstempel wanneer de statuskleur voor het laatst is gewijzigd.

logtijd Unix-tijdstempel wanneer het logbericht is ontvangen.

geldige tijd Unix-tijdstempel wanneer het logbericht niet langer geldig is (het wordt paars op
deze keer).

tijd Ofwel -1 of Unix-tijdstempel wanneer een actieve bevestiging verloopt.

uitschakeltijd Ofwel -1 of Unix-tijdstempel wanneer de status niet langer is uitgeschakeld.

afzender IP-adres waar de status vandaan kwam.

koekje Ofwel -1 of de cookiewaarde die wordt gebruikt om een ​​waarschuwing te bevestigen.

bevestigingsmail Leeg of het bevestigingsbericht dat is verzonden bij het bevestigen van de status.
Newline, pipe-signs en backslashes worden geescaped met een backslash, C-stijl.

stuur bericht Leeg of het bericht dat is verzonden toen de status was uitgeschakeld. Newline, pijptekens
en backslashes worden geëscaped met een backslash, C-stijl.

Na de eerste regel komt het volledige statuslogboek in platte tekst.

xymondxlog HOSTNAAM.TESTNAAM
Haalt een XML-tekenreeks op die het statuslogboek bevat, zoals bij de opdracht "xymondlog".

xymondboard [CRITERIA] [velden=VELDLIJST]
Haalt een samenvatting op van de status van alle bekende tests die beschikbaar zijn voor de Xymon-daemon.

Standaard - als er geen CRITERIA is opgegeven - retourneert het één regel voor alle statussen
berichten die gevonden worden in Xymon. U kunt het antwoord filteren op selectiespecifiek
pagina, host, test, kleur of diverse andere velden. Het PAGEPATH, NETWERK, HOSTNAAM,
TESTNAME- en *MSG-parameters zijn perl-compatibele reguliere expressies;
de parameter COLOR accepteert meerdere kleuren gescheiden door komma's; de *TIME-waarden
accepteer unix tijdstempels. Andere variabelen geïdentificeerd in xymon-xmh(5) mag ook
worden gebruikt.

Omdat hostfiltratie wordt gedaan vóór testfiltratie, is het efficiënter (met
zeer grote datasets) om PAGEPATH, HOSTNAME, NETWORK en andere XMH_-filters te gebruiken
indien mogelijk, voordat u globaal filtert met COLOR, *MSG, *TIME of TESTNAME.

U kunt bijvoorbeeld filteren op zowel een hostnaam als een testnaam.

pagina=PAGINAPAD Neem alleen tests op van hosts die op de PAGEPATH-pagina zijn gevonden in het
hosts.cfg-bestand.

net=NETWERK Neem alleen tests op van hosts met deze NET:-tag

ip=IPAdres Neem alleen tests op van hosts met dit IP-adres. Dit is een reguliere expressie,
niet CIDR.

host=HOSTNAAM Neem alleen tests van de host HOSTNAME op

test=TESTNAAM Neem alleen tests op met de testnaam TESTNAME

kleur=KLEURNAAM Neem alleen tests op waarvan de statuskleur COLORNAME is

tag=TAGNAAM Neem alleen hosts op met een bepaalde tag die is opgegeven in de gastheren.cfg(5)
lijn. Merk op dat alleen items die bekend zijn bij xymon-componenten hier zijn opgenomen; willekeurig
tekst is niet inbegrepen

XMH_string=WAARDE Neem alleen hosts op met een xymon-xmh(5) variabele die hiermee overeenkomt
waarde

Geavanceerde filtering

msg=BERICHT Neem alleen tests op met MESSAGE die volledig overeenkomt met de inhoud. Gebruik "\s" om
escape spaces (of andere PCRE-strings)

ackmsg=BERICHT Voeg alleen tests toe met een bevestigingsbericht. Gebruik "\s" om
escape spaces (of andere PCRE-strings)

dismsg=BERICHT Neem alleen tests op die zijn uitgeschakeld met overeenkomende tekenreeksen
BERICHT. Gebruik "\s" om spaties (of andere PCRE-strings) te escapen. (Het is het meest efficiënt
om dit te combineren met kleur=blauw.)

Tijdstempelfilters

Bepaalde velden (hieronder uitgelegd) kunnen worden gefilterd met Unix-tijdstempels en met de
volgende ongelijkheden: >= > <= < = !=

Deze filters zijn: lastchange, logtime, validtime, actime, disabletime

Het antwoord is één regel voor elke status die overeenkomt met de CRITERIA, of alle statussen
als er geen criteria zijn opgegeven. De lijn is samengesteld uit een aantal velden, gescheiden
door een pijp-teken. U kunt selecteren welke velden u wilt ophalen door ze op te sommen in het
VELDLIJST. De volgende velden zijn beschikbaar:

hostname De naam van de gastheer

test naam De naam van de proef

kleur Statuskleur (groen, geel, rood, blauw, helder, paars)

vlaggen Voor netwerktests zijn de vlaggen die details over de test aangeven (gebruikt door
xymongeen).

laatste wijziging Unix-tijdstempel wanneer de statuskleur voor het laatst is gewijzigd.

logtijd Unix-tijdstempel wanneer het logbericht is ontvangen.

geldige tijd Unix-tijdstempel wanneer het logbericht niet langer geldig is (het wordt paars op
deze keer).

tijd Ofwel -1 of Unix-tijdstempel wanneer een actieve bevestiging verloopt.

uitschakeltijd Ofwel -1 of Unix-tijdstempel wanneer de status niet langer is uitgeschakeld.

afzender IP-adres waar de status vandaan kwam.

koekje Ofwel -1 of de cookiewaarde die wordt gebruikt om een ​​waarschuwing te bevestigen.

line1 Eerste regel van statuslogboek.

bevestigingsmail Leeg (als er geen bevestiging actief is), of de tekst van de bevestiging
bericht.

stuur bericht Leeg (als de status momenteel ingeschakeld is), of de tekst van de uitgeschakeld
bericht.

msg De volledige tekst van het huidige statusbericht.

klant Toont "J" als er klantgegevens beschikbaar zijn, "N" als dat niet het geval is.

clntstempel Tijdstempel wanneer het laatste clientbericht is ontvangen, in Unix "epoch"
formaat.

aclijst Lijst met de huidige bevestigingen voor een toets. Dit is een tekstreeks met
meerdere velden, gescheiden door een dubbele punt. Er zijn 5 velden: Tijdstempel voor
wanneer de bevestiging is gegenereerd en wanneer deze verloopt; het "ack-niveau"; de gebruiker die
stuurde de ack; en de bevestigingstekst.

flapinfo Geeft aan of de status fladdert. 5 velden, gescheiden door "/": Een "0" als de
status klappert niet en "1" als hij klappert; tijdstempel wanneer de laatste status
wijziging is geregistreerd en wanneer de eerste statuswijziging is geregistreerd; en de twee
kleuren waar de status tussen fladdert.

stats Aantal statuswijzigingen dat sinds xymond voor deze status is geregistreerd
was begonnen.

modifiers Toont alle actieve modifiers voor deze status (d.w.z. updates verzonden met een
opdracht "wijzigen").

XMH_* De XMH-tags verwijzen naar de Xymon gastheren.cfg(5) configuratie-instellingen. Een volle
lijst hiervan is te vinden in de xymon-xmh(5) man-pagina.

In de velden ackmsg, dismsg en msg zijn bepaalde tekens gecodeerd: Newline is "\n",
TAB is "\t", regelterugloop is "\r", een sluisteken is "\p" en een backslash is "\\".

Als de parameter "fields" wordt weggelaten, wordt een standaardset van
hostnaam,testnaam,kleur,vlaggen,laatste wijziging,logtijd,validtime,acktime,disabletime,afzender,cookie,regel1
is gebruikt.

xymondxbord
Haalt een XML-tekenreeks op met de samenvatting van alle statuslogboeken zoals voor de
commando "xymondboard".

hostinfo [CRITERIA]
Haalt de huidige configuratie van een host op (dwz het gastheren.cfg(5) definitie).
CRITERIA selecteert welke host(s) moeten worden gerapporteerd en is identiek aan de CRITERIA in het
xymondboard-opdracht.

Het antwoord is één regel voor elke host die overeenkomt met de CRITERIA, of alle hosts indien
er wordt geen criterium vermeld. De regel bestaat uit een aantal velden, gescheiden door
een pijpteken. De eerste twee velden zijn altijd de hostnaam en het IP-adres.
De resterende velden - indien aanwezig - zijn de hosts.cfg-tags in willekeurige volgorde.

BESTANDSNAAM downloaden
Download een bestand uit de downloaddirectory van de Xymon-server.

cliënt[/COLLECTORID] HOSTNAME.OSTYPE [HOSTCLASS]
Wordt gebruikt om een ​​"client"-bericht naar de Xymon-server te sturen. Er worden klantberichten gegenereerd
door de Xymon-klant; wanneer ze naar de Xymon-server worden verzonden, worden ze vergeleken met de
regels in de analyse.cfg(5) configuratiebestand en er worden statusberichten gegenereerd
voor de client-side tests. De COLLECTORID wordt gebruikt bij het verzenden van klantgegevens
zijn aanvullingen op de standaard klantgegevens. De gegevens worden samengevoegd met de
normale klantgegevens.

clientlog HOSTNAME [sectie=SECTIONNAME[,SECTIONNAME...]]
Haalt het huidige onbewerkte clientbericht op dat het laatst is verzonden door HOSTNAME. De optionele
"sectie" filter wordt gebruikt om specifieke secties van de klantgegevens te selecteren.

ping Pogingen om contact te maken met de Xymon-server. Indien succesvol, is de versie-ID van de Xymon-server
gerapporteerd.

pullclient
Dit bericht wordt gebruikt bij het ophalen van klantgegevens via het geïmplementeerde "pull"-mechanisme
by xymonophalen(8) en berichtcache(8) voor clients die niet rechtstreeks verbinding kunnen maken met het
Xymon-server.

spooklijst
Rapporteer een lijst van geest clients gezien door de Xymon-server. Geesten zijn systemen die
rapporteren gegevens aan de Xymon-server, maar worden niet vermeld in het bestand hosts.cfg.

plannen [TIMESTAMP COMMAND]
Plan een opdracht die naar de Xymon-server wordt verzonden voor uitvoering op een later tijdstip. Bijv
gebruikt om het uitschakelen van een host of service ergens in de toekomst te plannen. COMMANDO
is een compleet Xymon-commando zoals hierboven vermeld. TIMESTAMP is Unix
epoche tijd wanneer de opdracht zal worden uitgevoerd.
Als er geen parameters zijn opgegeven, worden de momenteel geplande taken weergegeven in de
antwoord. Het antwoord is één regel per geplande opdracht, met de job-id, de
tijdstip waarop de opdracht wordt uitgevoerd, het IP-adres waarvandaan deze is verzonden,
en de volledige opdrachtreeks.
Om een ​​eerder geplande opdracht te annuleren, "schema annuleren VACATURE" kunnen worden gebruikt.
JOBID is een nummer dat wordt verstrekt als het eerste item in de uitvoer van de planningslijst.

merkt FILENAME op
De berichttekst wordt opgeslagen in $XYMONHOME/notes/FILENAME, die vervolgens wordt gebruikt als
hyperlinks van hostnamen of kolomnamen. Dit vereist de taak "storenotes".
is ingeschakeld in taken.cfg (het is standaard uitgeschakeld). FILENAME mag er geen bevatten
directorypad - deze worden automatisch gestript.

gebruikersmsg-ID
Deze berichten worden direct doorgestuurd naar de modules die luisteren op het "user"-kanaal
van de Xymon-daemon. Dit is bedoeld voor aangepaste communicatie tussen client-side
modules en de Xymon-server.

wijzig HOSTNAAM.TESTNAAM KLEUR BRON OORZAAK
Wijzig de kleur van een specifieke status, zonder een volledige status te genereren
bericht. Dit is voor backend-processors (bijv. RRD-grafieken) die de
kleur van een status op basis van bepaalde criteria die buiten de normale stroom van een
toestand. De normale "conn"-status kan bijvoorbeeld groen lijken omdat deze alleen maar controleert
of een host kan worden gepingd of niet; de RRD-handler kan dan een "modify" gebruiken
opdracht om dit te overschrijven is de werkelijke ping-responstijd een bepaalde drempel overschrijdt.
(Zie de "DS" configuratie-instelling in analyse.cfg(5) voor hoe u dit doet). BRON
is een identificatie van de module die het bericht "wijzigen" genereert - toekomst
wijzigingen moeten dezelfde bron gebruiken. Er kunnen verschillende bronnen zijn die wijzigen
dezelfde status (de meest ernstige status wordt dan de werkelijke kleur van het
toestand). OORZAAK is een tekenreeks van één regel waarin de reden wordt uitgelegd voor het overschrijven van de
normale statuskleur - deze wordt weergegeven op de statuspagina.

VOORBEELD

Stuur een normaal statusbericht naar de Xymon-server, met behulp van het standaard Xymon-protocol op TCP
poort 1984:
$ $XYMON $XYMSRV "status www,foo,com.http groen `datum` Web OK"

Verzend hetzelfde statusbericht, maar met behulp van het HTTP-protocol via het xymoncgimsg.cgi van de webserver
script:
$ $XYMON http://bb.foo.com/cgi-bin/xymoncgimsg.cgi "status www,foo,com.http groen
`datum` Web OK"

Gebruik het "query"-bericht om de kleur van de "www"-test te bepalen en herstart Apache als dat zo is
rood:

$ WWW=`$XYMON $XYMSRV "vraag www,foo,com.www" | awk '{print $1}'`
$ als ["$WWW" = "rood"]; dan herstart /etc/init.d/apache; fi

Gebruik het "config"-bericht om een ​​lokaal mytest.cfg-bestand bij te werken (maar alleen als we een antwoord krijgen):

$ $XYMON $XYMSRV "config mijntest.cfg" >/tmp/mijntest.cfg.new
$ if [ -s /tmp/mijntest.cfg.new ]; Dan
mv /tmp/mijntest.cfg.new $XYMONHOME/etc/mijntest.cfg
fi

Verzend een zeer groot statusbericht dat is ingebouwd in het bestand "statusmsg.txt". In plaats van
om het op de opdrachtregel aan te bieden, geeft u het via stdin door aan het xymon-commando:

$kat statusmsg.txt | $XYMON $XYMSRV "@"

Gebruik xymon online met behulp van onworks.net-services