open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

Chiusa

#969 aperta il 8 mag 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Ruby (252 fork)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

Metriche repository

Star
 (135 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Tech stack
Dominio
Tipo issue
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Prerequisiti
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.