open-telemetry/opentelemetry-ruby-contrib
Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`
クローズ
#969 opened on 2024/05/08
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep
Repository metrics
- Stars
- (135 個のスター)
- PR merge metrics
- (PR metrics pending)
説明
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
optionsmethod call to include descriptions
Try to apply the documentation updates to all instrumentation with these configuration options.