Alertes Databricks SQL

Cette page fournit des instructions pas à pas pour activer et utiliser des alertes Databricks SQL pour automatiser l’exécution des requêtes, évaluer des conditions personnalisées et remettre des notifications lorsque ces conditions sont remplies. Avec des alertes, vous pouvez surveiller de manière proactive vos données métier et recevoir des notifications en temps opportun chaque fois que les valeurs signalées tombent en dehors des seuils attendus. Lorsque vous planifiez une alerte, ses exécutions de requête associées et les critères d’alerte sont vérifiés, quelles que soient les planifications existantes sur la requête sous-jacente. En outre, vous pouvez accéder à un historique des alertes pour passer en revue les résultats des évaluations des alertes passées.

Pour savoir comment utiliser des alertes héritées à la place, consultez Qu’est-ce que les alertes héritées ?.

Activer les alertes dans votre espace de travail

Les administrateurs d’espace de travail peuvent contrôler l’accès de l’espace de travail à cet aperçu à partir de la page Aperçus. L’activation de cette préversion n’a pas d’impact sur vos alertes existantes ; vous pouvez continuer à utiliser ces alertes et les alertes héritées en parallèle.

Afficher et organiser les alertes

Cliquez sur dans la barre latérale pour ouvrir la page de référencement des alertes.

• L’onglet Alertes est ouvert par défaut et affiche toutes les alertes dans l’espace de travail. Vous pouvez taper pour filtrer par nom. Cliquez uniquement sur mes alertes pour afficher uniquement les alertes où vous êtes le propriétaire.

• L’onglet Alertes héritées affiche les alertes créées à l’aide du système d’alertes précédent.

• Nom affiche le nom de chaîne de chaque alerte.

• L’état indique si l’état de l’alerte est TRIGGERED, OKou ERROR.

• La planification affiche l’heure ou la date de la dernière mise à jour.

• Le propriétaire affiche le nom d’utilisateur de la personne propriétaire de l’alerte.

• Date et heure de création affiche la date et l’heure de création de l’alerte.

  • TRIGGERED signifie que sur l’exécution la plus récente, la colonne Valeur de votre requête cible a atteint la condition et le seuil que vous avez configurés. Si votre alerte vérifie si « chats » dépasse 1500, votre alerte est déclenchée tant que « chats » dépasse 1500.
  • OK signifie que sur l’exécution de requête la plus récente, la colonne Valeur n’a pas satisfait à la condition et au seuil que vous avez configurés. Cela ne signifie pas que l’alerte n’a pas été déclenchée précédemment. Si votre valeur « chats » est maintenant 1470, votre alerte s’affiche comme OK.
  • ERROR indique qu’une erreur s’est produite lors de l’évaluation de l’alerte.

Créer une alerte

Les étapes de cette section vous guident tout au long de la création de l’alerte illustrée dans l’image suivante. Utilisez les étiquettes et les explications pour comprendre chaque composant.

1. Éditeur de requête : Écrivez et testez la requête sur laquelle vous souhaitez alerter.

2. Horaire: Définissez une planification périodique pour l’exécution de l’alerte.

3. Condition: Sélectionnez le seuil de valeur qui doit déclencher une notification d’alerte. Vous pouvez exécuter la requête pour tester la condition à partir de cette section.

4. Notifications: Indiquez quels utilisateurs ou destinations de notification doivent être alertés lorsque la valeur de seuil se situe en dehors de la plage attendue.

5. Avancé: Utilisez les paramètres avancés pour alerter sur des valeurs et des conditions spéciales.

Pour créer une alerte, procédez comme suit :

1. Cliquez sur Alertes dans la barre latérale, puis cliquez sur Créer une alerte.

2. Copiez et collez la requête suivante dans l’éditeur de requête. Cliquez sur Exécuter tout (1000). Pour en savoir plus sur l’utilisation de l’éditeur SQL, consultez Écrire des requêtes et explorer les données dans le nouvel éditeur SQL.

   SELECT
     to_date(tpep_pickup_datetime) as date,
     SUM(fare_amount) as amount
   FROM
     `samples`.`nyctaxi`.`trips`
   GROUP BY
     ALL
   ORDER BY
     1 DESC
   
   

3. Dans le champ Condition , définissez les conditions qui doivent déclencher l’alerte.

   

   Appliquez les paramètres suivants, comme indiqué :

   • Sélectionnez Sum comme valeur de données à vérifier. Des conditions d’alerte peuvent être définies sur la première valeur d’une colonne dans le résultat de la requête ou vous pouvez choisir de définir une agrégation sur toutes les lignes d’une seule colonne, par exemple SUM ou AVERAGE.
   • Sélectionnez la quantité en tant que colonne à vérifier.
   • Sélectionnez > (supérieur à) comme opérateur logique à appliquer.
   • Définissez la valeur de seuil sur Static value 4 000. La valeur statique est sélectionnée par défaut. Entrez 4000 dans le champ valeur.

4. Cliquez sur Condition de test pour afficher un aperçu de l’alerte et tester si l’alerte se déclencherait avec les données actuelles. Les paramètres fournis doivent déclencher l’alerte. Vous pouvez modifier la valeur de seuil pour tester davantage.

5. Dans la section Notifications , recherchez votre nom d’utilisateur et cliquez dessus lorsqu’il apparaît.

6. Cliquez sur Icône de calendrier pour ouvrir la boîte de dialogue Modifier la planification . Utilisez les menus déroulants pour définir l’alerte afin qu’elle s’exécute toutes les 5minutes à partir de 0 minutes après l'heure. Cliquez sur Enregistrer. Vous pouvez également cocher la case Afficher la syntaxe cron pour modifier la planification dans la syntaxe Quartz Cron.

7. Cliquez sur Afficher l’alerte.

Votre alerte est enregistrée et s’exécute selon la planification que vous avez fournie. Les données utilisées dans cet exemple sont statiques. Par conséquent, si votre condition de test est retournée comme déclenchée, elle le sera de nouveau la prochaine fois qu'elle s'exécute. Vous recevez une notification par e-mail en tant qu’alerte. Si la condition de test a retourné OK, aucune notification n’est envoyée.

Passer en revue les détails de l’alerte

Une page s’ouvre pour afficher les détails de votre alerte. En outre, un historique des alertes s’affiche avec les détails de l’historique d’évaluation. Cliquez sur le bouton Exécuter maintenant pour exécuter la requête d’alerte immédiatement et renvoyer le résultat sur cet écran.

Cliquez sur Modifier dans le coin supérieur droit de la page pour continuer à modifier l’alerte.

Paramètres avancés

Cliquez sur Paramètres avancés pour appliquer les paramètres suivants :

• Notifier sur ok : Envoyez une notification lorsque l’alerte est retournée en tant que OK.

• Fréquence de notification : Envoyez régulièrement des notifications sur une alerte jusqu’à ce que l’état revienne à OK.

• État de résultat vide : Définissez un état spécial à retourner lorsque la requête ne retourne aucun résultat.

• Modèle: Vous pouvez choisir d’envoyer des notifications à l’aide du modèle par défaut ou d’un modèle personnalisé. La liste suivante explique chaque type de modèle :

  • Utiliser le modèle par défaut : la notification d’alerte est un message comportant des liens vers l’écran de configuration d’alerte et l’écran de requête.

  • Utiliser un modèle personnalisé : la notification d’alerte comporte des informations plus spécifiques sur l’alerte.

    1. Une zone s’affiche, composée de champs d’entrée pour l’objet et le corps. Tout contenu statique est valide et vous pouvez incorporer des variables de modèle intégré :

       • ALERT_STATUS : statut d’alerte évalué (chaîne).
       • ALERT_CONDITION : opérateur de condition d’alerte (chaîne).
       • ALERT_THRESHOLD : seuil d’alerte (chaîne ou nombre).
       • ALERT_COLUMN : nom de la colonne d’alerte (chaîne).
       • ALERT_NAME : nom de l’alerte (chaîne).
       • ALERT_URL : URL de la page d’alerte (chaîne).
       • QUERY_RESULT_TABLE : table HTML des résultats de la requête (chaîne). Les résultats sont limités aux 100 premières lignes. Seules les destinations de notification par e-mail peuvent afficher le code HTML.
       • QUERY_RESULT_VALUE : valeur du résultat de la requête (chaîne ou nombre).
       • QUERY_RESULT_ROWS : lignes de résultat de la requête (tableau de valeurs).
       • QUERY_RESULT_COLS : colonnes de résultat de la requête (tableau de valeurs).

       Un exemple d’objet pourrait être : Alert "{{ALERT_NAME}}" changed status to {{ALERT_STATUS}}.

    2. Vous pouvez utiliser le format HTML pour mettre en forme des messages dans un modèle personnalisé. Seules les destinations de notification par e-mail peuvent afficher le code HTML. Les balises et les attributs suivants sont autorisés dans les modèles :

       • Balises autorisées : <a>, <b>, <blockquote>, <br>, <code>, <del>, <div>, <em>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <hr>, <i>, <img>, <li>, <ol>, <p>, <pre>, <span>, <table>, <thread>, <tbody>, <td>, <th>, <tr>, <u>, <ul>

       • Attributs autorisés :

         Attribut	Balises prises en charge
         href	<a>
         title	<img>
         target	<a>
         alt	<img>
         src	<img>
         start	<b>, <blockquote>, <code>, <del>, <em>, <hr>, <i>, <pre>, <u>

    3. Cliquez sur le bouton bascule Preview (Aperçu) pour afficher un aperçu du résultat du rendu.

       Importante

       L’aperçu permet de vérifier que les variables de modèle sont rendues correctement. Il ne s’agit pas d’une représentation exacte du contenu de notification éventuel, car chaque destination de notification peut afficher les notifications différemment.

Les administrateurs d’espace de travail peuvent configurer de nouvelles destinations de notification. Consultez Gérer les destinations de notification.

Agrégation d’alertes

Une agrégation sur une alerte fonctionne en modifiant le code SQL d’origine de la requête Databricks SQL attachée à l’alerte. L’alerte encapsule le texte de la requête d’origine dans une expression de table commune (CTE) et exécute une requête d’agrégation d’encapsulage sur celle-ci pour agréger le résultat de la requête.

Par exemple, une agrégation SUM sur une alerte attachée à une requête avec le texte SELECT 1 AS column_name signifie que chaque fois que l’alerte est actualisée, le code SQL modifié qui s’exécute est : WITH q AS (SELECT 1 AS column_name) SELECT SUM(column_name) FROM q.

Autrement dit, le résultat de la requête d’origine (pré-agrégé) ne peut pas s’afficher dans un corps personnalisé d’alerte (avec des paramètres tels que QUERY_RESULT_ROWS et QUERY_RESULT_COLS) chaque fois qu’une agrégation existe sur une alerte. À la place, ces variables affichent uniquement le résultat final et postérieur à l’agrégation de la requête.

Alerte sur plusieurs colonnes

Pour définir une alerte sur la base de plusieurs colonnes d’une requête, votre requête peut implémenter la logique d’alerte et retourner une valeur booléenne pour déclencher l’alerte. Par exemple :

SELECT CASE WHEN drafts_count > 10000 AND archived_count > 5000 THEN 1 ELSE 0 END
FROM (
SELECT sum(CASE WHEN is_archived THEN 1 ELSE 0 END) AS archived_count,
sum(CASE WHEN is_draft THEN 1 ELSE 0 END) AS drafts_count
FROM queries) data

Cette requête retourne 1 quand drafts_count > 10000 and archived_count > 5000. Vous pouvez ensuite configurer l’alerte pour qu’elle se déclenche lorsque la valeur est 1.

Alerte sur les vues de mesures

Étant donné que les vues de métriques sont conçues pour suivre et mesurer les métriques métier principales, elles s’associent bien aux alertes afin que vous puissiez être automatiquement averti lorsqu’une métrique tombe en dehors d’une plage attendue. Les alertes sur les vues de métriques fonctionnent de la même façon qu’une alerte sur tout autre jeu de données. Lorsque vous écrivez la requête pour configurer la requête, utilisez le nom complet de la vue métrique que vous souhaitez surveiller.

Fonctionnement de l’intégration Git avec les alertes

Vous pouvez utiliser les dossiers Git Databricks pour suivre et gérer les modifications apportées aux alertes. Pour suivre les alertes avec Git, placez-les dans un dossier Databricks Git. Les alertes nouvellement clonées apparaissent uniquement dans la page de liste des alertes ou l’API une fois qu’un utilisateur interagit avec eux. Leur planification a été suspendue et doit être explicitement reprise par les utilisateurs.

Les dossiers Git Databricks fournissent un moyen centralisé de gérer les opérations Git courantes pour les alertes et d’autres objets d’espace de travail. Pour en savoir plus, consultez les dossiers Git Azure Databricks.

Différences par rapport aux alertes héritées

La dernière version des alertes DATAbricks SQL se comporte différemment des alertes héritées de plusieurs manières clés :

• Intégration des Jobs : La dernière version ne prend pas encore en charge le référencement direct d’une alerte dans le pipeline Jobs. Cette fonctionnalité sera bientôt disponible. Les alertes Legacy prennent en charge le type de tâche Alertes dans Tâches.
• Réutilisation des requêtes : Une requête SQL enregistrée existante ne peut pas être réutilisée lors de la création d’une alerte. Chaque alerte possède sa définition de requête, qui peut être créée directement dans le nouvel éditeur d’alerte.
• Valeurs d’état d’alerte : Les états d’alerte sont simplifiés et les alertes ne prennent plus en charge l’état UNKNOWN des alertes héritées. Les évaluations se résolvent en OK, TRIGGERED, ou ERROR.

Vous pouvez continuer à utiliser les dernières alertes et les alertes héritées côte à côte pendant la transition.

Configurer des autorisations d’alerte et transférer la propriété d’une alerte

Pour en savoir plus sur les niveaux d’autorisation des alertes, consultez Listes de contrôle d’accès des alertes.

1. Dans la barre latérale, cliquez sur Alertes.

2. Cliquez sur une alerte.

3. Cliquez sur Partager dans le coin supérieur droit de la page de détails de l’alerte pour ouvrir la boîte de dialogue Partage .

   

4. Recherchez et sélectionnez les groupes et les utilisateurs, puis affectez-leur le niveau d’autorisation souhaité.

5. Cliquez sur Add.

Transférer la propriété d’une alerte

Lorsque vous enregistrez une alerte, vous devenez le propriétaire de l’alerte. Si le propriétaire d’une alerte est supprimé d’un espace de travail, l’alerte n’a plus de propriétaire. Un utilisateur administrateur d’espace de travail peut transférer la propriété d’une alerte à un autre utilisateur. Vous pouvez également transférer la propriété à l’aide de l’API Autorisations.

1. En tant qu’administrateur d’espace de travail, connectez-vous à votre espace de travail Azure Databricks.

2. Dans la barre latérale, cliquez sur Alertes.

3. Cliquez sur une alerte.

4. Cliquez sur le bouton Partager en haut à droite pour ouvrir la boîte de dialogue Partage.

5. Cliquez sur l’icône représentant un engrenage en haut à droite, puis sur Affecter un nouveau propriétaire.

   

6. Sélectionnez l’utilisateur auquel affecter la propriété.

7. Cliquez sur Confirmer.