open-telemetry/opentelemetry-ruby-contrib

Changes Requested for ActiveSupport instrumentation

Open

#957 opened on Apr 30, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Ruby (252 forks)auto 404
help wantedinstrumentationinstrumentation-active_supportkeep

Repository metrics

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

Description

During the SIG meeting on 2024-04-30, I brought up a few challenges of working with the existing ActiveSupport instrumentation, that were brought to our attention while instrumenting ActionMailer: https://github.com/open-telemetry/opentelemetry-ruby-contrib/pull/887

There were issues with missing options, implementation and naming that makes it difficult to use and potentially error prone. The list below includes some of the changes I would like to see:

  • Support Setting Span Kind #1016
  • Default to using the AS event name instead of splitting and inverting event names
  • Allow users to provide a proc that formats the span name #1014
  • Ingress/egress spans should default to the semantic conventions; while internal spans default to AS event name
  • Switch to allow lists instead of deny (disallow...) lists and default to excluding PII
  • Prevent users from mutating the ActiveSupport payload when extracting span attributes in notification_payload_transform
  • Map Rails key names to semantic convention key names

Contributor guide

Research direction
Examine the existing ActiveSupport instrumentation code, particularly the SpanSubscriber class and associated files. Understand how event names are currently handled and propose changes to support the listed improvements.
Tech stack
ruby
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Ruby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55