Application Real-Time Monitoring Service:Use OAuth para integrar o Jira ao ARMS

Etapa 1: Configure o Jira

1. Execute os comandos do OpenSSL a seguir na interface de linha de comando (CLI) para gerar uma chave pública Rivest–Shamir–Adleman (RSA) e uma chave privada RSA.

   Nota

   Execute esses comandos em qualquer diretório. Os arquivos gerados são salvos no diretório atual.

   1. Gere uma chave privada de 1024 bits:

      openssl genrsa -out jira_privatekey.pem 1024

   2. Crie um certificado X509:

      openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365

   3. Extraia a chave privada no formato PKCS#8 para o arquivo jira_privatekey.pcks8.

      openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8

   4. Extraia a chave pública do certificado para o arquivo jira_publickey.pem:

      openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

2. Crie um link de aplicativo.

   1. Faça login no Jira, clique em no ícone de configurações no canto superior direito da página e selecione Applications.

   2. Na aba Applications, clique em Application links.

   3. Na seção Configure Application Links, insira uma URL e clique em Create new link.

      Nota

      Esta URL é arbitrária e não afeta a integração. Insira qualquer URL, como http://alerts.console.alibabacloud.com/.

   4. Na caixa de diálogo Configure Application URL exibida, ignore o aviso e clique em Continue.

      Na caixa de diálogo, a Entered URL aparece como http://alerts.console.alibabacloud.com/, e a New URL muda automaticamente para https://alerts.console.alibabacloud.com/.

   5. Na caixa de diálogo Link applications exibida, defina Application Type como Generic Application, insira AlertOauthKey em consumer key, marque a caixa de seleção create incoming link, preencha os demais parâmetros conforme necessário e clique em Continue.

   6. Na caixa de diálogo Link applications, configure os parâmetros a seguir e clique em Continue.

      Parameter	Value
      Consumer Key	AlertOauthKey
      Consumer Name	alertmanager
      Public Key	Conteúdo do arquivo jira_publickey.pem gerado na Etapa 1.

      Na seção Target Application da caixa de diálogo Link applications, defina Application URL como https://alerts.console.alibabacloud.com/, configure os parâmetros anteriores e clique em Continue.

      Após alguns instantes, o novo link de aplicativo aparece na página Configure Application Links. A lista de aplicativos mostra que o alertmanager foi adicionado com sucesso como tipo Generic Application com o status NON-ATLASSIAN.

   7. Na coluna Action do link de aplicativo, clique em no ícone de edição (). Na caixa de diálogo Configure alertmanager, clique em incoming authentication no painel à esquerda.

   8. Se o Status for Not Configured, reinsira a consumer key, o Consumer Name e a public key e clique em Save.

   9. Clique em Close.

Etapa 2: Integrar o Jira ao ARMS

1. Acesse o console do ARMS. No painel de navegação à esquerda, escolha Alert Management > Integrations.

2. Na página Integrations, clique em na aba Notification Integration e selecione Jira.

3. No assistente Add Integration, conclua as etapas a seguir.

   1. Na página Basic Information, configure os parâmetros abaixo e clique em Obtain Verification Code.

      Você será redirecionado para a página de autorização do Jira.

      Parameter	Value
      Name	Insira um nome para a integração do Jira.
      Description	Insira uma descrição para a integração do Jira.
      URL	URL da sua instância do Jira.
      Verification	Defina Authentication method como OAuth.
      Consumer key	AlertOauthKey
      Private key	Conteúdo do arquivo jira_privatekey.pcks8 gerado na Etapa 1.

   2. Na página Welcome to Jira, clique em Allow.

   3. Na página Access Approved, obtenha o código de verificação.

   4. Retorne ao assistente Add Integration no console do ARMS. Cole o código no campo Verification Code e clique em Obtain Access Token.

   5. Quando Obtaining Access Token Succeeded for exibido, clique em Next.

   6. Na página Alert Source Configuration, configure as definições de sincronização de alertas e clique em Save.

      Parameter	Description	Example
      Project	Projeto do Jira onde os issues são criados quando um alerta é acionado.	Projeto integrado de monitoramento, gerenciamento e controle
      Type	Tipo de issue do Jira para o alerta. Task Subtask Improvement New feature Bug Epic Story	Bug
      Issue closed status	Status que marca um issue do Jira como fechado. Quando um issue atinge esse status, as operações subsequentes de alerta deixam de ser sincronizadas com ele. Status disponíveis: To Do In Progress In Review Done Nota Recomendamos selecionar Done. Se você selecionar um status diferente, as operações de alerta continuarão sendo sincronizadas com o issue correspondente no Jira mesmo após o status mudar para Done.	Done
      Priority	Mapeia os níveis de severidade do alerta para prioridades de issue do Jira. Importante Se nenhum mapeamento for configurado para um nível de severidade de alerta, os alertas desse nível não serão sincronizados com o Jira. O nível de severidade do alerta é sincronizado com base neste mapeamento apenas no primeiro envio ao Jira. Alterações posteriores no nível de severidade do alerta no Gerenciamento de Alertas do ARMS não são sincronizadas com o issue do Jira.	P1: Hightest P2: High P3: Medium P4: Low P5: Lowest

   Após salve a configuração, visualize a nova integração do Jira na aba Notification Integration. A lista exibe informações como Name, Integration key, Type e Creation time. Gerencie a integração pela coluna Actions.

Enviar alertas para o Jira

Após configure a integração do Jira, envie alertas para o Jira de três maneiras:

Método 1

Configure uma política de notificação para crie automaticamente um issue no Jira quando um alerta for acionado.

1. No painel de navegação à esquerda, escolha Alert Management > Notification Policies.

2. Na página Notification Policies, clique em Create Notification Policy ou edite uma política de notificação existente.

3. Na seção When an alert is triggered, , especifique os Contacts. Selecione pelo menos um contato ou grupo de contatos.

   Importante

   • O Jira atribui o issue a um usuário cujo endereço de e-mail ou nome de usuário corresponda ao do primeiro contato na política de notificação.

   • Se o primeiro contato na política de notificação não tiver um usuário correspondente no Jira, o alerta não será sincronizado com o Jira.

4. Para Ticket system, selecione a integração do Jira criada. Configure outros parâmetros conforme necessário. Para mais informações, consulte Políticas de notificação.

5. Clique em Save.

   Após concluir a configuração, os alertas correspondentes a essa política de notificação são enviados para o Jira.

Método 2

Na página Alert Sending History, envie manualmente um alerta existente para o Jira para crie um issue.

1. No painel de navegação à esquerda, escolha Alert Management > Alert Sending History.

2. Na página Alert Sending History, selecione um operador no canto superior direito para atuar como responsável pelo issue no Jira e clique em no nome do alerta desejado.

   Importante

   • O Jira atribui o issue a um usuário cujo endereço de e-mail ou nome de usuário corresponda ao do operador selecionado.

   • Se o operador não tiver um usuário correspondente no Jira, o alerta não poderá ser sincronizado com o Jira.

3. Na página de detalhes do alerta, clique em no ícone no canto superior direito e selecione Push Alerts.

4. Na caixa de diálogo exibida, em Ticket system, selecione a integração do Jira criada e clique em Confirm.

   Após o envio bem-sucedido do alerta, um link para o issue correspondente no Jira, como AL-6, aparece na página de detalhes do alerta.

Método 3

Ao receber um cartão de alerta em um grupo do DingTalk, envie o alerta correspondente diretamente para o Jira a partir do cartão.

• No cartão de alerta recebido no grupo do DingTalk, clique em Push Alerts e selecione a integração do Jira criada.

• No cartão de alerta, clique em no nome do alerta. No painel de detalhes do alerta, clique em Settings, clique em Push ticket e selecione a integração do Jira criada.

Após o envio bem-sucedido do alerta, um link para o issue correspondente no Jira aparece na página de detalhes do alerta.

Supported alert operations for synchronization

Após a configuração, as seguintes operações de alerta no Gerenciamento de Alertas do ARMS são sincronizadas com o sistema de tickets do Jira.

Operações na página Alert Sending History:

• Assumir alerta: Atualiza o responsável pelo issue no Jira.

  Nota

  O usuário que assume o alerta deve ter uma conta de usuário correspondente no Jira.

• Comentar no alerta: Adiciona o comentário ao issue no Jira.

• Resolver alerta: Adiciona a resolução como um comentário ao issue no Jira.

Operações no cartão de alerta em um grupo do DingTalk:

Assumir alerta: Atualiza o responsável pelo issue no Jira.

Sincronizar ações do Jira de volta para o ARMS

1. No Gerenciamento de Alertas do ARMS, acesse a página Integrations, clique em na aba Notification Integration e copie a chave de integração da sua integração do Jira.

2. Faça login no seu sistema de tickets do Jira. No canto superior direito da página do Jira, clique em no ícone de configurações e selecione OsType.

3. Insira sua senha de administrador e clique em Confirm para acesse a página de configuração do sistema.

4. No painel de navegação à esquerda da página OsType, escolha Alerts > Webhook.

5. Na página Webhooks, clique em + Create a webhook.

6. Na página Create a webhook, defina a URL como http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}. Substitua {token} pela chave de integração do Jira obtida na Etapa 1.

   Defina Name como ARMS Alert Management e altere o Status para Enabled. Na seção Issue related events, selecione All issues. Na coluna Issue, selecione created, updated e deleted. Na coluna Comment, selecione created, updated e deleted.

7. Configure outros parâmetros conforme necessário. Para mais informações, consulte a documentação oficial do Jira. Em seguida, clique em Create .

   Após concluir essas etapas, as seguintes operações de issue do Jira são sincronizadas com o Gerenciamento de Alertas do ARMS.

   • Alterar o responsável pelo issue: O responsável pelo alerta correspondente é atualizado.

   • Adicionar um comentário a um issue: Um comentário é adicionado ao alerta correspondente.