šŸ“”ServiƧo de Logs Remotos


āš ļø

Acesso Antecipado (Beta)

Esta documentação refere-se a uma versĆ£o em acesso antecipado do SDK Sankhya. As funcionalidades e APIs estĆ£o sujeitas a modificaƧƵes. Para obter acesso, envie um e-mail para [email protected] informando a appkey do seu projeto.

šŸ“”ServiƧo de Logs Remotos


Visão Geral

O serviƧo de logs remotos permite que aplicaƧƵes que utilizam o SDK Sankhya enviem logs de maneira centralizada para anƔlise, auditoria e monitoramento.

Essa abordagem evita que cada aplicação mantenha sua própria infraestrutura de logs e facilita:

  • Monitoramento de erros em produção
  • Auditoria de operaƧƵes crĆ­ticas
  • Detecção de comportamentos anĆ“malos
  • Suporte tĆ©cnico e diagnóstico

Como Funciona

Quando a funcionalidade estĆ” habilitada para o projeto:

  1. O SDK intercepta mensagens enviadas pelos loggers suportados.
  2. Os logs são normalizados e enriquecidos com contexto (quando disponível), como usuÔrio, transação, módulo, etc.
  3. Os logs são enviados para o serviço remoto de armazenamento e anÔlise.

NĆ£o Ć© necessĆ”rio alterar o código que jĆ” faz logging — a configuração ocorre automaticamente.


Loggers Suportados

Atualmente, os seguintes loggers são compatíveis com o serviço de logs remotos:

FrameworkSuporteObservação
Log4J 1.xāœ… SuportadoVersƵes anteriores ao Log4J2
JUL (java.util.logging)āœ… SuportadoConfiguração automĆ”tica via SDK

Ativação

A ativação é automÔtica para projetos aprovados no programa Beta. Nenhuma configuração manual adicional é necessÔria.

Para verificar se o serviƧo estƔ ativo:

  • Gere um log de nĆ­vel INFO ou superior em sua aplicação.
  • Consulte o painel de observabilidade disponibilizado pela Sankhya ou solicite confirmação ao suporte.

RecomendaƧƵes de Uso

Para aproveitar o serviƧo de logs remotos de forma eficiente:

  • Utilize nĆ­veis de log de maneira consistente (ex.: ERROR para exceƧƵes reais).
  • Inclua contexto Ćŗtil (ex.: ID de pedido, usuĆ”rio, etapa do processo).
  • Evite logar objetos grandes ou dados sigilosos.

Consequência de mÔ utilização: Logs excessivos podem aumentar custos e dificultar a anÔlise, além de impactar a performance da aplicação.


CondiƧƵes de Uso

O serviço de logs remotos não é habilitado automaticamente para todos os projetos. Para garantir estabilidade, capacidade e segurança, existem condições e regras para utilização:

  • Ɖ necessĆ”rio configurar o componente de logs na Ɓrea do Desenvolvedor para habilitar o recebimento.

Após a aprovação, o serviço é ativado sem alterações no código, desde que o projeto utilize um dos loggers suportados.