PagerDuty Passo a Passo do Integration

Saiba como integrar o Oracle Cloud Infrastructure Notifications ao PagerDuty para que você possa acionar incidentes do PagerDuty.

Visão Geral

A integração com PagerDuty envolve as tarefas a seguir.

Criar um Ponto Final PagerDuty

Para concluir esse procedimento, você deve ter uma das seguintes funções em PagerDuty: Gerente, Administrador, Administrador global ou função base de proprietário da conta.

Vá para PagerDuty.
No menu Configuração, selecione Serviços.
Em sua página Serviços:
1. Se você estiver criando um serviço para sua integração, selecione +Add Novo Serviço.
2. Se você estiver adicionando sua integração a um serviço existente, selecione o nome do serviço ao qual deseja adicionar a integração. Em seguida, selecione a guia Integrações e selecione o botão +New Integração.
Digite um Nome de Integração no formato monitoring-tool-service-name.

Se você estiver criando um serviço para sua integração, em Configurações de Incidente, especifique a Política de Escalação, a Urgência de Notificação e o Comportamento de Incidente para seu novo serviço.
Selecione seu tipo de ponto final preferido no menu Tipo de Integração com base nas seguintes opções:
- Oracle Cloud Infrastructure Monitoring: Se você quiser que as mensagens sejam publicadas apenas por alarme (usando o formato de mensagem de alarme). Para esse tipo de ponto final, PagerDuty responde de acordo com o formato da mensagem:
  - As mensagens que usam os formatos de mensagem genéricos são ignoradas. Por exemplo, se sua regra de evento disparar a publicação de uma mensagem no tópico que contém essa assinatura ou se você publicar diretamente uma mensagem no tópico usando o serviço Notifications, nenhum incidente PagerDuty será criado.
  - As mensagens que usam o formato de mensagem de alarme são processadas. Por exemplo, se seu alarme acionar a publicação de uma mensagem para o tópico, que está no formato de mensagem de alarme, um incidente PagerDuty será criado.
- Transformador de Evento Personalizado: Se você quiser que qualquer mensagem gere um incidente PagerDuty, sejam elas provenientes de regras de evento, alarmes, conectores, anúncios da console ou publicações diretas. As mensagens enviadas para este ponto final seguem o formato de mensagem genérico.
  
  Para obter mais informações sobre o Custom Event Transformer, consulte a documentação PagerDuty.
Selecione o botão Adicionar Serviço ou Adicionar Integração para salvar sua nova integração.
Você será redirecionado para a página Integrações do seu serviço.
Copie a Chave de Integração e o URL de Integração para sua nova Integração e mantenha-a em um local seguro para uso posterior.
Exemplo de uma PagerDuty Chave de Integração e um URL de Integração (no momento em que este documento foi publicado):

Agora você tem a chave de integração necessária para criar uma assinatura PagerDuty no Notifications.

Criar uma Assinatura PagerDuty

Para concluir este procedimento, você deve ter acesso a Notificações e permissões para criar tópicos e assinaturas. Consulte Protegendo Notificações (Políticas do Serviço IAM).

Na página da lista Tópicos, selecione Criar Tópico. Se precisar de ajuda para localizar a página da lista, consulte Listando Tópicos.
No painel Criar Assinatura, para Protocolo, selecione PagerDuty.
O campo URL é exibido com um espaço para você adicionar a chave de integração.
- Protocolo: Selecione PagerDuty.
- URL:
  Digite (ou copie e cole) a parte da chave de integração do URL de sua assinatura do PagerDuty. Essa parte é o ponto final PagerDuty. (As outras partes do URL são codificadas.)
Selecione Criar.

A assinatura PagerDuty foi criada. Ele permanece no status "Pendente" até que a confirmação seja recebida.
Confirme a nova assinatura do PagerDuty:
1. Vá para PagerDuty.
2. Acesse o incidente intitulado "Confirmação de Inscrição no Oracle Notification Service".
3. Selecione o link URL de Confirmação.
Exemplo de incidente de confirmação (no momento em que este documento foi publicado):

Agora que você tem uma assinatura confirmada que faz referência ao seu ponto final PagerDuty, é possível testar a integração publicando diretamente uma mensagem no tópico pai.

Testar uma Assinatura PagerDuty (Publicação Direta)

Para concluir este procedimento, você deve ter acesso a Notificações e permissões para publicar mensagens. Consulte Protegendo Notificações (Políticas do Serviço IAM).

1. Na página da lista Tópicos, localize o tópico com o qual você deseja trabalhar. Se precisar de ajuda para encontrar a página da lista ou o tópico, consulte Listando Tópicos.
2. No menu Ações (três pontos) do tópico, selecione Publicar Mensagem.
3. Na caixa de diálogo Publicar Mensagem, forneça valores para os seguintes campos: informe os itens exigidos pelo seu tipo de integração.
  
  Para Transformador de Evento Personalizado, informe uma Mensagem e um Título.
  
  Exemplo de mensagem: "Utilização não ideal detectada. Um aplicativo ou processo pode estar consumindo mais CPU do que o habitual."
  
  Exemplo de Título: "Alarme Não Ideal"
  
  Para o Oracle Cloud Infrastructure Monitoring, digite uma Mensagem que contenha um blob JSON com pares de chave/valor para severity (string, obrigatório) e um ou mais dos seguintes: title (string), body (string) e alarmMetaData (blob ou array JSON).
  
  Exemplo de blob JSON:
  { "title": "my test alarm", "body": "my test body", "severity": "warning", "alarmMetaData": { "key1": "value1", "key2": "value2" } }
  
  O valor severity é flexível para teste. Para produção, use um valor suportado por PagerDuty, como critical, error, warning ou info.
4. Selecione Publicar.
  Um incidente PagerDuty é acionado contendo o conteúdo da sua mensagem.
  Exemplo de incidente PagerDuty acionado (no momento em que este documento foi publicado):
  Exemplo do conteúdo de um incidente PagerDuty acionado (no momento em que este documento foi publicado):
  Você confirmou que a publicação direta de uma mensagem aciona um incidente PagerDuty. Em seguida, use sua nova assinatura para acionar incidentes PagerDuty de alarmes, eventos e conectores.
  Observação
  
  Para verificar o URL do ponto final ou outros detalhes da assinatura PagerDuty, consulte Obtendo Detalhes de uma Assinatura. Para obter informações de diagnóstico e solução de problemas relacionadas a mensagens publicadas, consulte Mensagem Não Recebida.
Use o comando oci ons message publish e os parâmetros necessários para publicar uma mensagem em um tópico:
oci ons message publish --body <message_text> --topic-id <topic_OCID>
Para obter uma lista completa de parâmetros e valores para comandos da CLI, consulte a Referência de Linha de Comando para Notificações.

Execute a operação PublishMessage para publicar uma mensagem em um tópico.

Exemplo de solicitação para um ponto final PagerDuty do tipo Transformador de Evento Personalizado:

POST /20181201/topics/<topic_OCID>/messages
Host: <topic API endpoint>
<authorization and other headers>
{
  "title": "Non-Optimal Alarm",
  "body": "Non-optimal utilization detected. An application or process may be consuming more CPU than usual."
}

Acionar um Incidente PagerDuty

Acione um incidente em PagerDuty de uma assinatura de alarme, evento, conector ou anúncio usando uma assinatura no Notifications.

Ao criar um alarme, uma regra de evento, um conector ou uma assinatura de anúncio, selecione o tópico Notificações que contém a assinatura PagerDuty. Para obter instruções sobre como criar esses recursos, consulte a documentação a seguir.

Observação

Para verificar o URL do ponto final ou outros detalhes da assinatura PagerDuty, consulte Obtendo Detalhes de uma Assinatura.