DLogger
DLogger is een xslweb app die de ontwikkelaar een intuïtieve toegang geeft tot tussenresultaten in een run. Bijvoorbeeld, het request document, de atomaire waarde van een variabele, een tussentijds opgebouwd XML fragment, etc.
Deze waarden worden door DLogger getoond in de volgorde waarin deze door de ontwikkelaar zijn gelogged. Dat kan binnen één run (één aanroep van de web applicatie), of over een reeks van runs heen.
De DLogger oplossing bestaat uit een viewer (verplicht), een XSL stylesheet voor de client applicaties (verplicht), een deployment stylesheet (optioneel), en een demo client applicatie (optioneel).
Dlogging in de client applicatie
In een XSLweb applicatie neem je twee soorten functie calls op naar DLogger: dlogger:init() en dlogger:save(). Beide calls geven altijd een lege sequence terug.
dlogger:init($clear as xs:boolean) as empty-sequence()
Dus bijvoorbeeld:
<xsl:sequence select="dlogger:init(true())"/>
Deze call verwijdert alle informatie van een eerdere run uit het geheugen. Deze call plaats je dus typisch in de request-dispatcher, dus wordt aangeroepen voordat de werkelijke verwerking van de request plaatsvindt.
<xsl:sequence select="dlogger:init(false())"/>
Deze call laat alle informatie van een eerdere run in het geheugen staan, maar signalleert wel een nieuw proces. Deze call plaats je dus typisch op een plek waar je verwacht dat de viewer opnieuw het geheugen uitleest en toont.
Vanaf dat moment wordt sequentieel iedere aanroep van DLogger toegevoegd aan de lijst:
<xsl:sequence select="dlogger:save('string','Hello!')"/>Hier wordt de string ‘Hello!’ bewaard onder de naam ‘string’. Later kan deze waarde onder die naam weer worden opgevraagd.
Andere mogelijke waarden zijn onder andere:
<xsl:sequence select="dlogger:save('string','Hello!')"/>
<xsl:sequence select="dlogger:save('hello variable',$hello)"/>
<xsl:sequence select="dlogger:save('hello variable (native)',$hello,'native.xml')"/>
<xsl:sequence select="dlogger:save('hello variable (content)',$hello/node())"/>
<xsl:sequence select="dlogger:save('hello variable (attribute)',$hello/@galaxy)"/>De hier getoonde waarden worden als 1 t/m 5 (in die volgorde) bewaard en later, in de viewer, getoond.
Het formaat van de DLogger call is:
Dlogger:save($label as xs:string, $items as item()*, $type as xs:string) as empty-sequence()
Hierbij geldt het volgende
$labelmag alles zijn, handigste is het een unieke naam te geven waarmee de log positie snel kan worden opgespoord in de XSL code.$itemsmag alles zijn, waarbij geldt datAls één item wordt weergegeven wordt het getoond zoals verwacht.
Als een attribuut of meerdere items worden meegegeven, dat worden deze in een <dlogger-wrapper> opgenomen; deze wordt altijd met inspringing weergegeven zodat de xml struktuur eenvoudiger te volgen is.
Voor
$typegeldt het volgende.$typeis optioneel.Dlogger is in staat zelf te bepalen dat het XML betreft. Het type wordt dan “xml” tenzij ander opgegeven.
Als voor
$typede waarde “xml” wordt meegegeven wordt de XML met inspringing getoond.Als “native.xml” wordt meegegeven wordt (als het XML betreft) de XML native getoond, dus zonder formattering. In dat geval wordt de XML via [Download] opgeslagen als
[$label].native.xml.Als voor
$typeeen andere waarde is opgegeven wordt aangenomen dat dat een valide typering zou zijn van het $item. Typisch voorbeeld is “json” of “html”. Herkend worden: xml, html, xhtml, json, txt.Als DLogger de content niet herkent als xml en er is geen type opgegeven, dat wordt “txt” aangenomen.
DLogger viewer
De DLogger viewer kan worden opgestart in dezelfde XSLweb context (lees: installatie) als die welke de DLogger -calls doet. Het kunnen dus meerdere XSLweb applicaties zijn.
Bij opstarten wordt een “leeg” scherm getoond.
Door de naam van een XSLweb applicatie te kiezen (bijv. “DLogger-client”) wordt die applicatie “gemonitord”. De client applicatie wordt pas aangeboden als deze applicatie een dlogger:init() heeft uitgevoerd.
Informatie voor die client komt pas beschikbaar als
De applicatie een log schrijft (via
dlogger:save())De naam van de applicatie is ingevoerd in de DLogger viewer, vóór de knop [Refesh].
De [Refresh] knop is ingedrukt, of (elke 3 seconden) wanneer [Live] is aangevinkt.
Op dat moment wordt de client applicatie met de naam DLogger-client gemonitord. In eerste instantie gebeurt niets, óf de informatie van de laatste run van de client applicatie wordt getoond.
Start nu de client applicatie (in een ander venster, of in een andere browser). De tabel wordt automatisch gevuld met de logs die zijn uitgestuurd door aanroepen in de client applicatie.
De weergave van deze functie aanroepen is:
Door op de tweede hello variable te klikken laadt de waarde in het rechter scherm. Dit is een weergave van de inhoud van de waarde, in dit geval een enkel XML element.
De weergave van sequences van méér dan een item wordt duidelijk gemaakt middels ellipsis:
<xsl:sequence select="dlogger:save('sequence A',(1, 3, 5))"/>
<xsl:sequence select="dlogger:save('sequence B',(1, $hello))"/>Levert twee ingangen met een ellipsis. Het type is het type van het éérste item in de sequence. Om de waarden te zien klik je op het linkje:
Er wordt hier gebruik gemaakt van een “XML wrapper” om de inhoud expliciet te maken.
Kort even de zichtbare velden op de pagina.
Middels [Refresh] haal je de laatste info op, zoals beschreven.
Vink [Live] aan om automatisch (elke 3 seconden) de laatste situatie op te halen.
Met [Restart] maak je alle geheugen vrij en kun je nieuwe DLogs lezen. Dit is vooral van belang als je niet initialiseert met de “clean” optie (en de logs dus langzaam aangroeien).
Middels [Show HTML] kan HTML content getoond worden als HTML. Natuurlijk kan alleen een complete HTML pagina (met CSS en JS daarbinnen) alleen een werkelijk sluitende weergave van de HTML opleveren.
Middels [Load] kun je de inhoud in een tweede browser venster bekijken, wat soms handig is bij grotere bestanden, en als de browser de document-boom interactief laat benaderen.
Middels de knop [Download] kun je de waarde als bestand opslaan.
Het veld [Search] links in het scherm: Je kunt snel zoeken in een mogelijk lange lijst van gelogde waarden. Meer karakters beperkt de lijst, verwijderen breidt deze weer uit.
Het veld [Search] rechts in het scherm: highlight de ingetikte tekst in het venster.
Reflexion
Omdat het soms handig is te weten wáár precies de betreffende informatie was gelogged, en omdat het niet handig is om dat steeds zelf expliciet mee te geven bij iedere dlogger:save() aanroep, is het mogelijk de stylesheets te deployen via een reflexion stylesheet. Deze transformatie kun je het beste aanroepen op iedere (nieuwe, aangepaste) stylesheet, dus tijdens deployment naar een ontwikkelomgeving (dus typisch vanuit je GIT ontwikkelomgeving naar je lokale xslweb omgeving).
Deze stylesheet past de dlogger:save($name,$item) call aan, en plaatst drie parameters:
dlogger:save-reflexion($stylesheet-pad,$container-type,$container-name,$name,$item)
Hierdoor wordt de context uitgebreid met deze informatie, en de weergave wordt in dat geval:
De functie dlogger:save-reflexion() is onderdeel van de standaard dlogger-common.xsl stylesheet.
Let op, de reflection stylesheet laat de indentatie van de oorspronkelijke stylesheet niet intact. Hierdoor is het niet altijd mogelijk een foutmelding van Saxon (met regelnummering) goed te interpreteren. De keuze om reflexion in te zetten is dus afhankelijk van je prioriteiten: behoefte precies na te gaan waar een Dlog is geschreven, of behoefte altijd een exacte foutlocatie van Saxon door te krijgen.