générateur de requêtes

Grâce au générateur de requêtes, vous pouvez créer des requêtes pour vos widgets de tableaux de bord personnalisés IBM® Cloud Logs sans avoir besoin de connaître la syntaxe de DataPrime, Lucene ou de PromQL.

Lorsque vous définissez votre widget, vous pouvez choisir d'utiliser le mode Constructeur ou le mode Requête.

Requêtes basées sur des métriques

Lorsque vous créez un widget qui utilise des métriques, sélectionnez le mode Constructeur, puis Métriques comme source.

Type de requête

Pour le type de requête, sélectionnez une requête instantanée ou par plage. La requête est exécutée sur une période spécifique définie par le sélecteur de temps du tableau de bord ou par la période du widget.

  • Le mode d'interrogation instantanée affiche la valeur de l'indicateur à un moment donné, plus précisément à la fin de la période de temps sélectionnée. Le mode d'interrogation instantanée est idéal pour la surveillance en temps réel, car il fournit un instantané des données au moment de la visualisation. Il est également plus performant, puisqu'il ne récupère que le point de données le plus récent sans avoir besoin d'extraire l'ensemble des données.

  • Le mode d'interrogation par plage permet d'extraire et d'agréger des données métriques sur une période donnée. Il renvoie tous les points de données entre les dates de début et de fin qui correspondent à votre requête. Lorsque le cadre temporel change, le système ajuste automatiquement l'intervalle afin d'optimiser le nombre de points de données affichés dans le graphique. Le mode d'interrogation par plage est le mieux adapté pour identifier les tendances ou évaluer les performances sur une période définie.

Nom de la mesure

Choisissez votre indicateur préféré dans le menu déroulant qui se remplit dynamiquement avec les indicateurs disponibles. Vous pouvez utiliser la fonction d'autocomplétion pour explorer le nom, les étiquettes et les valeurs de la métrique.

Filtres

Pour ajouter un filtre, cliquez sur le +. Choisissez un libellé de mesure et une valeur associée pour filtrer votre mesure.

Sélectionnez l'opérateur = ou != dans le menu déroulant pour inclure ou exclure une ou plusieurs valeurs. En utilisant les opérateurs =~ ou !~, vous pouvez introduire une expression RegEx.

Pour ajouter d'autres paires étiquette-valeur, cliquez sur le + pour ajouter une ligne.

Fonctions

En sélectionnant des métriques et des étiquettes, vous créez une requête Prometheus valide, mais vous pouvez également créer des requêtes plus complexes en utilisant des fonctions.

Pour ajouter une fonction, cliquez sur +. Choisissez entre les fonctions aggregation, count et rollup.

Les fonctions d' agrégation calculent un ensemble de valeurs et renvoient une valeur unique. Ces fonctions comprennent SUM(), AVG(), MIN(), MAX(), COUNT(), et d'autres. Après avoir choisi la fonction, sélectionnez l'étiquette à agréger dans le menu déroulant ou saisissez une valeur d'étiquette.

Fonctions d'agrégation
Agrégation Description
average La valeur moyenne de tous les points de données dans la plage de temps sélectionnée.
count Le nombre total de points de données dans l'intervalle de temps sélectionné.
min La plus petite valeur parmi les points de données dans la plage de temps sélectionnée.
max La plus grande valeur parmi les points de données dans l'intervalle de temps sélectionné.
sum La somme de tous les points de données dans l'intervalle de temps sélectionné.
quantile La fonction quantile(phi, q) by (group_labels) est un agrégat qui calcule phi-quantile pour chaque groupe d'étiquettes de la série temporelle renvoyée par q. La valeur de phi doit être comprise dans l'intervalle [0...1]. Le quantile est calculé séparément pour chaque ensemble de points ayant le même horodatage.
histogram_quantile La fonction histogram_quantile est une fonction de transformation qui calcule la valeur de phi-percentile sur la base de l'histogramme fourni. La valeur de phi doit être comprise entre [0...1]. Par exemple, histogram_quantile(0.5, sum(rate(http_request_duration_seconds_bucket[5m])) by (le)) renvoie la durée médiane de toutes les demandes au cours des 5 dernières minutes.

Les fonctions de comptage effectuent des calculs sur un ensemble de valeurs et renvoient une seule valeur. Ces fonctions comprennent Count(), Absent(), Absent over time(), Present over time(), Changes(), Resets(), et d'autres.

Fonctions de comptage
Nombre Description
count Le nombre total de points de données dans l'intervalle de temps sélectionné.
absent Renvoie 1 si la série temporelle n'a pas de points. Sinon, il renvoie un résultat vide.
absent over time Renvoie 1 si l'intervalle de temps fourni ne contient pas d'échantillons bruts.
present over time Renvoie 1 s'il existe au moins un échantillon brut dans la plage de temps fournie.
changes Nombre de fois où la valeur de la série temporelle a changé dans l'intervalle de temps fourni.
resets Le nombre de réinitialisations du compteur dans la plage de temps fournie.

Une fonction rollup fait référence aux fonctions qui agrègent les données d'une série temporelle sur un intervalle de temps spécifié. Ces fonctions calculent des mesures telles que average (avg_over_time), sum (sum_over_time), minimum (min_over_time), maximum (max_over_time), count (count_over_time), et quantiles (quantile_over_time) sur une fenêtre de temps. Ils sont utilisés pour résumer et analyser les données métriques.

Fonctions du rollup
rollup Description
average over time Calcule la moyenne des valeurs d'une série temporelle sur une période donnée.
max over time Détermine la valeur maximale des données d'une série temporelle sur une période donnée.
min over time Détermine la valeur minimale des données d'une série temporelle sur une plage de temps.
sum over time Calcule la somme des valeurs d'une série temporelle sur une période donnée.
count over time Compte le nombre d'éléments non NaN dans la série temporelle sur une période donnée.
quantile over time Calcule le quantile spécifié des données d'une série temporelle sur une plage de temps.

Après avoir choisi la fonction, sélectionnez la plage à interroger sous la forme d'un nombre ou de ${__range}. ${__range} représente la durée de la plage horaire du tableau de bord. Il est rendu sous la forme d'une chaîne d'intervalles prise en charge par PromQL. Par exemple, si vous sélectionnez une période allant de 13.00 à 14.30, la variable ${__range} est affichée sous la forme 90m.

Les fonctions de classement vous permettent de trier, classer et filtrer les données dans vos requêtes. Vous pouvez les utiliser pour affiner vos résultats sur la base de paramètres et de valeurs spécifiques.

Pour ajouter une fonction de rang, cliquez sur + et choisissez parmi TOPK, SORT, ou SORT Descending. Après avoir sélectionné une fonction de classement, configurez-la en spécifiant la métrique et les paramètres (par exemple, indiquez le nombre de résultats K que vous souhaitez que la requête récupère pour TOPK).

Ranger les fonctions
Rang Description
TOPK Récupère les résultats K les plus élevés d'un ensemble de données sur la base d'une métrique spécifiée. Utilisez TOPK pour afficher les points de données les mieux classés.
SORT Ordonne les données par ordre croissant en fonction de la mesure sélectionnée. Utilisez le site SORT pour organiser les données de la plus petite à la plus grande valeur.
SORT Descending Ordonne les données par ordre décroissant en fonction de la métrique sélectionnée. Utilisez SORT Descending pour donner la priorité aux valeurs les plus importantes au début de l'ensemble de résultats.

Requêtes basées sur le journal

Grâce au générateur de requêtes basé sur le journal, vous pouvez créer des requêtes complexes en élaborant des requêtes basées sur Lucene, puis en ajoutant des filtres et des fonctions.

Lorsque vous créez un widget qui utilise des journaux, sélectionnez le mode Constructeur et ensuite Journaux comme source.

Vous devez également choisir si vous interrogez les journaux dans le pipeline de données Informations de priorité ou Analyser et alerter.

Filtres

Pour ajouter un filtre, cliquez sur +. Choisissez une étiquette et une valeur associée.

Sélectionnez l'opérateur = ou != dans le menu déroulant pour inclure ou exclure une ou plusieurs valeurs. En utilisant les opérateurs =~ ou !~, vous pouvez introduire une expression RegEx.

Pour ajouter d'autres paires étiquette-valeur, cliquez sur le signe +.

Fonctions

Pour ajouter une fonction, cliquez sur +. Sélectionnez une valeur agrégée à l'aide d'une fonction.

Fonctions d'enregistrement
Fonction Description
Count Le nombre total de points de données dans l'intervalle de temps sélectionné.
Count Distinct Le nombre de points de données uniques dans l'intervalle de temps sélectionné.
Sum La somme de tous les points de données dans l'intervalle de temps sélectionné.
Min La plus petite valeur parmi les points de données dans la plage de temps sélectionnée.
Max La plus grande valeur parmi les points de données dans l'intervalle de temps sélectionné.
Average La valeur moyenne de tous les points de données dans la plage de temps sélectionnée.
Percentile XX Représente la valeur pour laquelle moins de XX% des points de données tombent. Par exemple, Percentile 95 est la valeur pour laquelle moins de 95% des points de données tombent.

L'option Grouper par permet de regrouper les résultats d'une requête en fonction d'un ou de plusieurs champs.

DataPrime interrogations

Vous pouvez créer une requête DataPrime qui servira de base à votre widget.

Vous devez choisir si vous interrogez les journaux dans le pipeline de données Informations de priorité ou Analyser et alerter.

Lorsque vous créez une requête basée sur des données de journal, vous avez la possibilité de convertir la requête au langage syntaxique DataPrime en cliquant sur Convert to DataPrime dans le Query Builder.

Une fois convertie, la requête transformée apparaît sous l'onglet DataPrime dans le générateur de requêtes.

Si vous changez de source de données ou si vous convertissez votre requête en DataPrime,, vous perdrez vos paramètres de requête d'origine dans le générateur de requêtes. La sauvegarde de votre widget permet de conserver l'état le plus récent du widget.

Heure du widget

Le sélecteur de temps du tableau de bord définit la période par défaut pour votre requête. Pour personnaliser le cadre temporel du widget que vous êtes en train de configurer, cliquez sur Heure du widget et désactivez le commutateur pour le dissocier du cadre temporel du tableau de bord. Vous pouvez ensuite choisir une période standard ou personnalisée pour le widget que vous configurez.