Status, logboeken en support met WP-CLI

Op de opdrachtregel zie je met één commando of je website is geback-upt. Je haalt de logboeken en het supportrapport op, schakelt de foutopsporing, controleert de meldingen en volgt of beëindigt de lopende taak.

Ontbreekt WP-CLI nog? De handleiding staat in WP-CLI installeren. Alle commando’s van de plugin noemt De opdrachten in één oogopslag.

De uitvoer van de commando’s is Engels. Sommige acties controleren eerst de gebruiker: het commando moet lopen als de gebruiker aan wie de mappen van de plugin toebehoren. --force slaat de controle over. De paragrafen hieronder noemen de parameter daar waar die bestaat.

De toestand van de website tonen: status

status toont hetzelfde resultaat als de statustegel van de pagina Overzicht. Het commando heeft geen acties en geen parameters en wijzigt niets.

# De status van de website tonen
wp cloneworx-backup status

De eerste regel noemt de toestand. Zijn er meerdere van toepassing, dan geldt de volgorde van de tabel:

Toestand	Kleur van de statustegel	Betekenis
error	rood	De laatste back-up is mislukt.
overdue	rood	Een actief back-upplan heeft niet op tijd een goede back-up gemaakt.
disconnected	geel	Een doel is losgekoppeld.
warn	geel	De website is geback-upt; de laatste back-up eindigde met waarschuwingen.
ok	groen	De website is geback-upt.
none	grijs	Er is nog geen back-up.

Daaronder staan de details. De regels plans en operation staan er altijd, de andere alleen als er iets te noemen is:

Regel	Betekenis
last backup	De laatste back-up: taaknaam, status, einde, grootte en per doel de toestand.
last good backup	De laatste goede back-up, als dat een andere is dan de laatste.
overdue	Het achterstallige plan en hoe lang het al aan de beurt is of geen goede back-up heeft gemaakt.
disconnected	Het losgekoppelde doel met de reden. Zijn het er meerdere, dan noemt de regel het aantal.
warnings	De waarschuwingen van de laatste back-up, per soort geteld.
plans	Hoeveel plannen actief zijn, hoeveel er zijn en het aantal doelen.
alarm	De plannen waarvoor een waarschuwing wegens een achterstallige back-up loopt.
operation	De werking: het resultaat, de laatste automatische tik met zijn taakbron, WP-Cron en de zelfaanroep.

Het resultaat in de regel operation is ok, late of missing. late betekent: er is een actief plan, maar al twee uur is er geen automatische taakbron geweest. missing betekent: op de server ontbreekt een vereiste van de plugin.

De logboeken ophalen: logs

logs geeft de logbestanden van de plugin weer of schrijft alle in een tar-bestand. Er is het algemene logboek met zijn voorgangerbestand en per taak een eigen logboek.

Parameter	Betekenis	Toegestane waarden
--to	Schrijft alle logboeken in dit tar-bestand. Het bestand mag nog niet bestaan, en zijn map moet beschrijfbaar zijn. Zonder de parameter toont het commando alleen de lijst.	Pad van een bestand

# De logbestanden weergeven
wp cloneworx-backup logs

# Alle logboeken naar een tar-bestand schrijven
wp cloneworx-backup logs --to=/tmp/cloneworx-logs.tar

De lijst noemt per bestand de naam, de grootte en de laatste wijziging, aan het einde het aantal bestanden en hun grootte samen. Het tar-bestand is niet gecomprimeerd en bevat de map cloneworx-backup-logs. Het is hetzelfde bestand als bij Alle logboeken downloaden op de pagina Instellingen.

Hoe je een logboek leest, toont Het logboek lezen.

Het supportrapport maken: support

support geeft het supportrapport als tekst uit of schrijft het in een bestand. Het is hetzelfde rapport als bij Supportrapport kopiëren op de pagina Instellingen.

Parameter	Betekenis	Toegestane waarden
--to	Schrijft het rapport in dit bestand. Het bestand mag nog niet bestaan. Zonder de parameter verschijnt het rapport in de uitvoer.	Pad van een bestand

# Het rapport in de uitvoer tonen
wp cloneworx-backup support

# Het rapport naar een bestand schrijven
wp cloneworx-backup support --to=/tmp/cloneworx-bericht.txt

Het rapport heeft de onderdelen website, server, plugin, instellingen, werking, doelen, plannen, de laatste tien taken, omvang, diagnose en de laatste 40 regels van het algemene logboek. Het rapport is Engels.

Niet in het rapport staan: taaknamen en andere kenmerken van 32 tekens, de namen van doelen en plannen, de locaties en inloggegevens van de doelen, e-mailadressen en serverpaden. Doelen en plannen verschijnen met hun kenmerk, e-mailadressen alleen als aantal, paden als <wp>, <wp-content> en <uploads>. In het rapport staan het adres van de website, per doel het doeltype en de toestand en per plan ritme, roots, doelen en het getal voor Max. back-ups.

De foutopsporing schakelen: debug

Met de foutopsporing schrijft de plugin uitgebreide regels in het logboek. Na 24 uur schakelt die zichzelf uit. In de interface heet de schakelaar Foutopsporing gedurende 24 uur.

Actie	Doel
debug on	Schakelt de foutopsporing in en noemt het tijdstip tot wanneer die loopt.
debug off	Schakelt de foutopsporing uit.
debug status	Toont of de foutopsporing loopt en tot wanneer. Zonder actie doet wp cloneworx-backup debug hetzelfde.

on en off kennen de parameter --force.

# Foutopsporing inschakelen
wp cloneworx-backup debug on

# De status tonen
wp cloneworx-backup debug status

# Foutopsporing uitschakelen
wp cloneworx-backup debug off

Kan de plugin zijn logboek niet schrijven, dan waarschuwt elk van de drie acties en noemt de reden.

De meldingen controleren: notify

Actie	Doel
notify status	Toont de ontvangers, de drie schakelaars van de meldingen, de lopende waarschuwingen wegens achterstallige back-ups, de laatste controle, de laatste verzonden e-mail en de laatste mislukking bij het verzenden. Zonder actie doet wp cloneworx-backup notify hetzelfde.
notify check	Controleert nu of een plan achterstallig is. Begint daarbij een waarschuwing of is een herinnering aan de beurt, dan verzendt de plugin de e-mail als deze melding is ingeschakeld.
notify test	Verzendt een testmail naar de ingevulde ontvangers. Is er niemand ingevuld, dan gaat die naar het adminadres van de website.

check en test kennen de parameter --force.

# De stand van de meldingen tonen
wp cloneworx-backup notify status

# Nu op achterstallige back-ups controleren
wp cloneworx-backup notify check

# Een testmail verzenden
wp cloneworx-backup notify test

Een plan is achterstallig als zijn laatste goede back-up ouder is dan zijn ritme plus een tolerantie. De tolerantie is het halve ritme, minstens 6 uur: een dagelijks plan is na 36 uur achterstallig. Vanzelf loopt deze controle bij elke taakbron, hoogstens elke 15 minuten.

notify check noemt de achterstallige plannen en telt hoeveel waarschuwingen zijn begonnen, herinnerd en beëindigd en hoeveel e-mails zijn verzonden. notify test noemt de adressen waar de testmail naartoe ging. Weigert WordPress het verzenden, dan eindigt het commando met een fout en noemt het de reden.

De ontvangers en de schakelaars wijzig je met wp cloneworx-backup settings; zie Instellingen en omvang met WP-CLI.

Nieuws aan- en afmelden: news

news toont, begint of beëindigt de aanmelding voor nieuws over cloneworx Backup. In de interface is dat de schakelaar Informeer mij over belangrijk nieuws en updates van cloneworx Backup.

Actie	Doel
news status	Toont de toestand: off, pending (de bevestiging staat nog uit) of subscribed. Het adres verschijnt alleen verkort. Zonder actie doet wp cloneworx-backup news hetzelfde.
news subscribe	Meldt het adres uit --email aan.
news unsubscribe	Meldt af. In de plugin geldt dat meteen.

Parameter	Betekenis	Toegestane waarden
--email	Alleen subscribe: het adres dat wordt aangemeld. Verplicht.	een e-mailadres
--force	Alleen subscribe en unsubscribe: loopt ook als andere gebruiker.	zonder waarde

# De status tonen
wp cloneworx-backup news status

# Een adres aanmelden
wp cloneworx-backup news subscribe --email=admin@example.com

# Afmelden
wp cloneworx-backup news unsubscribe

Bereikt de plugin de nieuwsserver niet of weigert de server, dan eindigt news subscribe met een fout en noemt het de reden. Er is dan niets aangemeld. Bevestigt de server een afmelding niet, dan waarschuwt news unsubscribe; in de plugin is de aanmelding toch beëindigd.

De lopende taak volgen, uitvoeren, afbreken: job

Een back-up, een herstel, een controle: alles wat langer duurt, loopt als taak in veel korte stappen. Per website loopt altijd maar één taak. job werkt met de taak die nu loopt.

Actie	Doel
job status	Toont de lopende taak. Zonder actie doet wp cloneworx-backup job hetzelfde.
job run	Voert de lopende taak in dit proces tot het einde uit, zonder pauzes tussen de stappen.
job abort	Noteert het afbreken. De taak stopt bij zijn volgende stoppunt, ruimt op en eindigt als afgebroken.
job probe	Start een proefrun: een taak zonder gegevens die de server meet.

# De lopende taak tonen
wp cloneworx-backup job status

# De lopende taak hier tot het einde uitvoeren
wp cloneworx-backup job run

# De lopende taak afbreken
wp cloneworx-backup job abort

job status noemt de taaknaam, het type van de taak, wie hem heeft gestart en of er nu een stap werkt. Daaronder staan de voortgang met fase, items, bytes en resterende tijd en de tellers: stappen, hard beëindigde stappen, pogingen zonder voortgang, waarschuwingen. Loopt er geen taak, dan zegt het commando dat.

job run schrijft per stap een regel en aan het einde het resultaat van de taak. Voert al een ander proces de taak uit, dan wacht het commando kort en geeft het daarna op. De taak loopt zonder het commando verder.

De proefrun: job probe

De proefrun meet hoe lang een stap op jouw server werkelijk overleeft, welke taakbronnen aankomen, hoe snel de werkmap schrijft en hoeveel werkgeheugen er is. Hij back-upt niets en raakt geen doel aan.

Parameter	Betekenis	Toegestane waarden
--units	Het aantal werkeenheden.	geheel getal, standaard 200
--unit-ms	Het nagebootste werk per eenheid in milliseconden.	geheel getal, standaard 50
--background	Het commando start de proefrun en stuurt de eerste zelfaanroep. Daarna voert de taak zichzelf via de webserver uit. Het resultaat toont dan de grenzen van de webserver, niet die van de opdrachtregel.	zonder waarde
--force	Loopt ook als andere gebruiker.	zonder waarde

# Een proefrun over meerdere stappen: ongeveer 100 seconden
wp cloneworx-backup job probe --units=2000 --unit-ms=50

# Dezelfde proefrun, uitgevoerd door de webserver
wp cloneworx-backup job probe --units=2000 --unit-ms=50 --background

Het resultaat staat daarna ook op de pagina Instellingen in de tegel Systeem en support, in het blok Diagnose van de weergave Uitgebreid.

Overige diagnosetaken

Drie verdere acties starten diagnosetaken. Geen ervan maakt een back-up; wat ze schrijven, verwijderen ze aan het einde weer.

Actie	Doel	Eigen parameters
job filelist	Bouwt de bestandenlijst op: wat een back-up zou bevatten, wat wordt weggelaten en of de vrije ruimte voldoende is.	--roots, --targets
job dbexport	Exporteert de database naar de werkmap, leest de export terug en vergelijkt de rijen per tabel.	--tables, --no-snapshot
job files	Schrijft het bestandsdeel van een back-up in de werkmap en controleert elk deel. Met --targets draagt de taak de delen over naar deze doelen, controleert ze daar en verwijdert ze weer.	--roots, --targets, --part-limit (grootte van een deel in MB, standaard 256)

Alle drie kennen bovendien --max-per-step, --background en --force.

# Tonen wat een back-up van de uploads en plugins zou bevatten
wp cloneworx-backup job filelist --roots=wp-uploads,wp-plugins

# De export van de database controleren
wp cloneworx-backup job dbexport

Zie ook

• Voortgang, meldingen en logboek
• Het logboek lezen
• E-mailmeldingen instellen
• Hulp krijgen: supportrapport, foutopsporing en diagnose
• Planning en systeem-cron met WP-CLI