Couchbase Capella™, our Database-as-a-Service offering, provides customers with a fully managed experience with performance, scalability, security, and manageability built in. Now, with webhook alert integration, customers can easily get Capella alerts in their third-party tools and use existing workflows to track, investigate, and resolve service issues across your various workloads in a centralized manner.
O Couchbase Capella já oferece notificações por e-mail para alertas, mas isso por si só pode às vezes ser limitante para médias e grandes empresas. Engenheiros de SRE e desenvolvedores frequentemente desejam ser notificados em sua ferramenta de escolha quando alertas são gerados em seus serviços do Couchbase Capella. Com esta nova capacidade, os clientes agora podem integrar alertas do Capella com ferramentas como o ServiceNow por meio de um webhook de entrada que eles podem configurar no Capella.
O que são Webhooks?
Webhooks são retornos de chamada HTTP definidos pelo usuário. Quando um alerta ocorre no Capella, uma solicitação HTTP é feita para a URL de webhook configurada pelo usuário, enviando o payload do alerta em JSON. Isso permite que os clientes invoquem comportamento personalizado em seus aplicativos de terceiros.
Como cliente do Capella, você pode usar o ServiceNow ou outro sistema de gerenciamento de chamados como uma única ferramenta unificada para gerenciar centralmente todos os problemas do seu ambiente de TI. Por exemplo, sempre que um alerta ocorrer no Capella, você poderá criar automaticamente um Incidente no ServiceNow da mesma forma que faz para incidentes gerados por outros aplicativos.
Integrar Alertas do 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 suporte um webhook de entrada. Uma integração de alerta exige a URL de destino para o webhook e autenticação e autorização por token básico ou de portador (bearer token).
Aqui estão alguns dos detalhes dos principais 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 a URL do Webhook de entrada deve começar com https.
- Requer assinatura Enterprise ou Developer Pro.
- Disponível para Bancos de Dados e App Services.
- Em vez de definir integrações de alerta repetidamente para cada Banco de Dados ou App Service, 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 App Services específicos.
As mensagens de notificação que uma integração de alerta envia incluem um payload 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
Crie um Conta de desenvolvedor do ServiceNow, se precisar de um. Use o APIs REST programadas recurso e crie um novo recurso. Para usar a autenticação básica para o seu webhook, crie um novo usuário no ServiceNow com as credenciais que você usará para a autenticação. Anote a URL e os detalhes de autenticação.
No Capella, adicione um integração de alertas para o projeto com os detalhes principais: Nome, URL de Webhook e informações de autenticação. A Capella oferece ambos um Interface do usuário e um API de Gerenciamento do Capella para trabalhar com integrações de alerta. Teste a conexão e adicione a integração.
Agora, sempre que ocorrer um alerta de nível crítico ou de aviso derivado de métricas no Capella Databases ou App Services, ele será enviado automaticamente para o ServiceNow.
Configuração no ServiceNow
Crie um Conta de desenvolvedor do ServiceNow se você precisar de um.
Certifique-se de que o função de usuário está definido como Administrador. Clique Começar a construir para fazer login em uma instância de desenvolvedor.
Pesquisar por APIs REST programadas, e clique em Novo botão no canto superior direito da página para criar um novo recurso. Preencha o nome da API e clique 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 desta página, em Recursos, selecionar Novo.
Digite seu nome preferido para o recurso e defina o Método HTTP como POSTE. Você pode usar o exemplo de script abaixo para registrar o JSON da solicitação no System Log. For more script examples, see this ServiceNow link.
Below is another script example that creates an incident in the Service Desk=>Incidents section:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
variável requestBody = JSON.analisar(request.body.dataString); gs.log(“Received request to create incident: “ + JSON.stringify(requestBody)); // Create a new incident record variável incidentGR = novo GlideRecord(‘incident’); incidentGR.initialize(); incidentGR.short_description = requestBody.details.resumo; incidentGR.descrição = JSON.stringify(requestBody); // Set other incident fields as needed variável sysId = incidentGR.inserir(); // Insert the incident record gs.log(“Incident created with sys_id: “ + sysId); // Return response response.setStatus(201); response.setContentType(‘application/json’); response.setBody({“sys_id”: sysId, “message”: “Incident created successfully”}); |
Click on Explore REST API link to make a note of the assigned URL. This is the Webhook URL you will use in Capella to set up the integration.
- To use basic authentication for your webhook, you need to create a new user in ServiceNow.
- Under User Administration=>Users create a new user.
- Find the newly created user and Set Password. Gerar a new password, make sure to uncheck Password needs reset, and update the user. You will use these user credentials in Capella to set up the integration.
Things are now set up in ServiceNow. Let’s head over to the Capella UI.
Setup on Capella
- Login to Capella UI.
- Select a Project in Capella and click on the “Alerts” tab.
- Click on “Add Integration”.
- Provide a user-friendly Display Name.
- Provide the ServiceNow Webhook URL, select Authentication as “Basic” and provide the Username and Password.
- Click “Test Connection” to validate that the connection is working.
- The “Test connection” in Capella will send a test JSON alert payload to the Webhook URL in ServiceNow. Save the integration.
Review the received test alert in ServiceNow.
In ServiceNow select All => System Log => Script Log Statements and filter logs to see the Capella TestAlert being received.
Conclusão
Congratulations! You are successfully set up to receive real-time Capella alerts in ServiceNow. While the above step-by-step procedure is detailed for ServiceNow, the Capella alert integration feature is generic. You can configure alert integrations for any third-party tool that supports an incoming webhook and either basic or bearer token authentication and authorization.
Conclusão
Capella alert notifications integration can be used to receive alerts in the third-party tool of your choice. This allows you to track, investigate, and resolve service issues across your various workloads centrally using familiar workflows.
Here are some additional resources that you may find useful:
- Capella: Configure an Alert Integration
- Capella: Couchbase Capella Management API (v4.0)
- Capella: Alert Reference
- ServiceNow: How to Integrate Webhooks Into ServiceNow
- ServiceNow: Scripted REST APIs
- ServiceNow: How to generate bearer token for oAuth 2.0 – Authorization Grant type
If you are new to Couchbase Capella, give it a try and see how a multi-purpose database platform can help you build powerful applications. You can get up and running in minutes with a free trial (no credit card needed). Capella iQ’s generative AI is built right in and can help you start writing your first queries with natural language text.
Deixe um comentário
Você precisa fazer o login para publicar um comentário.