open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

Fermée

#969 ouverte le 8 mai 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Ruby (252 forks)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

Métriques du dépôt

Stars
 (135 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Stack technique
Domaine
Type d'issue
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Prérequis
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.