Es posible integrar Jira con la función de gestión de alertas de Application Real-Time Monitoring Service (ARMS) mediante una cuenta de Jira o Open Authorization (OAuth). Este tema describe cómo integrar Jira con la gestión de alertas de ARMS mediante OAuth. De este modo, se crea una incidencia en Jira cuando se genera una alerta en ARMS. El estado de la alerta y el estado de la incidencia pueden sincronizarse.
Paso 1: Configurar Jira
-
Ejecute los siguientes comandos de OpenSSL en la interfaz de línea de comandos (CLI) para generar una clave pública Rivest–Shamir–Adleman (RSA) y una clave privada RSA.
NotaPuede ejecutar estos comandos en cualquier directorio. Los archivos generados se guardan en el directorio actual.
-
Genere una clave privada de 1024 bits:
openssl genrsa -out jira_privatekey.pem 1024 -
Cree un certificado X509:
openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365 -
Extraiga la clave privada en formato PKCS#8 al archivo jira_privatekey.pcks8.
openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8 -
Extraiga la clave pública del certificado en el archivo jira_publickey.pem:
openssl x509 -pubkey -noout -in jira_publickey.cer > jira_publickey.pem
-
-
Cree un vínculo de aplicación.
Inicie sesión en Jira, haga clic en el icono de configuración en la esquina superior derecha de la página de Jira y luego haga clic en Applications.
En la pestaña Applications, haga clic en Application links.
-
En la sección Configure Application Links, introduzca una URL y haga clic en Create new link.
NotaEsta URL es arbitraria y no afecta la integración. Puede introducir cualquier URL, como
http://alerts.console.alibabacloud.com/. -
En el cuadro de diálogo Configure Application URL que aparece, ignore la advertencia y haga clic en Continue.
En el cuadro de diálogo, la Entered URL se muestra como
http://alerts.console.alibabacloud.com/, y la New URL cambia automáticamente ahttps://alerts.console.alibabacloud.com/. En el cuadro de diálogo Link applications que aparece, establezca Application Type en Generic Application, introduzca AlertOauthKey para consumer key, seleccione la casilla create incoming link, complete los demás parámetros según sea necesario y luego haga clic en Continue.
-
En el cuadro de diálogo Link applications, configure los siguientes parámetros y haga clic en Continue.
Parámetro
Valor
Consumer Key
AlertOauthKey
Consumer Name
alertmanager
Public Key
El contenido del archivo jira_publickey.pem generado en Step 1.
En la sección Target Application del cuadro de diálogo Link applications, establezca Application URL en
https://alerts.console.alibabacloud.com/, configure los parámetros anteriores y luego haga clic en Continue.Después de unos momentos, el nuevo vínculo de aplicación aparece en la página Configure Application Links. La lista de aplicaciones muestra que alertmanager se ha agregado correctamente como tipo Generic Application con el estado NON-ATLASSIAN.
En la columna Action del vínculo de aplicación, haga clic en el icono de edición (
). En el cuadro de diálogo Configure alertmanager, haga clic en incoming authentication en el panel izquierdo.Si el Status es Not Configured, vuelva a introducir la consumer key, el Consumer Name y la public key, y luego haga clic en Save.
Haga clic en Close.
Paso 2: Integrar Jira con ARMS
Inicie sesión en la consola de ARMS. En el panel de navegación izquierdo, vaya a .
En la página Integrations, haga clic en la pestaña Notification Integration y luego haga clic en Jira.
-
En el asistente Add Integration, complete los siguientes pasos.
-
En la página Basic Information, configure los siguientes parámetros y haga clic en Obtain Verification Code.
Se le redirige a la página de autorización de Jira.
Parámetro
Valor
Name
Introduzca un nombre para la integración de Jira.
Description
Introduzca una descripción para la integración de Jira.
URL
La URL de su instancia de Jira.
Verification
Establezca Authentication method en OAuth.
Consumer key
AlertOauthKey
Private key
El contenido del archivo jira_privatekey.pcks8 generado en Step 1.
En la página Welcome to Jira, haga clic en Allow.
En la página Access Approved, obtenga el código de verificación.
Regrese al asistente Add Integration en la consola de ARMS. Pegue el código en el campo Verification Code y haga clic en Obtain Access Token.
Cuando se muestre Obtaining Access Token Succeeded, haga clic en Next.
-
En la página Alert Source Configuration, configure los ajustes de sincronización de alertas y haga clic en Save.
Parámetro
Descripción
Ejemplo
Project
El proyecto de Jira donde se crean las incidencias cuando se activa una alerta.
Proyecto de monitoreo, gestión y control integrados
Type
El tipo de incidencia de Jira para la alerta.
Task
Subtask
Improvement
New feature
Bug
Epic
Story
Bug
Issue closed status
El estado que marca una incidencia de Jira como cerrada. Una vez que una incidencia alcanza este estado, las operaciones posteriores de la alerta ya no se sincronizan con ella. Estados disponibles:
To Do
In Progress
In Review
Done
NotaSe recomienda seleccionar Done. Si selecciona un estado diferente, las operaciones de la alerta seguirán sincronizándose con la incidencia correspondiente de Jira incluso después de que su estado cambie a Done.
Done
Priority
Asigna los niveles de gravedad de la alerta a las prioridades de la incidencia de Jira.
ImportanteSi no configura una asignación para un nivel de gravedad de alerta, las alertas de ese nivel no se sincronizarán con Jira.
El nivel de gravedad de la alerta se sincroniza según esta asignación solo cuando se envía a Jira por primera vez. Los cambios posteriores en el nivel de gravedad de la alerta en la gestión de alertas de ARMS no se sincronizan con la incidencia de Jira.
P1: Hightest
P2: High
P3: Medium
P4: Low
P5: Lowest
Después de guardar la configuración, puede consultar la nueva integración de Jira en la pestaña Notification Integration. La lista muestra información como Name, Integration key, Type y Creation time. Puede gestionar la integración desde la columna Actions.
-
Envío de alertas a Jira
Después de configurar la integración de Jira, puede enviar alertas a Jira de tres maneras:
Método 1
Configure una directiva de notificación para crear automáticamente una incidencia en Jira cuando se active una alerta.
En el panel de navegación izquierdo, vaya a .
En la página Notification Policies, haga clic en Create Notification Policy o edite una directiva de notificación existente.
-
En la sección When an alert is triggered, , especifique los Contacts. Debe seleccionar como mínimo un contacto o grupo de contactos.
ImportanteJira asigna la incidencia a un usuario cuya dirección de correo electrónico o nombre de usuario coincida con los del primer contacto en la directiva de notificación.
Si el primer contacto en la directiva de notificación no tiene un usuario correspondiente en Jira, la alerta no se sincronizará con Jira.
Para Ticket system, seleccione la integración de Jira que creó. Configure otros parámetros según sea necesario. Para obtener más información, consulte Notification policies.
-
Haga clic en Save.
Una vez completada la configuración, las alertas que coincidan con esta directiva de notificación se enviarán a Jira.
Método 2
Desde la página Alert Sending History, puede enviar manualmente una alerta existente a Jira para crear una incidencia.
En el panel de navegación izquierdo, vaya a .
-
En la página Alert Sending History, seleccione un operador en la esquina superior derecha para que actúe como responsable de la incidencia de Jira y luego haga clic en el nombre de la alerta objetivo.
ImportanteJira asigna la incidencia a un usuario cuya dirección de correo electrónico o nombre de usuario coincida con los del operador seleccionado.
Si el operador no tiene un usuario correspondiente en Jira, la alerta no se puede sincronizar con Jira.
En la página de detalles de la alerta, haga clic en el icono
en la esquina superior derecha y luego haga clic en Push Alerts.-
En el cuadro de diálogo que aparece, para Ticket system, seleccione la integración de Jira que creó y haga clic en Confirm.
Después de enviar la alerta correctamente, aparece un vínculo a la incidencia correspondiente de Jira, como AL-6, en la página de detalles de la alerta.
Método 3
Cuando reciba una tarjeta de alerta en un grupo de DingTalk, puede enviar la alerta correspondiente a Jira directamente desde la tarjeta.
El usuario que envía la alerta desde el grupo de DingTalk se convierte en el responsable de la incidencia en Jira.
El operador debe ser un contacto que haya vinculado su número de celular en la tarjeta de alerta del grupo de DingTalk. Para obtener más información, consulte Handle alerts.
Si el correo electrónico o el nombre de usuario de un usuario de Jira coincide con el correo electrónico o el nombre de un contacto de ARMS, el contacto se asigna a ese usuario de Jira.
Si el operador no tiene un usuario correspondiente en Jira, la alerta no se puede sincronizar con Jira.
En la tarjeta de alerta que recibe en el grupo de DingTalk, haga clic en Push Alerts y seleccione la integración de Jira que creó.
En la tarjeta de alerta, haga clic en el nombre de la alerta. En el panel de detalles de la alerta, haga clic en Settings, haga clic en Push ticket y seleccione la integración de Jira que creó.
Después de enviar la alerta correctamente, aparece un vínculo a la incidencia correspondiente de Jira en la página de detalles de la alerta.
Supported alert operations for synchronization
Una vez configurada, las siguientes operaciones de alerta en la gestión de alertas de ARMS se sincronizan con el sistema de tickets de Jira.
Operaciones en la página Alert Sending History:
-
Reclamar alerta: Actualiza el responsable de la incidencia de Jira.
NotaEl usuario que reclama la alerta debe tener una cuenta de usuario correspondiente en Jira.
Comentar en la alerta: Agrega el comentario a la incidencia de Jira.
Resolver alerta: Agrega la resolución como comentario a la incidencia de Jira.
Operaciones en la tarjeta de alerta en un grupo de DingTalk:
Reclamar alerta: Actualiza el responsable de la incidencia de Jira.
El usuario que reclama la alerta debe tener una cuenta de usuario correspondiente en Jira.
Sincronización de acciones de Jira con ARMS
En la gestión de alertas de ARMS, vaya a la página Integrations, haga clic en la pestaña Notification Integration y copie la clave de integración de su integración de Jira.
Inicie sesión en su sistema de tickets de Jira. En la esquina superior derecha de la página de Jira, haga clic en el icono de configuración y luego haga clic en OsType.
Introduzca su contraseña de administrador y haga clic en Confirm para ir a la página de configuración del sistema.
En el panel de navegación izquierdo de la página OsType, vaya a .
En la página de Webhooks, haga clic en + Create a webhook.
-
En la página Create a webhook, establezca la URL en
http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}. Reemplace {token} con la clave de integración de Jira de Step 1.Establezca Name en
ARMS Alert Managementy cambie el Status a Enabled. En la sección Issue related events, seleccione All issues. En la columna Issue, seleccione created, updated y deleted. En la columna Comment, seleccione created, updated y deleted. -
Configure otros parámetros según sea necesario. Para obtener más información, consulte la documentación oficial de Jira. Luego, haga clic en Create .
Después de completar estos pasos, las siguientes operaciones de incidencias de Jira se sincronizan con la gestión de alertas de ARMS.
Cambio del responsable de la incidencia: Se actualiza el responsable de la alerta correspondiente.
Adición de un comentario a una incidencia: Se agrega un comentario a la alerta correspondiente.