open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

已關閉

#969 建立於 2024年5月8日

 (1 則留言) (0 個反應) (0 位負責人)Ruby (252 個分叉)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

倉庫指標

星標
 (135 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南