coinbase / coinbase/temporal-ruby
OpenTracing / Context propagation support
- Langage dominant
- Ruby
- Étoiles
- 287
- Forks
- 113
- Merge moyen
- 6 j 11 h
- PR mergées (30 j)
- 1
Description
As suggested by @jeffschoner-stripe and @drewhoskins-stripe, I am creating a github issue to discuss the topic of context propagation for the Ruby SDK.
# Tracing Proposal
## Why
Distributed applications are more difficult to measure and debug due
to the distributed nature of their processing. One cannot simply
attach to the running process with a debugger and capture state
since that state may be spread across multiple processes or systems.
Temporal, by its nature, is distributed. Any application written using
Temporal will also be distributed. In order to trace through the
behavior of the business logic implemented as workflow(s) and
activit(ies) we should provide support for OpenTracing and other
related tracing mechanisms.
The [Java](https://github.com/temporalio/sdk-java/tree/master/temporal-opentracing), [Go](https://docs.temporal.io/docs/go/tracing/), and [Typescript](https://docs.temporal.io/docs/typescript/interceptors) SDKs all support OpenTracing today via
context propagation. The Ruby SDK can support Tracing today without
any changes merely by allowing the programmer to pass the Tracing
context as an argument to every workflow and activity. This is sloppy
and error prone, so we should mimic the facilities exposed by the
aforementioned SDKs and allow the context to propagate automatically
using the Temporal headers.
## What
This defines the interface for passing in OpenTracing contexts to
the Temporal system. Upon configuration, the propagation of this
information should be automatic and transparent to the programmer.
Aside from initial configuration, methods should be exposed on
the workflow and activity that allow for adding to the existing
(if any) context.
### Workflow Configuration
Will fill this out in next edit... thinking about it.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Aucun fichier ni test n’est nommé ; commencez par examiner le workflow et la configuration des activités du Ruby SDK, ainsi que la gestion des headers de Temporal. L’issue n’est pas encore prête à être implémentée : l’interface de configuration du workflow est toujours inachevée, et sa finalisation nécessiterait une conception validée pour la propagation automatique du contexte, ainsi que des méthodes de workflow et d’activity permettant d’étendre le contexte existant.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- ruby
- Domaine
- distributed-systems, observability-sre
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100