Gerador de consultas

Usando o Query Builder, você pode criar consultas para os widgets personalizados dos painéis IBM® Cloud Logs sem precisar conhecer a sintaxe do DataPrime, Lucene ou do PromQL.

Ao definir seu widget, você pode selecionar se deseja usar o modo Builder ou Query.

Consultas baseadas em métricas

Quando você criar um widget que use métricas, selecione o modo Builder e, em seguida, Metrics como sua fonte.

Tipo de consulta

Para o tipo de consulta, selecione uma consulta instantânea ou de intervalo. A consulta é executada em um período de tempo específico, definido pelo seletor de tempo do painel ou pelo período de tempo do widget.

  • O modo de consulta instantânea exibe o valor da métrica em um único ponto no tempo, especificamente no carimbo de data/hora final do período de tempo selecionado. O modo de consulta instantânea é ideal para monitoramento em tempo real, fornecendo um instantâneo dos dados no momento da visualização. Ele também é mais eficiente, pois recupera apenas o ponto de dados mais recente sem buscar todo o conjunto de dados.

  • O modo de consulta de intervalo recupera e agrega dados métricos em um período de tempo especificado. Ele retorna todos os pontos de dados entre os registros de data e hora iniciais e finais que correspondem à sua consulta. À medida que o período de tempo muda, o sistema ajusta automaticamente o intervalo para otimizar o número de pontos de dados exibidos no gráfico. O modo de consulta de intervalo é melhor usado para identificar tendências ou avaliar o desempenho em um período definido.

Nome da métrica

Escolha sua métrica preferida no menu suspenso que é preenchido dinamicamente com as métricas disponíveis. Você pode usar o recurso de preenchimento automático para explorar o nome, os rótulos e os valores da métrica.

Filtros

Para adicionar um filtro, clique em +. Escolha um rótulo de métrica e um valor associado para filtrar sua métrica.

Selecione o operador = ou != no menu suspenso para incluir ou excluir um ou mais valores. Ao usar os operadores =~ ou !~, você pode inserir uma expressão RegEx.

Para adicionar mais pares de valores de rótulos, clique em + para adicionar uma linha.

Funções

Ao selecionar métricas e rótulos, você cria uma consulta válida em Prometheus, mas também pode criar consultas mais complexas usando funções.

Para adicionar uma função, clique em +. Selecione entre as funções aggregation, count e rollup.

As funções de agregação calculam um conjunto de valores e retornam um único valor. Essas funções incluem SUM(), AVG(), MIN(), MAX(), COUNT(), entre outras. Depois de escolher a função, selecione o rótulo a ser agregado no menu suspenso ou insira um valor de rótulo.

Funções de agregação
Agregação Descrição
average O valor médio de todos os pontos de dados dentro do intervalo de tempo selecionado.
count O número total de pontos de dados dentro do intervalo de tempo selecionado.
min O menor valor entre os pontos de dados dentro do intervalo de tempo selecionado.
max O maior valor entre os pontos de dados dentro do intervalo de tempo selecionado.
sum A soma de todos os pontos de dados dentro do intervalo de tempo selecionado.
quantile A função quantile(phi, q) by (group_labels) é um agregado que calcula o phi-quantile para cada grupo de rótulos dentro da série temporal que é retornada por q. O valor de phi deve estar dentro do intervalo [0...1]. O quantil é calculado separadamente para cada conjunto de pontos com o mesmo registro de data e hora.
histogram_quantile A função histogram_quantile é uma função de transformação que calcula o phi-percentile com base nos intervalos de histograma fornecidos. O valor de phi deve estar entre [0...1]. Por exemplo, histogram_quantile(0.5, sum(rate(http_request_duration_seconds_bucket[5m])) by (le)) retorna a duração média da solicitação para todas as solicitações nos últimos 5 minutos.

As funções de contagem executam cálculos em um conjunto de valores e retornam um único valor. Essas funções incluem Count(), Absent(), Absent over time(), Present over time(), Changes(), Resets(), entre outras.

Funções de contagem
Contagem Descrição
count O número total de pontos de dados dentro do intervalo de tempo selecionado.
absent Retorna 1 se a série temporal não tiver pontos. Caso contrário, ele retorna um resultado vazio.
absent over time Retorna 1 se o intervalo de tempo fornecido não contiver amostras brutas.
present over time Retorna 1 se houver pelo menos uma única amostra bruta no intervalo de tempo fornecido.
changes O número de vezes que o valor da série temporal mudou dentro do intervalo de tempo fornecido.
resets O número de reinicializações do contador dentro do intervalo de tempo fornecido.

Uma função de rollup refere-se a funções que agregam dados de séries temporais em um intervalo de tempo especificado. Essas funções calculam métricas como average (avg_over_time), sum (sum_over_time), minimum (min_over_time), maximum (max_over_time), count (count_over_time) e quantiles (quantile_over_time) em uma janela de tempo. Eles são usados para resumir e analisar dados métricos.

Funções de rollup
ROLLUP Descrição
average over time Calcula a média dos valores da série temporal em um intervalo de tempo.
max over time Encontra o valor máximo dos dados da série temporal em um intervalo de tempo.
min over time Determina o valor mínimo dos dados da série temporal em um intervalo de tempo.
sum over time Calcula a soma dos valores da série temporal em um intervalo de tempo.
count over time Conta o número de elementos não NaN na série temporal em um intervalo de tempo.
quantile over time Calcula o quantil especificado de dados de séries temporais em um intervalo de tempo.

Depois de escolher a função, selecione o intervalo a ser consultado como um número ou ${__range}. ${__range} representa a duração do intervalo de tempo do painel. Ele é renderizado como uma string de intervalo compatível com o site PromQL. Por exemplo, se você selecionar um intervalo de tempo de 13.00 a 14.30, a variável ${__range} será renderizada como 90m.

Com as funções de classificação, você pode classificar, ordenar e filtrar dados em suas consultas. Você pode usá-los para refinar seus resultados com base em métricas e valores específicos.

Para adicionar uma função de classificação, clique em + e escolha entre TOPK, SORT, ou SORT Descending. Depois de selecionar uma função de classificação, configure-a especificando a métrica e os parâmetros (por exemplo, preencha o número de resultados de K que você gostaria que a consulta recuperasse para TOPK).

Funções de classificação
Rank Descrição
TOPK Recupera os resultados mais altos K de um conjunto de dados com base em uma métrica especificada. Use o site TOPK para mostrar os pontos de dados de classificação mais alta.
SORT Ordena os dados em ordem crescente com base na métrica selecionada. Use o site SORT para organizar os dados do menor para o maior valor.
SORT Descending Ordena os dados em ordem decrescente com base na métrica selecionada. Use SORT Descending para priorizar os maiores valores no início do conjunto de resultados.

Consultas baseadas em registros

Com o Query Builder baseado em log, você pode criar consultas complexas elaborando consultas baseadas em Lucene e, em seguida, adicionando filtros e funções.

Ao criar um widget que usa registros, selecione o modo Builder e, em seguida, Logs como sua fonte.

Você também precisa escolher se está consultando logs no pipeline de dados Insights prioritários ou Analisar e alertar.

Filtros

Para adicionar um filtro, clique em +. Escolha um rótulo e um valor associado.

Selecione o operador = ou != no menu suspenso para incluir ou excluir um ou mais valores. Ao usar os operadores =~ ou !~, você pode inserir uma expressão RegEx.

Para adicionar mais pares de valores de rótulos, clique em +.

Funções

Para adicionar uma função, clique em +. Selecione um valor agregado usando uma função.

Funções de registros
Função Descrição
Count O número total de pontos de dados dentro do intervalo de tempo selecionado.
Count Distinct O número de pontos de dados exclusivos dentro do intervalo de tempo selecionado.
Sum A soma de todos os pontos de dados dentro do intervalo de tempo selecionado.
Min O menor valor entre os pontos de dados dentro do intervalo de tempo selecionado.
Max O maior valor entre os pontos de dados dentro do intervalo de tempo selecionado.
Average O valor médio de todos os pontos de dados dentro do intervalo de tempo selecionado.
Percentile XX Representa o valor em que caem menos de XX% dos pontos de dados. Por exemplo, Percentile 95 é o valor em que menos de 95% dos pontos de dados caem.

Com Group by, você pode agrupar os resultados da consulta por um ou mais campos.

DataPrime consultas

Você pode criar uma consulta DataPrime como base para seu widget.

Você precisa escolher se está consultando logs no pipeline de dados Insights prioritários ou Analisar e alertar.

Ao criar uma consulta com base em dados de registro, você tem a opção de converter a consulta para a linguagem de sintaxe DataPrime, clicando em Convert to DataPrime no Query Builder.

Quando convertida, a consulta transformada aparece na guia DataPrime na guia Query Builder.

Depois que você alterar as fontes de dados ou converter a consulta para DataPrime,, os parâmetros originais da consulta no Query Builder serão perdidos. Salvar seu widget preserva o estado mais recente do widget.

Tempo do widget

O seletor de tempo do painel define o período de tempo padrão para sua consulta. Para personalizar o período de tempo do widget que você está configurando, clique em Widget time (Tempo do widget ) e desative a opção para desvinculá-lo do período de tempo do painel. Em seguida, você pode escolher um período de tempo padrão ou personalizado especificamente para o widget que está configurando.