Skip to content
BeryX
Back to the app guide

BeryX documentation

This technical document is available in Portuguese.

Notificações

Leva os alertas do BeryX para onde a equipa já trabalha: Slack, Microsoft Teams, email ou um webhook. Aqui também configuras as escalas de piquete, os tickets no Jira ou no Linear e o repositório git para as correções aprovadas.

O que podes fazer

  • Criar um canal com «Novo canal»: tipo (Slack, Microsoft Teams, Email ou Webhook genérico), destino, severidade mínima e digest semanal. Com domínios de acesso restrito no workspace, só os admins criam ou alteram um canal sem equipa, que recebe os alertas de todos os datasets. Se não fores admin, escolhe para o canal uma equipa que não leia nada que tu não leias, como uma equipa tua.
  • Escolher o que chega a cada canal com «Âmbito»: domínios, conexões, tipos de problema e monitores automáticos. Sem nada escolhido, o canal recebe todos os alertas; a pré-visualização mostra quantos dos últimos 30 dias lá teriam chegado.
  • Escolher que eventos um canal recebe com «Eventos»: os alertas de qualidade e, se quiseres, as mudanças de veredito de um dataset ou de um domínio e as violações de política abertas ou resolvidas. Estas saem no fim de cada scan, só quando o estado muda, e aparecem também no sino.
  • Um domínio que está no âmbito de um canal só se apaga depois de o retirares de lá. Se apagares uma conexão, o «Âmbito» mostra-a como apagada: não corresponde a nada até a retirares.
  • Testar, desativar ou apagar cada canal a partir do seu cartão. O cartão mostra a «Última entrega» (entregue ou falhou, com o motivo) e, no webhook genérico, o «Testar» diz se o recetor aceitou a entrega assinada. Com domínios de acesso restrito, só os admins testam, desativam ou apagam um canal sem equipa, ou o de uma equipa que lê o que tu não lês.
  • No «Webhook genérico», guardar o secret de assinatura que aparece uma vez ao criar o canal e, se for preciso, «Rodar secret» (só admins). Contrato, assinatura e retry: Webhooks.
  • Definir as «Rotas por severidade» (só admins) e as «Escalas semanais por domínio»: um problema sem reconhecimento sobe à pessoa seguinte da escala, pelos canais e por email.
  • Marcar «O meu horário silencioso» para não receberes páginas nesse período; os canais da equipa continuam a receber tudo.
  • Ligar o Jira ou o Linear para criar tickets a partir de um issue com «Criar ticket».
  • Ligar um repositório GitHub ou GitLab para as correções aprovadas seguirem como Pull Request, com revisão humana antes do merge; o BeryX nunca escreve nas fontes de dados.

Ver também

  • Problemas — os issues que geram alertas e tickets.
  • Sugestões — as correções que, aprovadas, seguem como Pull Request.

English

Notifications

Send BeryX alerts to where the team already works: Slack, Microsoft Teams, email or a webhook. This is also where you set up on-call rotations, Jira or Linear tickets and the git repository for approved fixes.

What you can do

  • Create a channel with “New channel”: type (Slack, Microsoft Teams, Email or Generic webhook), destination, minimum severity and weekly digest. With restricted-access domains in the workspace, only admins create or change a channel without a team, which receives the alerts of every dataset. If you are not an admin, pick a team for the channel that reads nothing you cannot read, such as one of your teams.
  • Choose what reaches each channel with “Scope”: domains, connections, issue types and automatic monitors. With nothing selected the channel receives every alert; the preview shows how many from the last 30 days would have reached it.
  • A domain in a channel's scope can only be deleted after you remove it from there. If you delete a connection, “Scope” shows it as deleted: it matches nothing until you remove it.
  • Test, disable or delete each channel from its card. The card shows the “Last delivery” (delivered or failed, with the reason) and, for the generic webhook, “Test” tells you whether the receiver accepted the signed delivery. With restricted-access domains, only admins test, disable or delete a channel without a team, or the channel of a team that reads what you cannot read.
  • For the “Generic webhook”, store the signing secret shown once when the channel is created and, if needed, “Rotate secret” (admins only). Contract, signature and retries: Webhooks.
  • Set the “Routes by severity” (admins only) and the “Weekly rotations by domain”: an unacknowledged issue escalates to the next person in the rotation, through the channels and by email.
  • Set “My quiet hours” so you are not paged during that time; the team channels still receive everything.
  • Connect Jira or Linear to create tickets from an issue with “Create ticket”.
  • Connect a GitHub or GitLab repository so approved fixes go out as a Pull Request, with human review before the merge; BeryX never writes to data sources.

See also

  • Issues — the issues that trigger alerts and tickets.
  • Suggestions — the fixes that, once approved, go out as a Pull Request.