tracing aparecem na página “Performance > Traces” no AppSignal.
Certifique-se de instalar o AppSignal collector antes de prosseguir com estas instruções.
Instale os crates do OpenTelemetry
Use o Cargo para adicionar às dependências da sua aplicação o SDK do OpenTelemetry, o exporter OTLP, a integração comtracing e os crates que a configuração abaixo usa:
tracing-opentelemetry: sua versão deve corresponder à dos crates do OpenTelemetry. A versão 0.29 dotracing-opentelemetryfunciona com a versão 0.28 deopentelemetry,opentelemetry_sdkeopentelemetry-otlp. Se você atualizar um, atualize o outro para uma versão correspondente.reqwest-rustls: esta feature permite que o exporter envie dados para URLs de collector comhttps://, como um collector hospedado.nix: obtém o hostname da máquina em que sua aplicação roda, que a configuração reporta comohost.name.env-filter: esta feature dotracing-subscriberpermite escolher quais spans reportar com a variável de ambienteRUST_LOG.
Configure o OpenTelemetry na sua aplicação
Adicione este móduloappsignal.rs ao diretório src da sua aplicação, ao lado de main.rs. Ele configura os exporters que enviam traces e métricas para o AppSignal collector, e os atributos que o AppSignal usa para reconhecer sua aplicação.
Antes de executá-lo, atualize estes valores no início de initialize_opentelemetry:
name: o nome da sua aplicação no AppSignal.environment: o ambiente em que sua aplicação roda, comodevelopment,stagingouproduction.push_api_key: a Push API key da sua organização, que você encontra na página de configurações Push & deploy.endpoint: mantenhahttp://localhost:8099se o collector roda na mesma máquina que sua aplicação. Caso contrário, use o endereço do seu collector. Para um collector hospedado, abra a página “Hosted Collector” nas configurações da sua organização, abra seu collector e copie a “Collector URL” dele. Se a lista estiver vazia, crie um collector lá primeiro.
Cargo.toml como a revision. O AppSignal usa a revision para criar um deploy marker sempre que você faz o deploy de uma nova versão. Uma revision pode ser um número de versão ou o SHA de um commit do Git.
O Cargo adiciona a versão ao binário quando compila sua aplicação. Assim, a revision é definida mesmo quando você faz o build em um serviço de CI, como o GitHub Actions, e executa o binário sem um repositório Git.
Incremente a versão no Cargo.toml a cada release, por exemplo quando você cria uma release no GitHub. Assim, cada deploy recebe seu próprio deploy marker.
Inicie sua aplicação com o OpenTelemetry
Chame a funçãoinitialize_opentelemetry no início da função main da sua aplicação, para que os spans criados durante a inicialização também sejam reportados. Passe para ela o nome do serviço que está sendo monitorado. O AppSignal agrupa traces por nome do serviço, então escolha um nome que descreva esta parte da sua aplicação, como “Web server” ou “Background worker”.
Antes que sua aplicação termine, chame shutdown para enviar os traces e métricas restantes ao AppSignal collector.
O exemplo abaixo usa o runtime Tokio. Se sua aplicação ainda não usa o Tokio, adicione-o com cargo add tokio@1 --features full.
O módulo appsignal.rs também imprime os logs da sua aplicação no console. Se sua aplicação já configura o logging com tracing_subscriber, por exemplo com tracing_subscriber::fmt::init(), remova essa chamada. O tracing_subscriber só pode ser configurado uma vez, então sua aplicação entra em panic na inicialização se ambos forem executados.
SIGTERM durante um deploy. Faça com que ela seja encerrada de forma graciosa ao receber um, para que o servidor pare, main continue e a chamada a shutdown seja executada. Por exemplo, use with_graceful_shutdown no axum. Sem um encerramento gracioso, sua aplicação termina antes de chamar shutdown, e os traces e métricas que ela ainda não enviou são perdidos.
Crie spans com o crate tracing
O móduloappsignal.rs reporta ao AppSignal os spans que sua aplicação cria com o crate tracing. Por exemplo, adicione o atributo #[tracing::instrument] a uma função para criar um span cada vez que ela é chamada. Cada chamada a esta função checkout cria um span chamado checkout:
#[tracing::instrument] cria spans no nível info por padrão. O módulo appsignal.rs reporta spans no nível info e acima, então esses spans chegam ao AppSignal sem configuração extra. Para reportar também spans debug, inicie sua aplicação com a variável de ambiente RUST_LOG definida como debug:
Teste o app!
Agora que todos os componentes estão conectados, inicie seu app e use-o para que ele crie spans, por exemplo enviando algumas requisições a ele. Depois, abra a página “Performance > Traces” no AppSignal para ver os traces chegando.Erros que você registra com o crate
tracing não aparecem na página “Errors >
Issue list”. O crate tracing-opentelemetry os registra sem o atributo
exception.type, que o AppSignal precisa para reportar um erro.