JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

How to prevent jsonapi-resources from logging backtraces.

Offen
#798 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

help wanted Type: Enhancement
Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Both here and here jsonapi-resources logs the complete backtrace of exceptions. We are using structured logging and don't want to have these backtraces in our logs. We are sending them to an error catcher service (like Airbrake or Honeybadger).

During a production incident with a lot of errors these backtraces flooded everything. It would be nice to completely replace the logging with a custom implementation.

Along the same lines it, it would be convenient to define that error handling in a single place. Currently you need to overwrite both handle_exceptions and an on_server_error callback. See #780

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, lib/jsonapi/acts_as_resource_controller.rb im Bereich von handle_exceptions und lib/jsonapi/operation_dispatcher.rb im Bereich von on_server_error zu lesen, und sieh dir anschließend die zugehörige Diskussion in #780 an. Verfolge, wie Ausnahmen in beiden Pfaden protokolliert werden, und ermittle den erwarteten einzelnen Anpassungspunkt; abgeschlossen ist die Aufgabe, wenn Anwendungen die Fehlerprotokollierung ohne unerwünschte Backtraces in strukturierten Logs steuern können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.