Dieser Leitfaden basiert auf dem Quellcode von Pulse 1.11.0. Das Event
ReportGenerated in den Beispielen ist eine hypothetische Klasse zur Veranschaulichung. Ersetzen Sie es in einem echten Paket durch Ihr eigenes Event.Funktionsweise
Wenn ein Recorder ein Event empfängt, legt er Datensätze im Puffer von Pulse ab. Der Puffer wird beim Ingest gesammelt gespeichert.Einen Recorder erstellen
Ein Recorder deklariert die zu abonnierenden Events in der Propertylisten und implementiert die Verarbeitung in der Methode record(). Das folgende Beispiel zeichnet das Event ReportGenerated auf, das ein Paket auslöst. Es wird angenommen, dass das Event die Properties $type und $durationMs besitzt.
Ignores und Sampling lesen die weiter unten beschriebenen Einstellungen ignore und sample_rate.
Den Recorder in der Anwendung registrieren
Registrieren Sie den Recorder im Arrayrecorders der Datei config/pulse.php der Anwendung. Verwenden Sie den Klassennamen des Recorders als Schlüssel und geben Sie als Wert das Aktivierungsflag und die Einstellungen an.
PulseServiceProvider lädt pulse.recorders und registriert die Recorder, wenn pulse.enabled aktiviert ist. Ein Recorder mit enabled auf false wird nicht registriert. Statt diese Einstellung automatisch aus dem Paket heraus umzuschreiben, ist es sicherer, das Konfigurationsbeispiel in der Installationsanleitung zu zeigen.
Aggregationsarten
Pulse::record() gibt einen Entry zurück. Wenn Sie count(), min(), max(), sum() oder avg() verketten, wird das entsprechende Aggregat in pulse_aggregates gespeichert.
min(), max(), sum() und avg() verwenden value für die Berechnung. count() allein benötigt keinen value.
Wenn ein Event sehr häufig ausgelöst wird, reduziert onlyBuckets() die Anzahl der Zeilen in pulse_entries.
Einen String-Wert speichern
Wenn Sie statt einer Zahl zum Aggregieren einen String wie den aktuellen Zustand speichern möchten, verwenden SiePulse::set(). Der Wert wird in der Tabelle pulse_values gespeichert.
value muss als string übergeben werden.
Aufwendige Arbeit verzögern
Die anPulse::lazy() übergebene Closure wird nicht sofort ausgeführt. Sie läuft, wenn Pulse die Daten einliest. Verwenden Sie sie, wenn das Aufzeichnen Zeit kostet und erst nach dem Senden der Response laufen soll.
Den authentifizierten Benutzer aufzeichnen
Wenn Sie die Kennung des authentifizierten Benutzers benötigen, verwenden SiePulse::resolveAuthenticatedUserId(). Ist kein Benutzer authentifiziert, wird null zurückgegeben.
Ignorieren, Sampling und Filtern
Mit diesen vier Werkzeugen reduzieren Sie, was aufgezeichnet wird:- Einstellung
ignore: Überspringt das Aufzeichnen, wenn der anshouldIgnore()übergebene Wert auf einen der regulären Ausdrücke passt. Im obigen Beispiel werden Events übersprungen, deren$event->typeauf/^debug_/passt. - Einstellung
sample_rate: Wird vonshouldSample()geprüft.1zeichnet jedes Event auf,0.1etwa 10 %. Pulse::ignore(): Deaktiviert das Aufzeichnen innerhalb des Callbacks und gibt das Ergebnis des Callbacks zurück.Pulse::filter(): Erhält jedenEntryoderValuevor dem Speichern und speichert nur die Einträge, für die estruezurückgibt.
Behandlung von Exceptions
Pulse umschließt die Arbeit der Recorder und das Ingest mitrescue(). Exceptions, die in einem Recorder geworfen werden, erreichen Ihre Anwendung nicht. Ist handleExceptionsUsing() nicht gesetzt, wird die Exception stillschweigend verworfen. Um Exceptions zu melden, konfigurieren Sie dies in Ihrer Anwendung.
Testen
Um einen Recorder zu testen, können Sie das Event auslösen,Pulse::ingest() aufrufen und die gespeicherte Zeile prüfen. Das folgende Beispiel ist aus dem Quellcode von Pulse abgeleitet und wurde nicht ausgeführt. Stellen Sie sicher, dass pulse.enabled in Ihrer Testumgebung aktiviert ist.
Schlüssel entwerfen
key ist die Einheit der Aggregation. Wenn Sie unbegrenzt wachsende Werte wie Benutzer-IDs oder URLs verwenden, wächst die Datenmenge und die Aggregate werden schwer lesbar. Verwenden Sie für key Werte aus einer begrenzten Menge, etwa Event-Typen oder Prozessnamen.