envoyproxy/envoy

Send custom key-value pairs in ot-span-context to Zipkin

Open

#2.031 aberto em 9 de nov. de 2017

Ver no GitHub
 (3 comments) (1 reaction) (0 assignees)C++ (5.373 forks)batch import
area/tracingenhancementhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

Thanks for maintaining the great project 👍

Envoy does seem to propagate ot-span-context but drops most of the key-values included in it before sending it to Zipkin.

Would it be possible to send those key-values as binary annotations of Zipkin spans? Could I contribute it?

Context:

  • After looking into code, it turns out that Envoy as of today drops all the keys in ot-span-context other than a few, well-known keys like traceid and spanid, before sending these to Zipkin.
  • AFAIK, ot-span-context could be populated with "custom" keys and values other than these, e.g. by our apps, to provide additional context throughout multiple spans in single trace.
  • If Envoy could translate those to corresponding binary annotations in Zipkin spans, we could view those custom key-value pairs from ot-span-context in Zipkin.
  • FYI, an app like dd-zipkin-proxy allows Datadog to consume Zipkin spans containing arbitrary binary annotations so that it would also help Datadog users.

Guia do colaborador

Direção de pesquisa
Inspecione o código fonte em source/common/tracing/zipkin/tracer.cc, especialmente as linhas 53-114, para entender como o ot span context é analisado e como os spans Zipkin são criados. Identifique onde adicionar pares chave valor personalizados como anotações binárias. Em seguida, implemente as alterações necessárias para propagar esses pares.
Pilha de tecnologia
cpp
Domain
observabilitybackend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++Envoy codebase understandingZipkin tracing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45