open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

Geschlossen

#969 geöffnet am 08.05.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Ruby (252 Forks)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

Repository-Metriken

Stars
 (135 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The new Action Mailer instrumentation (https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/887) and existing instrumentation for Action View include configuration options named disallowed_notification_payload_keys and notification_payload_transform. They may also be present in other Rails-related instrumentation.

These options don't have a lot of documentation.

We should consider:

  • Updating the README to describe these options
  • Updating the class comments in the file that contains the options method call to include descriptions

Try to apply the documentation updates to all instrumentation with these configuration options.

Contributor Guide

Research-Richtung
Tech Stack
Domain
Issue Type
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Voraussetzungen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.