Contexto do trace

Este documento descreve brevemente o contexto, que se refere ao estado, e a propagação de contexto, que se refere à transmissão de informações de estado para operações filhas. Para o rastreamento distribuído, o ID de rastreamento e o ID do o período que está sendo processado precisa ser passado para operações filhas.

As operações filhas criam um período e definem os seguintes campos:

  • ID da extensão: um identificador exclusivo da operação filha. Se a mesma operação for executada várias vezes, não haverá vários períodos para essa operação, cada um com um identificador exclusivo.
  • ID do trace: o identificador exclusivo da operação completa na qual este uma determinada operação geral. O valor desse campo é fornecido pelo pai.
  • ID do período pai: o identificador exclusivo do período pai. O valor desse campo é fornecido pelo pai. Para períodos raiz, esse ID é null.

Os valores dos campos "ID do trace", "ID do período" e "ID do período pai" permitem que uma o sistema de rastreamento distribuído liga os períodos corretamente para formar um trace. Por exemplo, o Cloud Trace armazena períodos em um repositório e usa esses Campos de ID para identificar quais períodos compõem um trace.

O contexto pode incluir outras informações de estado úteis para o rastreamento distribuído. Por exemplo, o padrão do World Wide Web Consortium (W3C) inclui informações sobre se o período pai foi amostrado.

Protocolos para propagação de contexto

As seções a seguir descrevem como protocolos de solicitação específicos e propagar o contexto.

Solicitações HTTP

Para solicitações HTTP, a propagação de contexto é normalmente realizada por meio de cabeçalhos HTTP, como traceparent e tracestate, que foram padronizado pelo W3C. Os serviços do Google Cloud com suporte à propagação de contexto de trace geralmente têm suporte o traceparent e o cabeçalho X-Cloud-Trace-Context legado.

Sempre que possível, recomendamos o uso do cabeçalho traceparent nos seus aplicativos. Seu o aplicativo pode precisar usar o cabeçalho X-Cloud-Trace-Context legado pode precisar oferecer suporte ao recebimento do contexto de rastreamento em um formato diferente.

Se você tiver um aplicativo que só oferece suporte ao cabeçalho X-Cloud-Trace-Context, recomendamos que você atualize o aplicativo para oferecer suporte e priorizar o cabeçalho traceparent. Seu aplicativo pode continuar usando o cabeçalho X-Cloud-Trace-Context como uma solução alternativa.

A tabela a seguir resume algumas diferenças significativas entre os dois cabeçalhos:

Atributo Cabeçalho traceparent
 X-Cloud-Trace-Context
cabeçalho
Separadores hífens (-) barra para a direita (/) e ponto e vírgula (;)
Representação do ID do período
 Codificação Decimal

Cabeçalho X-Cloud-Trace-Context legado

O cabeçalho X-Cloud-Trace-Context usado pelo Google Cloud é anterior aos especificação W3C. Para oferecer compatibilidade com versões anteriores, alguns serviços do Google Cloud continuam aceitando, gerando e propagando o cabeçalho X-Cloud-Trace-Context. No entanto, é provável que esses sistemas também ofereçam suporte ao cabeçalho traceparent.

O cabeçalho X-Cloud-Trace-Context tem o seguinte formato:

X-Cloud-Trace-Context: TRACE_ID/SPAN_ID;o=OPTIONS

Os campos do cabeçalho são definidos da seguinte maneira:

  • TRACE_ID é um valor hexadecimal de 32 caracteres que representa um número de 128 bits.
  • SPAN_ID é uma representação decimal de 64 bits do ID do período não assinado.
  • OPTIONS é compatível com 0 (o elemento pai não foi de amostra) e 1 (o pai foi amostrado).

Solicitações gRPC

Para solicitações gRPC, a propagação de contexto é realizada usando Metadados gRPC, implementados sobre cabeçalhos HTTP. Os aplicativos gRPC podem usar o cabeçalho traceparent ou um de contexto de metadados chamada grpc-trace-bin.

Para seus componentes, recomendamos usar o cabeçalho traceparent.

Propagação de contexto para serviços do Google Cloud

Os serviços do Google Cloud podem atuar como iniciadores ou intermediários no processamento de solicitações. Por exemplo, os serviços a seguir são conhecidos por participar processando solicitações:

O suporte para iniciação e propagação de contexto de trace é de acordo com o serviço específico do Google Cloud. Para solicitar que um serviço do Google Cloud adicione suporte à propagação de contexto, use o Issue Tracker do Google.

Propagação de contexto nos seus apps

Algumas bibliotecas de instrumentação, como OpenTelemetry, propagar automaticamente um objeto context que contenha os dados necessários para rastreamento. Se você usar esses tipos de bibliotecas, os períodos geradas pelo aplicativo estão configuradas corretamente. Para conferir uma lista de bibliotecas do OpenTelemetry que oferecem suporte ao rastreamento, consulte APIs e SDKs de linguagem. Para conferir um exemplo de instrumentação, consulte Gerar traces e métricas com o Go.

Se você depende de uma biblioteca de código aberto, determine se propagação de contexto está disponível e se a configuração é necessária.

Quando não há uma biblioteca de instrumentação adequada, é necessário garantir que o aplicativo propague o contexto de rastreamento para operações filhas.

A seguir