O Couchbase Capella™, nossa oferta de banco de dados como serviço, oferece aos clientes uma experiência totalmente gerenciada com desempenho, escalabilidade, segurança e capacidade de gerenciamento incorporados. Agora, com a integração de alertas via webhook, os clientes podem obter facilmente alertas do Capella em suas ferramentas de terceiros e usar os fluxos de trabalho existentes para rastrear, investigar e resolver problemas de serviço em suas várias cargas de trabalho de forma centralizada.
O Couchbase Capella já fornece notificações por e-mail para alertas, mas isso, por si só, pode ser limitante para empresas de médio e grande porte. Os SREs e os desenvolvedores geralmente querem ser notificados na ferramenta de sua preferência quando os alertas são gerados nos serviços do Couchbase Capella. Com esse novo recurso, os clientes agora podem integrar os alertas do Capella a ferramentas como o ServiceNow por meio de um webhook de entrada que pode ser configurado no Capella.
O que são webhooks?
Webhooks são retornos de chamada HTTP definidos pelo usuário. Quando ocorre um alerta no Capella, é feita uma solicitação HTTP para o URL do webhook configurado pelo usuário, enviando a carga útil do alerta JSON. Isso permite que os clientes invoquem um comportamento personalizado em seus aplicativos de terceiros.
Como cliente da Capella, você pode usar o ServiceNow ou outro sistema de gerenciamento de problemas como uma única ferramenta unificada para gerenciar todos os problemas de forma centralizada em seu ambiente de TI. Por exemplo, sempre que ocorrer um alerta no Capella, você poderá criar automaticamente um incidente no ServiceNow da mesma forma que faz com os incidentes gerados por outros aplicativos.
Integrar alertas Capella usando Webhooks
O recurso de integração de alertas do Capella é genérico. Você pode configurar integrações de alerta para qualquer ferramenta de terceiros que ofereça suporte a um webhook de entrada. Uma integração de alertas requer o URL de destino para o webhook e a autenticação e autorização de token básico ou de portador.
Aqui estão alguns dos principais detalhes dos recursos:
-
- Crie, edite e exclua configurações usando a interface do usuário ou a API de gerenciamento público.
- Autenticação usando Basic (nome de usuário/senha) ou token de portador (token de acesso).
- Requer uma conexão segura, portanto, o URL do Webhook de entrada deve começar com https.
- Necessita de assinatura Enterprise ou Developer Pro.
- Disponível para bancos de dados e serviços de aplicativos.
- Em vez de definir repetidamente integrações de alerta para cada banco de dados ou serviço de aplicativo, você configura uma única integração de alerta no nível do projeto. Você pode limitar as notificações que uma integração de alerta envia excluindo bancos de dados ou serviços de aplicativos específicos.
As mensagens de notificação que uma integração de alerta envia incluem uma carga útil que fornece todos os detalhes do alerta em um conjunto de objetos JSON fáceis de ler.
Tutorial para receber alertas do Capella no ServiceNow
Criar um Conta de desenvolvedor do ServiceNowse você precisar de um. Use o APIs REST com script e criar um novo recurso. Para usar a autenticação básica em seu webhook, crie um novo usuário no ServiceNow com as credenciais que serão usadas para autenticação. Anote o URL e os detalhes de autenticação.
No Capella, adicione um integração de alertas para o projeto com os principais detalhes: Nome, URL do webhook e informações de autenticação. A Capella oferece tanto um IU e um API de gerenciamento da Capella para trabalhar com integrações de alerta. Teste a conexão e adicione a integração.
Agora, quando qualquer alerta de nível crítico ou de advertência derivado de métricas ocorrer no Capella Databases ou no App Services, ele será automaticamente enviado ao ServiceNow.
Configuração no ServiceNow
Criar um Conta de desenvolvedor do ServiceNow se você precisar de um.
Certifique-se de que o função do usuário está definido como Admin. Clique em Iniciar a construção para fazer login em uma instância de desenvolvedor.
Procurar por APIs REST com scripte clique no botão Novo no canto superior direito da página para criar um novo recurso. Preencha o nome da API e clique em Enviar.
Agora você deve ver sua API listada na página. Clique no nome da API para abrir uma página de configuração. Na seção inferior dessa página, em Recursos, selecione Novo.
Digite o nome de sua preferência para o recurso e defina a opção Método HTTP como POST. Você pode usar o exemplo de script abaixo para registrar o JSON da solicitação no Registro do sistema. Para obter mais exemplos de scripts, consulte este ServiceNow link.
Abaixo está outro exemplo de script que cria um incidente no Central de serviços=>Incidentes seção:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
var corpo da solicitação = JSON.analisar(solicitação.corpo.dataString); gs.registro("Recebida solicitação para criar incidente: " + JSON.stringify(corpo da solicitação)); // Criar um novo registro de incidente var incidenteGR = novo Registro GlideRecord("incidente); incidenteGR.inicializar(); incidenteGR.short_description = corpo da solicitação.detalhes.resumo; incidenteGR.descrição = JSON.stringify(corpo da solicitação); // Definir outros campos de incidente conforme necessário var sysId = incidenteGR.inserir(); // Inserir o registro do incidente gs.registro("Incidente criado com sys_id: " + sysId); // Resposta de retorno resposta.setStatus(201); resposta.setContentType('application/json'); resposta.setBody({"sys_id": sysId, "mensagem": "Incident created successfully" (Incidente criado com sucesso)}); |
Clique em Explorar a API REST para anotar o URL atribuído. Este é o URL do webhook que você usará no Capella para configurar a integração.
-
- Para usar a autenticação básica em seu webhook, é necessário criar um novo usuário no ServiceNow.
- Abaixo de Administração de usuários=>Usuários criar um novo usuário.
- Localize o usuário recém-criado e Definir senha. Gerar uma nova senha, certifique-se de desmarcar a opção A senha precisa ser redefinidae atualize o usuário. Você usará essas credenciais de usuário no Capella para configurar a integração.
- Para usar a autenticação básica em seu webhook, é necessário criar um novo usuário no ServiceNow.
Agora tudo está configurado no ServiceNow. Vamos acessar a interface do usuário do Capella.
Configuração no Capella
-
- Faça login na Capella UI.
- Selecione um projeto no Capella e clique na guia "Alerts" (Alertas).
- Clique em "Add Integration" (Adicionar integração).
- Forneça um nome de exibição fácil de usar.
- Forneça o URL do Webhook do ServiceNow, selecione Autenticação como "Básica" e forneça o Nome de usuário e a Senha.
- Clique em "Test Connection" (Testar conexão) para validar se a conexão está funcionando.
- A "Conexão de teste" no Capella enviará uma carga útil de alerta JSON de teste para o URL do webhook no ServiceNow. Salve a integração.
Revise o alerta de teste recebido no ServiceNow.
No ServiceNow, selecione Todos => Registro do sistema => Declarações de registro de script e filtrar os registros para ver o Capella TestAlert sendo recebido.
Encerramento
Parabéns! Você foi configurado com sucesso para receber alertas do Capella em tempo real no ServiceNow. Embora o procedimento passo a passo acima seja detalhado para o ServiceNow, o recurso de integração de alertas do Capella é genérico. Você pode configurar integrações de alerta para qualquer ferramenta de terceiros que ofereça suporte a um webhook de entrada e à autenticação e autorização de token básico ou de portador.
Conclusão
A integração das notificações de alerta Capella pode ser usada para receber alertas na ferramenta de terceiros de sua escolha. Isso permite que você rastreie, investigue e resolva problemas de serviço em suas várias cargas de trabalho de forma centralizada, usando fluxos de trabalho familiares.
Aqui estão alguns recursos adicionais que podem lhe ser úteis:
-
- Capella: Configurar uma integração de alerta
- Capella: API de gerenciamento do Couchbase Capella (v4.0)
- Capella: Referência de alerta
- ServiceNow: Como integrar webhooks ao ServiceNow
- ServiceNow: APIs REST com script
- ServiceNow: Como gerar token de portador para oAuth 2.0 - Tipo de concessão de autorização
Se você é novo no Couchbase CapellaExperimente e veja como uma plataforma de banco de dados multiuso pode ajudá-lo a criar aplicativos avançados. Você pode começar a trabalhar em minutos com uma avaliação gratuita (não é necessário cartão de crédito). Capella iQ's A IA generativa está integrada e pode ajudá-lo a começar a escrever suas primeiras consultas com texto em linguagem natural.