Deze gids is gebaseerd op de broncode van Pulse 1.11.0. Het event
ReportGenerated in de voorbeelden is een hypothetische klasse ter illustratie. Vervang het in een echt package door je eigen event.Hoe het werkt
Wanneer een recorder een event ontvangt, voegt hij records toe aan de buffer van Pulse. De buffer wordt bij de ingest in één keer opgeslagen.Een recorder maken
Een recorder declareert de events waarop hij zich abonneert in de propertylisten en implementeert het werk in de methode record(). Het voorbeeld hieronder legt het event ReportGenerated vast dat een package dispatcht. We gaan ervan uit dat het event de properties $type en $durationMs heeft.
Ignores en Sampling lezen de hieronder beschreven instellingen ignore en sample_rate.
De recorder in de applicatie registreren
Registreer de recorder in de arrayrecorders van config/pulse.php in de applicatie. Gebruik de klassenaam van de recorder als sleutel en geef als waarde de activeringsvlag en de instellingen op.
PulseServiceProvider laadt pulse.recorders en registreert de recorders wanneer pulse.enabled aan staat. Een recorder met enabled op false wordt niet geregistreerd. In plaats van deze instelling automatisch vanuit het package te herschrijven, is het veiliger om het configuratievoorbeeld in de installatie-instructies te tonen.
Soorten aggregaties
Pulse::record() geeft een Entry terug. Door count(), min(), max(), sum() of avg() te chainen wordt het bijbehorende aggregaat in pulse_aggregates opgeslagen.
min(), max(), sum() en avg() gebruiken value in hun berekening. count() alleen heeft geen value nodig.
Wanneer een event heel vaak optreedt, vermindert onlyBuckets() het aantal rijen in pulse_entries.
Een stringwaarde opslaan
Wanneer je een string wilt opslaan, zoals de laatste status, in plaats van een getal te aggregeren, gebruik jePulse::set(). De waarde wordt opgeslagen in de tabel pulse_values.
value moet als string worden meegegeven.
Zwaar werk uitstellen
De closure die je aanPulse::lazy() meegeeft, wordt niet direct uitgevoerd. Hij draait wanneer Pulse de data inleest. Gebruik dit wanneer het vastleggen tijd kost en je het na het versturen van de response wilt uitvoeren.
De geauthenticeerde gebruiker vastleggen
Wanneer je de identifier van de geauthenticeerde gebruiker nodig hebt, gebruik jePulse::resolveAuthenticatedUserId(). Deze geeft null terug wanneer er geen gebruiker is geauthenticeerd.
Negeren, samplen en filteren
Gebruik deze vier hulpmiddelen om te beperken wat er wordt vastgelegd:- Instelling
ignore: slaat het vastleggen over wanneer de waarde die aanshouldIgnore()wordt meegegeven overeenkomt met een van de reguliere expressies. In het voorbeeld hierboven worden events overgeslagen waarvan$event->typeovereenkomt met/^debug_/. - Instelling
sample_rate: wordt gecontroleerd doorshouldSample().1legt elk event vast en0.1ongeveer 10%. Pulse::ignore(): schakelt het vastleggen binnen de callback uit en geeft het resultaat van de callback terug.Pulse::filter(): ontvangt elkeEntryofValuevóór het opslaan en slaat alleen de items op waarvoor hettrueteruggeeft.
Exceptions afhandelen
Pulse verpakt het werk van recorders en de ingest inrescue(). Exceptions die in een recorder worden gegooid, bereiken je applicatie niet. Als handleExceptionsUsing() niet is ingesteld, wordt de exception stilzwijgend weggegooid. Configureer dit in je applicatie om exceptions te rapporteren.
Testen
Om een recorder te testen, kun je het event dispatchen,Pulse::ingest() aanroepen en de opgeslagen rij controleren. Het voorbeeld hieronder is afgeleid van de broncode van Pulse en is niet uitgevoerd. Zorg ervoor dat pulse.enabled aan staat in je testomgeving.
Sleutels ontwerpen
key is de eenheid van aggregatie. Als je waarden gebruikt die onbeperkt groeien, zoals gebruikers-ID’s of URL’s, groeit de hoeveelheid data en worden de aggregaten moeilijk leesbaar. Gebruik voor key waarden uit een beperkte set, zoals eventtypes of procesnamen.