open-telemetry/opentelemetry-ruby-contrib

Improve config documentation for `disallowed_notification_payload_keys` and `notification_payload_transform`

Fechada

#969 aberto em 8 de mai. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Ruby (252 forks)auto 404
documentationhelp wantedinstrumentation-action_mailerinstrumentation-action_viewkeep

Métricas do repositório

Stars
 (135 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Pilha de tecnologia
Domain
Tipo Issue
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Prerequisites
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.