open-telemetry/opentelemetry-ruby-contrib

feat: Twirp Instrumentation

Open

#75 opened on Jul 1, 2022

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Ruby (252 forks)auto 404
help wantedkeep

Repository metrics

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

Description

https://github.com/twitchtv/twirp-ruby

  • Client instrumentation - Add RPC semantic attributes (possibly share attributes with Faraday and the adapter via HTTPClient.attributes)
  • Server instrumentation - Enrich the Rack Span with RPC server semantics and operation name, similar to how it is done with actionpack and sinatra automatic instrumentation

cc: @hmaurer

Contributor guide

Research direction
Study existing instrumentation in the repo (e.g., actionpack, sinatra) and the twirp ruby gem. For client instrumentation, add RPC semantic attributes using the OpenTelemetry SDK. For server instrumentation, enrich the Rack span with RPC server attributes and operation name. Follow the pattern of other instrumentations in the contrib repository.
Tech stack
ruby
Domain
backendapi
Issue type
Feature
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.
Half day
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
RubyOpenTelemetryRack
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50