Visualisations SQL

ClickStack prend en charge les visualisations basées sur des requêtes SQL écrites manuellement. Cela vous donne un contrôle total sur la logique de la requête, tout en restant intégré aux intervalles de temps, aux filtres et au rendu des graphiques au niveau du tableau de bord. Les visualisations basées sur SQL sont utiles lorsque vous devez aller au-delà du Chart Explorer — par exemple, pour effectuer des jointures entre des tables ou créer des agrégations complexes qui ne sont pas prises en charge par le chart builder.

Création d’une visualisation basée sur SQL

Pour créer une visualisation basée sur SQL, ouvrez l’éditeur d’une tuile de tableau de bord et sélectionnez l’onglet SQL. À partir de là :

Sélectionnez une connexion ClickHouse sur laquelle exécuter la requête.
Sélectionnez éventuellement une Source — cela permet d’appliquer à votre visualisation des filtres au niveau du tableau de bord via la macro $__filters.
Rédigez votre requête SQL dans l’éditeur, en utilisant des paramètres de requête et des macros pour l’intégrer à l’intervalle de temps et aux filtres du tableau de bord.
Cliquez sur le bouton play pour prévisualiser les résultats, puis sur Save.

Paramètres de requête

Les paramètres de requête permettent à votre SQL de référencer l’intervalle de temps actuel du dashboard et sa granularité. Ils utilisent la syntaxe de requête paramétrée de ClickHouse : {paramName:Type}.

Paramètres disponibles

Les paramètres disponibles dépendent du type de graphique : Graphiques en courbes et à barres empilées :

Paramètre	Type	Description
`{startDateMilliseconds:Int64}`	Int64	Début de la plage de dates du tableau de bord (millisecondes depuis l’époque Unix)
`{endDateMilliseconds:Int64}`	Int64	Fin de la plage de dates du tableau de bord (millisecondes depuis l’époque Unix)
`{intervalSeconds:Int64}`	Int64	Taille du compartiment temporel en secondes (selon la granularité)
`{intervalMilliseconds:Int64}`	Int64	Taille du compartiment temporel en millisecondes (selon la granularité)

Graphiques de tableau, en secteurs et numériques :

Paramètre	Type	Description
`{startDateMilliseconds:Int64}`	Int64	Début de la plage de dates du tableau de bord (millisecondes depuis l’époque Unix)
`{endDateMilliseconds:Int64}`	Int64	Fin de la plage de dates du tableau de bord (millisecondes depuis l’époque Unix)

Macros

Les macros sont des raccourcis qui se développent en expressions courantes de ClickHouse SQL. Elles sont préfixées par $__ et remplacées avant l’envoi de la requête à ClickHouse.

Macros de limites temporelles

Ces macros renvoient une expression ClickHouse représentant l’heure de début ou de fin du dashboard. Elles ne prennent aucun argument.

Macro	Développé en	Type de colonne
`$__fromTime`	`toDateTime(fromUnixTimestamp64Milli({startDateMilliseconds:Int64}))`	DateTime
`$__toTime`	`toDateTime(fromUnixTimestamp64Milli({endDateMilliseconds:Int64}))`	DateTime
`$__fromTime_ms`	`fromUnixTimestamp64Milli({startDateMilliseconds:Int64})`	DateTime64
`$__toTime_ms`	`fromUnixTimestamp64Milli({endDateMilliseconds:Int64})`	DateTime64
`$__interval_s`	`{intervalSeconds:Int64}`	Int64

Macros de filtrage temporel

Ces macros génèrent un fragment de clause WHERE qui filtre une colonne selon l’intervalle de temps du tableau de bord.

Macro	Description
`$__timeFilter(column)`	Filtre une colonne `DateTime` selon l’intervalle du tableau de bord
`$__timeFilter_ms(column)`	Filtre une colonne `DateTime64` (millisecondes) selon l’intervalle du tableau de bord
`$__dateFilter(column)`	Filtre une colonne `Date` selon l’intervalle du tableau de bord
`$__dateTimeFilter(dateCol, timeCol)`	Filtre à l’aide de colonnes `Date` et `DateTime` distinctes
`$__dt(dateCol, timeCol)`	alias de `$__dateTimeFilter`

Exemple d’expansion de $__timeFilter(TimestampTime):

TimestampTime >= toDateTime(fromUnixTimestamp64Milli({startDateMilliseconds:Int64}))
AND TimestampTime <= toDateTime(fromUnixTimestamp64Milli({endDateMilliseconds:Int64}))

Macros d’intervalle de temps

Ces macros regroupent une colonne d’horodatage en intervalles correspondant à la granularité du dashboard. Elles sont généralement utilisées dans les clauses SELECT et GROUP BY pour les graphiques de séries temporelles. Elles sont uniquement disponibles pour les visualisations Line et Stacked-bar.

Macro	Description
`$__timeInterval(column)`	Regroupe une colonne `DateTime` en intervalles de `intervalSeconds`
`$__timeInterval_ms(column)`	Regroupe une colonne `DateTime64` en intervalles de `intervalMilliseconds`

Exemple d’expansion de $__timeInterval(TimestampTime):

toStartOfInterval(toDateTime(TimestampTime), INTERVAL {intervalSeconds:Int64} second)

Macro de filtre du tableau de bord

Macro	Description
`$__filters`	Remplacé par les conditions de filtre du tableau de bord (nécessite qu’une Source soit sélectionnée)

Lorsqu’une Source est sélectionnée dans le graphique et que les filtres du tableau de bord sont actifs, $__filters se développe en conditions WHERE SQL correspondantes. Lorsqu’aucune source n’est sélectionnée ou qu’aucun filtre n’est appliqué, il se développe en (1=1) ; il peut donc toujours être inclus sans risque dans une clause WHERE.

Comment les résultats de la requête sont représentés

ClickStack associe automatiquement les colonnes du résultat de la requête aux éléments du graphique en fonction des types de colonnes. Les règles de correspondance varient selon le type de graphique.

Graphiques en courbes et en barres empilées

Rôle	Type de colonne	Description
Horodatage	Première colonne `Date` ou `DateTime`	Utilisée pour l’axe des x.
Valeur de série	Toutes les colonnes numériques	Chaque colonne numérique est représentée comme une série distincte. Il s’agit généralement de valeurs agrégées.
Noms de groupe	Colonnes String, Map ou Array	Facultatif. Les lignes ayant des valeurs de groupe différentes sont représentées comme des séries distinctes.

Diagramme circulaire

Rôle	Type de colonne	Description
Valeur du secteur	Première colonne numérique	Détermine la taille de chaque secteur.
Libellé du secteur	Colonnes de type String, Map ou Array	Facultatif. Chaque valeur distincte devient le libellé d’un secteur.

Graphique numérique

Rôle	Type de colonne	Description
Nombre	Première colonne numérique	Affiche la valeur de la première ligne de la première colonne numérique.

Tableau

Toutes les colonnes de résultat sont affichées directement sous forme de colonnes de tableau.

Exemples

Accès requis aux tables systèmeVous devrez préciser otel_v2.otel_logs ou otel_v2.otel_traces si vous exécutez les exemples suivants sur play-clickstack.clickhouse.com.

Graphique en courbes — nombre de logs au fil du temps par service

Cette requête compte les événements de log par service, regroupés en intervalles de temps correspondant à la granularité du tableau de bord.

SELECT
  toStartOfInterval(TimestampTime, INTERVAL {intervalSeconds:Int64} second) AS ts,
  ServiceName,
  count() AS count
FROM otel_logs
WHERE TimestampTime >= fromUnixTimestamp64Milli({startDateMilliseconds:Int64})
  AND TimestampTime < fromUnixTimestamp64Milli({endDateMilliseconds:Int64})
  AND $__filters
GROUP BY ServiceName, ts
ORDER BY ts ASC

ts (DateTime) est utilisé comme horodatage pour l’axe des x.
count (numérique) est représenté comme valeur de la série.
ServiceName (chaîne) crée une ligne distincte pour chaque service.

Graphique en courbes — avec des macros

La même requête, écrite avec des macros pour plus de concision :

SELECT
  $__timeInterval(TimestampTime) AS ts,
  ServiceName,
  count() AS count
FROM otel_logs
WHERE $__timeFilter(TimestampTime)
  AND $__filters
GROUP BY ServiceName, ts
ORDER BY ts ASC

Graphique en barres empilées — nombre d’erreurs par niveau de gravité

SELECT
  $__timeInterval(TimestampTime) AS ts,
  lower(SeverityText),
  count() AS count
FROM otel_logs
WHERE $__timeFilter(TimestampTime)
  AND lower(SeverityText) IN ('error', 'warn')
  AND $__filters
GROUP BY SeverityText, ts
ORDER BY ts ASC

Tableau — les 10 endpoints les plus lents

SELECT
  SpanName AS endpoint,
  avg(Duration) / 1000 AS avg_duration_ms,
  count() AS request_count
FROM otel_traces
WHERE $__timeFilter(Timestamp)
  AND $__filters
GROUP BY SpanName
ORDER BY avg_duration_ms DESC
LIMIT 10

Diagramme circulaire — répartition des requêtes par service

SELECT
  ServiceName,
  count() AS request_count
FROM otel_traces
WHERE $__timeFilter(Timestamp)
  AND $__filters
GROUP BY ServiceName

request_count (numérique) détermine la taille de chaque secteur.
ServiceName (chaîne) correspond à l’étiquette de chaque secteur.

graphique numérique — nombre total d’erreurs

SELECT
  count() AS total_errors
FROM otel_logs
WHERE $__timeFilter(TimestampTime)
  AND SeverityText = 'error'
  AND $__filters

L’unique valeur numérique total_errors de la première ligne est affichée.

Remarques

Les visualisations basées sur SQL s’exécutent en mode readonly — seules les requêtes SELECT sont autorisées.
Les visualisations basées sur SQL doivent contenir exactement une requête SQL — les requêtes multiples ne sont pas prises en charge.
L’éditeur SQL propose des suggestions d’autocomplétion pour les paramètres de requête comme pour les macros.
Une source doit être sélectionnée pour appliquer les filtres du dashboard aux visualisations basées sur SQL. Pour un filtrage précis, la source doit correspondre à la table interrogée.

Fonctionnalités

Guides

Création d’une visualisation basée sur SQL

Paramètres de requête

Paramètres disponibles

Macros

Macros de limites temporelles

Macros de filtrage temporel

Macros d’intervalle de temps

Macro de filtre du tableau de bord

Comment les résultats de la requête sont représentés

Graphiques en courbes et en barres empilées

Diagramme circulaire

Graphique numérique

Tableau

Exemples

Graphique en courbes — nombre de logs au fil du temps par service

Graphique en courbes — avec des macros

Graphique en barres empilées — nombre d’erreurs par niveau de gravité

Tableau — les 10 endpoints les plus lents

Diagramme circulaire — répartition des requêtes par service

graphique numérique — nombre total d’erreurs

Remarques

​Création d’une visualisation basée sur SQL

​Paramètres de requête

​Paramètres disponibles

​Macros

​Macros de limites temporelles

​Macros de filtrage temporel

​Macros d’intervalle de temps

​Macro de filtre du tableau de bord

​Comment les résultats de la requête sont représentés

​Graphiques en courbes et en barres empilées

​Diagramme circulaire

​Graphique numérique

​Tableau

​Exemples

​Graphique en courbes — nombre de logs au fil du temps par service

​Graphique en courbes — avec des macros

​Graphique en barres empilées — nombre d’erreurs par niveau de gravité

​Tableau — les 10 endpoints les plus lents

​Diagramme circulaire — répartition des requêtes par service

​graphique numérique — nombre total d’erreurs

​Remarques

Création d’une visualisation basée sur SQL

Paramètres de requête

Paramètres disponibles

Macros

Macros de limites temporelles

Macros de filtrage temporel

Macros d’intervalle de temps

Macro de filtre du tableau de bord

Comment les résultats de la requête sont représentés

Graphiques en courbes et en barres empilées

Diagramme circulaire

Graphique numérique

Tableau

Exemples

Graphique en courbes — nombre de logs au fil du temps par service

Graphique en courbes — avec des macros

Graphique en barres empilées — nombre d’erreurs par niveau de gravité

Tableau — les 10 endpoints les plus lents

Diagramme circulaire — répartition des requêtes par service

graphique numérique — nombre total d’erreurs

Remarques