Integrações do Marketplace
O Marketplace permite conectar serviços externos ao Archyl e exibir seus dados como widgets ao vivo nos dashboards da sua arquitetura. Monitore deploys, acompanhe qualidade de código, observe métricas e revise alertas de segurança — tudo diretamente junto ao seu modelo C4.
Visão Geral
As integrações do Marketplace funcionam em três camadas:
- Produtos — Os serviços externos disponíveis para integração (Datadog, GitHub, SonarQube, etc.)
- Conexões — Credenciais com escopo organizacional que autenticam com a API de um produto
- Widgets — Cartões visuais colocados nos dashboards dos projetos que exibem dados ao vivo de uma conexão
Uma única conexão pode alimentar múltiplos widgets em diferentes projetos. Os widgets são atualizados automaticamente a cada 30 segundos.
Produtos Suportados
Datadog
Monitore a saúde da infraestrutura e aplicações.
| Widget | Tipo | Descrição |
|---|---|---|
| Status do Monitor | Status | Status de saúde dos monitores Datadog filtrados por tag |
| Consulta de Métrica | Contador | Valor atual de uma consulta de métrica Datadog |
| Alertas Ativos | Lista | Lista de monitores atualmente disparados |
| Dashboard Incorporado | Embed | Dashboard ou notebook Datadog incorporado |
GitHub
Acompanhe repositórios, workflows e descobertas de segurança.
| Widget | Tipo | Descrição |
|---|---|---|
| Status do Workflow | Status | Status da última execução do workflow CI |
| Pull Requests Abertos | Lista | PRs ativos com badges de status |
| Estatísticas do Repositório | Contador | Stars, forks, issues abertas ou PRs abertos |
| Alertas Dependabot | Lista | Alertas de vulnerabilidade de dependências abertos |
| Status Dependabot | Status | Severidade geral dos alertas Dependabot |
| Alertas de Secret Scanning | Lista | Segredos detectados no repositório |
| Alertas de Code Scanning | Lista | Descobertas de CodeQL ou scanning de terceiros |
| Status Code Scanning | Status | Saúde geral do code scanning |
GitLab
Monitore pipelines, merge requests e scanners de segurança.
| Widget | Tipo | Descrição |
|---|---|---|
| Status do Pipeline | Status | Status da última execução do pipeline |
| Merge Requests Abertos | Lista | MRs ativos com status |
| Estatísticas do Projeto | Contador | Stars, forks, issues abertas ou MRs abertos |
| Alertas de Vulnerabilidade | Lista | Descobertas de scanning de dependências |
| Status de Vulnerabilidade | Status | Severidade geral de vulnerabilidades |
| Alertas SAST | Lista | Descobertas de análise estática |
| Alertas de Detecção de Segredos | Lista | Segredos detectados |
| Alertas DAST | Lista | Descobertas de análise dinâmica |
Prometheus
Consulte métricas e monitore alvos.
| Widget | Tipo | Descrição |
|---|---|---|
| Consulta Instantânea | Contador | Valor atual de uma consulta PromQL |
| Consulta de Faixa | Gráfico | Gráfico de linha de séries temporais em uma faixa configurável |
| Status do Alvo | Status | Saúde do alvo de scrape por nome do job |
SonarQube
Acompanhe qualidade de código e análise de segurança.
| Widget | Tipo | Descrição |
|---|---|---|
| Status do Quality Gate | Status | Status aprovado/reprovado do quality gate do projeto |
| Métricas do Projeto | Contador | Cobertura, bugs, vulnerabilidades, code smells, dívida técnica, etc. |
| Issues | Lista | Bugs, vulnerabilidades e code smells por severidade |
| Security Hotspots | Lista | Locais de código que precisam de revisão de segurança |
| Rating de Segurança | Status | Rating geral de segurança do projeto |
ArgoCD
Monitore deploys de aplicações Kubernetes.
| Widget | Tipo | Descrição |
|---|---|---|
| Status da Aplicação | Status | Status de saúde e sincronização de uma única aplicação |
| Lista de Aplicações | Lista | Todas as aplicações com indicadores de saúde e sincronização |
| Recursos da Aplicação | Lista | Recursos Kubernetes de uma aplicação específica |
| Contagem de Aplicações | Contador | Número total de aplicações com filtros opcionais |
PagerDuty
Monitore incidentes, escalas de plantão e saúde dos serviços.
| Widget | Tipo | Descrição |
|---|---|---|
| Status de Incidentes | Status | Visão geral de incidentes disparados e reconhecidos |
| Incidentes Ativos | Lista | Incidentes atualmente ativos com urgência e serviço |
| Plantão Atual | Lista | Membros da equipe atualmente de plantão |
| Status do Serviço | Status | Visão geral da saúde dos serviços PagerDuty |
| Contagem de Incidentes | Contador | Número total de incidentes abertos |
Configurando uma Conexão
As conexões são gerenciadas no nível da organização. Apenas administradores da organização podem criar ou modificar conexões.
1. Navegue até o Marketplace
Vá para Configurações da Organização e selecione a aba Marketplace. Todos os produtos disponíveis são listados por categoria.
2. Adicione uma Conexão
- Encontre o produto que deseja conectar
- Clique em Conectar
- Insira um nome para a conexão (ex.: "Datadog Produção" ou "GitHub - Repos Backend")
- Preencha as credenciais necessárias
Cada produto requer campos de configuração diferentes:
| Produto | Campos Obrigatórios |
|---|---|
| Datadog | Chave de API, Chave de Aplicação, URL do Site |
| GitHub | Token de Acesso Pessoal |
| GitLab | Token de Acesso Pessoal, URL do GitLab |
| Prometheus | URL do Servidor |
| SonarQube | Token, URL do Servidor |
| ArgoCD | Token, URL do Servidor |
| PagerDuty | Chave de API |
3. Teste a Conexão
Clique em Testar Conexão antes de salvar. O Archyl verificará as credenciais e exibirá uma mensagem de sucesso ou erro.
4. Salve
Clique em Salvar. A conexão agora está disponível em todos os projetos da sua organização.
Adicionando Widgets
Widgets exibem dados ao vivo das suas conexões nos dashboards dos projetos.
1. Abra a Aba Integrações
No seu projeto, navegue até a visualização Integrações. Clique em Personalizar para entrar no modo de edição.
2. Adicione um Widget
- Clique no botão Adicionar Widget
- Etapa 1 — Selecionar Conexão: Escolha qual conexão usar
- Etapa 2 — Escolher Tipo de Widget: Selecione o tipo de widget (status, contador, lista, gráfico ou embed)
- Etapa 3 — Configurar: Defina o título do widget e opções específicas do produto
Tipos de Widget
Contador
Exibe um único valor numérico de forma proeminente. Use para métricas como uso de CPU, contagem de requisições, porcentagem de cobertura ou contagem de stars.
Status
Mostra um indicador de saúde com codificação por cores. Use para status de CI, quality gates, saúde de monitores ou estado de sincronização de deploy.
Lista
Exibe uma lista rolável de itens. Use para pull requests, alertas, issues ou inventários de aplicações.
Gráfico
Renderiza um gráfico de linha de séries temporais. Use para consultas de faixa Prometheus ou qualquer métrica ao longo do tempo.
Embed
Exibe uma página externa em um iframe. Use para dashboards Datadog, painéis Grafana ou qualquer URL incorporável.
Organizando Widgets
Seções
Widgets são organizados em seções nomeadas. A seção padrão é Geral.
- Criar uma seção: No modo de edição, use o campo de entrada de seção para adicionar uma nova seção
- Renomear: Clique no ícone de lápis no cabeçalho da seção
- Excluir: Clique no ícone de lixeira. Widgets da seção excluída vão para Geral
- Recolher/Expandir: Clique na seta para alternar a visibilidade da seção
Reordenando
No modo de edição:
- Arraste widgets para reposicioná-los dentro de uma seção ou movê-los para uma seção diferente
- Arraste cabeçalhos de seção para reordenar seções inteiras
- Redimensione widgets pelo canto inferior direito
Escopo
Widgets podem ter escopo em três níveis:
| Escopo | Visibilidade | Caso de Uso |
|---|---|---|
| Organização | Visível em todos os projetos | Dashboards de toda a empresa |
| Projeto | Visível apenas em um projeto específico | Métricas específicas do projeto |
| Elemento | Vinculado a um elemento C4 | Monitoramento por serviço |
Boas Práticas
Nomeie Conexões Claramente
Use nomes descritivos que indiquem o ambiente e propósito:
- "Datadog — Produção"
- "GitHub — Equipe Backend"
- "SonarQube — Projeto Principal"
Organize com Seções
Agrupe widgets relacionados em seções:
- "Monitoramento" para widgets Datadog e Prometheus
- "Segurança" para widgets de scanning de segurança SonarQube e GitHub
- "CI/CD" para widgets de status de workflow e deploy
- "Resposta a Incidentes" para widgets de incidentes e plantão PagerDuty
Comece com Widgets de Status
Widgets de status dão uma visão rápida da saúde. Adicione widgets de contador e lista para mais detalhes uma vez que tenha identificado as métricas principais.
Use Widgets com Escopo de Elemento
Vincule widgets diretamente a elementos C4 para que seus diagramas de arquitetura mostrem contexto operacional ao vivo.
Próximos Passos
- Gerenciamento de Releases — Rastreie deploys na sua arquitetura
- Insights de Arquitetura — Detecte problemas arquiteturais
- Fluxos — Visualize como os dados se movem pelo seu sistema