open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

Closed

#969 opened on May 8, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Ruby (252 forks)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

Repository metrics

Stars
 (135 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.