From f02648281c780d4f38fcca0dd0cf8e11d45f3689 Mon Sep 17 00:00:00 2001 From: Marcos Oliveira Soares Date: Tue, 22 Jul 2025 23:06:16 -0300 Subject: [PATCH] =?UTF-8?q?docs:=20adiciona=20instru=C3=A7=C3=B5es=20e=20t?= =?UTF-8?q?emplate=20para=20ativar=20Honeybadger=20no=20i-Di=C3=A1rio?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++ config/honeybadger.sample.yml | 5 ++ docs/README.md | 3 ++ docs/sistema-de-monitoramento-honeybadger.md | 51 ++++++++++++++++++++ 4 files changed, 63 insertions(+) create mode 100644 config/honeybadger.sample.yml create mode 100644 docs/sistema-de-monitoramento-honeybadger.md diff --git a/README.md b/README.md index cbea61105..4cf50ea42 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,10 @@ ajudar a alcançar nossos objetivos. Consulte o passo a passo no [guia de instalação](INSTALL.md). +## Documentação técnica + +Consulte a [documentação técnica](docs/README.md). + ## Perguntas frequentes (FAQ) Algumas perguntas aparecem recorrentemente. Olhe primeiro por aqui: [FAQ](https://github.com/portabilis/i-educar-website/blob/master/docs/faq.md). diff --git a/config/honeybadger.sample.yml b/config/honeybadger.sample.yml new file mode 100644 index 000000000..cbe1a22eb --- /dev/null +++ b/config/honeybadger.sample.yml @@ -0,0 +1,5 @@ +--- +production: + api_key: 'SUA_API_KEY_AQUI' + breadcrumbs: + enabled: true \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 0f052c283..32087406f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,9 @@ Detalha o processo de sincronização com o i-Educar: - Configuração e monitoramento - Tratamento de erros +### [Sistema de Monitoramento](./sistema-de-monitoramento-honeybadger.md) +Detalha o processo de ativação do monitoramento para o i-Diário: + ## Como Contribuir Para adicionar nova documentação: diff --git a/docs/sistema-de-monitoramento-honeybadger.md b/docs/sistema-de-monitoramento-honeybadger.md new file mode 100644 index 000000000..52a184ed4 --- /dev/null +++ b/docs/sistema-de-monitoramento-honeybadger.md @@ -0,0 +1,51 @@ +# Monitoramento com Honeybadger + +Este projeto possui suporte integrado ao [Honeybadger](https://www.honeybadger.io), uma ferramenta de monitoramento de erros para aplicações Ruby on Rails. + +## Visão geral + +O Honeybadger permite que erros e exceções em produção sejam monitorados automaticamente, com notificações detalhadas e breadcrumbs de contexto. A integração já está preparada no código-fonte — basta ativar a configuração com a sua API Key. + +## Como ativar o monitoramento + +1. Acesse [https://app.honeybadger.io](https://app.honeybadger.io) +2. Crie uma conta ou entre com sua conta existente. +3. Crie um novo projeto (Project). +4. No painel do projeto, copie a **API Key** disponível. +5. Copie o arquivo de configuração de exemplo: + + ```bash + cp config/honeybadger.sample.yml config/honeybadger.yml + ``` + +6. Edite o arquivo `config/honeybadger.yml` e substitua o valor da chave `api_key` pela sua API Key: + + ```yaml + # config/honeybadger.yml + --- + production: + api_key: 'SUA_API_KEY_AQUI' + breadcrumbs: + enabled: true + ``` + +> A configuração será carregada automaticamente quando o ambiente estiver definido como `RAILS_ENV=production`. + +## Exemplo de log no console + +Quando corretamente configurado, os erros serão reportados automaticamente ao painel do Honeybadger. Você também poderá ver logs como: + +```bash +[Honeybadger] Reporting error id=abc123 level=1 pid=12345 +``` + +## Arquivo incluído + +Este repositório inclui: + +- `config/honeybadger.sample.yml`: Arquivo de exemplo para facilitar a ativação. + +## Saiba mais + +- Documentação oficial: [https://docs.honeybadger.io](https://docs.honeybadger.io) +- Configurações avançadas: [https://docs.honeybadger.io/lib/ruby/reference/configuration.html](https://docs.honeybadger.io/lib/ruby/reference/configuration.html) \ No newline at end of file