Skip to main content
Colocar seu aplicativo em funcionamento com o AppSignal não deve levar mais de dez minutos. Este guia percorre todo o processo para Ruby, Elixir, Node.js, Python e PHP, e traz links para as instruções equivalentes de qualquer outra linguagem.

Requisitos

O AppSignal tem um assistente de instalação que o guia em cada etapa, então faça login na sua conta do AppSignal antes de começar. Se você ainda não tiver uma conta, crie uma conta de usuário e depois uma organização. Consulte a documentação de sistemas operacionais suportados para garantir que seu sistema seja compatível com o AppSignal.

Adicionando seu aplicativo

Para registrar um novo aplicativo e abrir o assistente de instalação, selecione Add app na página de visão geral dos aplicativos. Se você já estiver logado, este link abre o assistente diretamente. A página de visão geral de aplicativos do AppSignal com o botão Add app O assistente primeiro pergunta em qual linguagem seu aplicativo é escrito, depois mostra as etapas de instalação para ela. Essas etapas variam por linguagem e incluem sua Push API key, a chave que informa ao AppSignal a qual organização os dados pertencem. Você também pode encontrá-la nas chaves de API da sua organização.

Instalação rápida

Ruby, Elixir, Node.js, Python e PHP seguem as mesmas cinco etapas: obter a Push API key, adicionar o pacote, configurá-lo, enviar dados de teste e fazer deploy. Selecione sua linguagem em qualquer bloco de código abaixo, e o restante desta seção seguirá sua escolha. Para JavaScript de front-end, Go e Java, vá direto para instalando outras linguagens.
O PHP precisa da extensão PHP do OpenTelemetry antes de você começar. Leia primeiro a página de requisitos do PHP.

Etapa 1: obtenha sua Push API key

Cada etapa abaixo precisa da sua Push API key em nível de organização. Abra as chaves de API da sua organização e copie a primeira chave exibida ali. O assistente de instalação também a exibe.

Etapa 2: adicione o pacote

Adicione o AppSignal às dependências do seu projeto e depois instale-as:
Ruby, Elixir, Node.js e Python compilam uma extensão nativa durante a instalação. Consulte a página de sistemas operacionais suportados para ver as ferramentas de build que seu sistema precisa. É por isso que o pnpm precisa de --allow-build: por padrão, ele suprime os scripts de lifecycle, então, sem essa flag, a extensão nunca é compilada e o AppSignal não reporta nada.

Etapa 3: configure

A etapa 2 instalou o pacote. Esta etapa cria o arquivo de configuração dele. Ruby, Elixir, Python e PHP vêm com um comando que escreve esse arquivo para você: execute-o no diretório raiz do seu aplicativo com a Push API key do assistente, e ele solicita o que mais precisar. O Node.js não tem um comando assim, então você escreve o arquivo manualmente; consulte a página de instalação do Node.js para o passo a passo completo.
O Distributed tracing exige que seu aplicativo envie os dados por meio de um collector hospedado pelo AppSignal. Crie um collector na página “Hosted Collector”, nas configurações da sua organização. Você também pode configurar o AppSignal com IA, o que cria um automaticamente.O PHP sempre envia dados por meio de um collector, então use sua “Collector URL” como o endereço do collector abaixo. Python e Ruby precisam do modo collector, que também habilita o Logging para Python. Siga o guia de configuração do collector para Python ou Ruby.
O arquivo de configuração mínimo criado é também onde você altera a configuração depois:
Não faça commit da Push API key no controle de versão. Em vez disso, leia-a a partir de uma variável de ambiente do sistema, ou defina APPSIGNAL_PUSH_API_KEY no host e deixe a chave totalmente fora do arquivo de configuração.
Alguns frameworks e bibliotecas precisam de uma etapa que o instalador não pode fazer por você:
  • Ruby: o Rails é configurado automaticamente. Sidekiq, Puma, Sinatra e outros são abordados na documentação de integrações do Ruby.
  • Elixir: continue com o guia Phoenix ou Plug se você usar algum deles.
  • Python: o AppSignal não instrumenta bibliotecas automaticamente. Adicione os pacotes das bibliotecas que você usa a partir da documentação de instrumentações do Python.
  • PHP: o instalador adiciona a auto-instrumentação de framework para você. Veja a documentação de integrações do PHP para saber o que ela cobre.
  • Node.js: carregue o appsignal.cjs antes de qualquer outra biblioteca, adicionando --require ./appsignal.cjs ao comando que inicia o app, por exemplo node --require ./appsignal.cjs index.js. Nada é instrumentado sem isso. Para TypeScript compilado, adicione --enable-source-maps para que os backtraces apontem para a sua origem .ts: node --enable-source-maps --require './appsignal.cjs' dist/src/main.js. Veja a documentação de integrações do Node.js.

Etapa 4: envie seus primeiros dados

O AppSignal só registra um novo aplicativo depois de receber dados. O comando de demonstração envia um erro e uma trace de performance para que você possa confirmar que a conexão funciona:
Os comandos appsignal install do Ruby, Elixir e PHP já executam isso para você no final, então talvez você já tenha visto isso. O Node.js não tem um comando assim, então execute a demonstração você mesmo. Execute-a novamente quando quiser, ou inicie seu aplicativo e faça algumas requisições.

Etapa 5: faça o deploy

Faça commit das alterações e deploy do seu aplicativo. Quando o aplicativo implantado começar a lidar com tráfego, os erros, traces e métricas de host aparecem no AppSignal.com. Para a referência completa da sua linguagem, leia suas páginas de instalação e configuração:

Instalando outras linguagens

Essas linguagens não usam o fluxo do instalador acima. Em vez disso, siga as próprias instruções de instalação: Para essas linguagens, inicie seu aplicativo e faça algumas requisições, ou acione um script, para reportar os primeiros dados.

Concluindo sua instalação

Depois de instalado, o assistente verifica se o AppSignal pode receber dados do seu aplicativo. Se o assistente não conseguir verificar a instalação, estamos aqui para ajudar. Um relatório de diagnóstico do host do seu aplicativo nos ajuda a encontrar a causa mais rápido. Depois que o AppSignal for instalado com sucesso, faça commit e deploy das suas alterações. O AppSignal começa a receber dados, e você está pronto. Agora é hora de configurar seu aplicativo.