Insights de Arquitetura - Archyl Docs

Detecte automaticamente problemas arquiteturais e receba recomendações para melhorar o design do seu sistema

Insights de Arquitetura

A análise com IA do Archyl detecta potenciais problemas arquiteturais e fornece recomendações para melhorar o design do seu sistema.

Quais Insights o Archyl Detecta?

Problemas Críticos

Problema Descrição
Ponto Único de Falha (SPOF) Elementos com muitas dependências que poderiam causar falhas em todo o sistema
Problemas de Segurança Acesso direto ao banco de dados por sistemas externos, limites de segurança ausentes
Dependências Circulares Ciclos de dependência que complicam manutenção e implantação

Alta Prioridade

Problema Descrição
Alto Acoplamento Componentes com conexões excessivas a outros componentes
Elementos Superconectados Elementos com muitos relacionamentos de entrada ou saída
Redundância Ausente Serviços críticos sem mecanismos de backup ou failover

Média Prioridade

Problema Descrição
Elementos Órfãos Elementos isolados sem relacionamentos com outros componentes
Documentação Ausente Elementos sem descrições ou documentação vinculada
Nomenclatura Inconsistente Elementos que não seguem convenções de nomenclatura

Baixa Prioridade

Problema Descrição
Oportunidades de Otimização Melhorias potenciais para reduzir complexidade
Sugestões de Boas Práticas Recomendações baseadas em convenções do modelo C4

Executando Análise de Arquitetura

Análise de Projeto Único

  1. Vá para a seção Insights na barra lateral
  2. Selecione seu projeto
  3. Clique em Analisar
  4. Aguarde a conclusão da análise
  5. Revise as descobertas por severidade

Análise em Toda a Organização

Para analisar todos os projetos de uma vez:

  1. Vá para Insights na navegação principal
  2. Clique em Analisar Todos os Projetos
  3. Revise as descobertas agregadas em toda a sua organização

Entendendo os Insights

Cada insight inclui:

Nível de Severidade

  • Crítico: Requer atenção imediata
  • Alto: Deve ser tratado em breve
  • Médio: Considere tratar quando possível
  • Baixo: Melhorias desejáveis

Elementos Afetados

O insight lista todos os elementos envolvidos, com links diretos para visualizá-los no diagrama.

Recomendações

Passos acionáveis para resolver o problema:

Recomendação: Adicione uma camada de cache entre o API Gateway
e o Banco de Dados para reduzir conexões diretas ao banco e
melhorar a resiliência.

Documentação Relacionada

Links para boas práticas relevantes e padrões arquiteturais.

Gerenciando Insights

Silenciando Insights

Se um insight é intencional ou um falso positivo:

  1. Clique no insight para expandir
  2. Clique em Silenciar este insight
  3. Opcionalmente adicione um motivo
  4. O insight será ocultado da visualização principal

Visualizando Insights Silenciados

Para revisar insights silenciados:

  1. Vá para a seção Insights
  2. Ative Mostrar silenciados
  3. Revise e opcionalmente reative itens

Ações em Massa

Selecione múltiplos insights para:

  • Silenciar todos os selecionados
  • Atribuir a membro da equipe
  • Exportar como relatório

Boas Práticas

Análise Regular

  • Execute a análise após grandes mudanças na arquitetura
  • Inclua revisão de insights no planejamento de sprint
  • Acompanhe tendências de insights ao longo do tempo

Priorize por Impacto

Nem todos os insights precisam de ação imediata:

  1. Foque em severidade Crítica e Alta primeiro
  2. Considere o impacto no negócio ao priorizar
  3. Documente desvios intencionais

Compartilhe com a Equipe

  • Exporte relatórios de insights para revisões de arquitetura
  • Atribua insights a membros da equipe
  • Acompanhe a resolução na sua ferramenta de gerenciamento de projetos

Insights Comuns e Soluções

Ponto Único de Falha

Problema: Um serviço lida com toda a autenticação.

Solução:

  • Adicione um serviço de autenticação redundante
  • Implemente o padrão circuit breaker
  • Use armazenamento de sessão distribuído

Alto Acoplamento

Problema: O frontend chama diretamente mais de 10 serviços backend.

Solução:

  • Introduza um API Gateway
  • Implemente o padrão Backend for Frontend (BFF)
  • Use comunicação orientada a eventos

Dependências Circulares

Problema: Serviço A depende de B, B depende de C, C depende de A.

Solução:

  • Extraia lógica compartilhada para um novo serviço
  • Use arquitetura orientada a eventos
  • Refatore para quebrar o ciclo

Elementos Órfãos

Problema: Banco de dados sem conexões mostradas.

Solução:

  • Adicione relacionamentos aos serviços que o utilizam
  • Remova se não for mais utilizado
  • Vincule à documentação explicando o uso

Personalizando Regras de Insight

Cada organização tem padrões de arquitetura diferentes. O Archyl permite personalizar as regras que geram insights para atender aos requisitos da sua equipe.

Acessando Configurações de Regras

  1. Vá para a seção Insights
  2. Clique na aba Regras
  3. Ajuste as configurações de cada regra
  4. Clique em Salvar para aplicar as mudanças

Quando você salva as mudanças, o Archyl reanalisará automaticamente sua arquitetura com a nova configuração.

Regras Disponíveis

Ponto Único de Falha (SPOF)

Detecta elementos com muitas dependências de entrada que poderiam causar falhas em todo o sistema se ficarem fora do ar.

Configuração Faixa Padrão
Limiar 1-20 3

Aumente o limiar se sua arquitetura centraliza intencionalmente certas preocupações. Infraestrutura crítica como bancos de dados recebe escrutínio extra independentemente da configuração do limiar.

Alto Acoplamento

Identifica componentes com conexões excessivas em qualquer direção.

Configuração Faixa Padrão
Limiar de entrada 1-50 4
Limiar de saída 1-50 6

O limiar de entrada captura elementos dos quais muitos outros componentes dependem. O limiar de saída captura elementos que dependem de muitos outros componentes. Equipes de plataforma construindo bibliotecas compartilhadas podem querer limiares mais altos que equipes de produto.

Elementos Superconectados

Sinaliza elementos com muitas conexões totais (entrada + saída combinadas).

Configuração Faixa Padrão
Limiar 2-100 8

Isso captura um problema diferente do alto acoplamento: componentes que são difíceis de entender porque tocam muitas partes do sistema.

Dependências Circulares

Detecta ciclos de dependência onde A depende de B, B depende de C e C depende de A.

Configuração Opções
Habilitado Ligado/Desligado

Dependências circulares complicam testes, criam problemas de inicialização e sinalizam limites pouco claros. A maioria das equipes mantém isso habilitado.

Elementos Órfãos

Encontra elementos de arquitetura sem conexões com outros componentes.

Configuração Opções
Habilitado Ligado/Desligado

Elementos órfãos podem indicar lacunas na documentação ou serviços descontinuados que devem ser removidos.

Problemas de Segurança

Detecta padrões preocupantes como sistemas externos com acesso direto ao banco de dados.

Configuração Opções
Habilitado Ligado/Desligado

Essas descobertas são de severidade crítica e a maioria das equipes quer saber sobre elas imediatamente.

Documentação Ausente

Reporta elementos sem descrições.

Configuração Faixa Padrão
Limite de componentes 1-500 20

Para evitar relatórios esmagadores em grandes bases de código, verificações de documentação para componentes só são executadas se a contagem total de componentes estiver abaixo deste limiar. Sistemas e containers são sempre verificados.

Configurações em Toda a Organização

As regras de insight se aplicam em toda a sua organização, não por projeto. Isso garante padrões de governança consistentes em todas as equipes e projetos.

Restaurando Padrões

Clique em Restaurar padrões na aba Regras para restaurar todas as regras à configuração original.

Próximos Passos