Uso de los elementos de métrica y reducción en Canvas dentro de Kibana | Elastic Blog
Engineering

Canvas: Elementos de métrica y reducción

Exploración de los elementos de Canvas en Kibana

Actualmente, Canvas proporciona una selección de aproximadamente 20 elementos integrados que se pueden agregar a los paneles de trabajo (consulta la lista completa en el blog Guía de inicio). En este blog, solo nos vamos a enfocar en dos: Métricas y Markdown

Métrica:

Un cuadro de texto simplificado que solo muestra los valores de los datos con una etiqueta

blog01.3.png

Markdown:

Un cuadro de texto con todas las funciones que muestra los datos dinámicos usando handlebars.js{{variables}} y sintaxis de markdown

Nota: Si ya tienes Canvas y los datos de muestra instalados, puedes saltarte la sección de revisión e ir directamente al tutorial principal: Trabajo con métricas

Revisión rápida

Si todavía no has visitado el blog Guía de inicio, es muy recomendable que regreses y estudies su contenido porque, en este blog, vamos a desarrollar los conceptos previos y supondremos que cuentas con lo siguiente:

  1. Elasticsearch y Kibana en funcionamiento (versión 6.4+)
  2. Canvas instalado

Creación de un panel de trabajo en Canvas

  1. En la barra lateral, haz clic en la pestaña“Canvas”.
  2. Haz clic en "Create workpad" (Crear panel de trabajo).
  3. Colócale un nombre único al nuevo panel de trabajo.

Instalación de los datos de muestra

Para este tutorial, vamos a usar un conjunto de datos de muestra proporcionados por Elastic; específicamente, losdatos de vuelo de muestra.

Nota: Este conjunto de datos solo está disponible en las versiones 6.4 o posteriores de Kibana.

Navega a tu instancia de Kibana:

  1. En la barra lateral, haz clic en la página de inicio principal de “Kibana”.
  2. En la parte inferior de la sección“Add Data to Kibana” (Agregar datos a Kibana), haz clic en el enlace que dice “Load a data set and a Kibana dashboard” (Agregar un conjunto de datos y un dashboard de Kibana).
  3. En la pestaña “Sample flight data” (Datos de vuelo de muestra), haz clic en “Add” (Agregar).

blog01.gif

Referencia rápida

La tabla de abajo te brinda información sobre el conjunto de datos de muestra que acabas de instalar. Los campos con subrayado y negrita son aquellos que usaremos luego en esta actividad, pero siéntete libre de probar algunos otros.

kibana_sample_data_flights
AvgTicketPrice
Carrier
DestCityName
DestCountry
FlightDelayType
FlightTimeMin
OriginCityName
OriginCountry
Dest
DestAirportID
DestLocation
DestRegion
DestWeather
DistanceKilometers
DistanceMiles
FlightDelay
FlightDelayMin
FlightNum
FlightTimeHour
Origin
OriginAirportID
OriginLocation
OriginRegion
OriginWeather
_id
_index
_score
_type
dayOfWeek
hour_of_day
timestamp

Trabajo con métricas

Inicio básico

Averigüemos el número total de minutos usados en los retrasos de los vuelos y mostrémoslo en un elemento métrico. Para esto, usaremos una búsqueda SQL para obtener el total del campo FlightDelayMin del conjunto de datos de muestra.

  1. Haz clic en "Add element" (Agregar elemento).
  2. Selecciona “Metric” (Métrica).
    1. SUGERENCIA: Cuando se crea un elemento por primera vez, se completa con datos de demostración para que puedas comenzar a probarlo de inmediato.
  3. En el panel de edición de la derecha, selecciona la pestaña "Data" (Datos).
  4. Haz clic en "Change your data source" (Cambiar la fuente de datos).
  5. Selecciona “Elasticsearch SQL”.
  6. Escribe lo siguiente en el editor de búsqueda SQL:
SELECT
    SUM(FlightDelayMin) AS delay
FROM
    kibana_sample_data_flights

Profundicemos: La búsqueda SQL selecciona todo los valores json con la palabra clave FlightDelayMin del índice kibana_sample_data_flights. Los datos se devuelven a una “column” (columna) titulada “delay” (retraso).

  1. Haz clic en "Save" (Guardar).

Observa que el elemento métrico ahora muestra un símbolo de advertencia. Esto sucede porque el elemento está apuntando a los datos incorrectos.

  1. En la parte superior del panel de edición a la derecha, selecciona la pestaña “Display” (Pantalla).
  2. En la sección "Numbers" (Números), configura lo siguiente:
    • Medición: Value
    • Campo: delay
  3. Cambia la etiqueta de la métrica a: “Total Delay in Minutes” (Retraso total en minutos).

blog03.gif

Personalización de objetos

Agreguemos un filtro de tiempo para que podamos ver el total de minutos usados en los retrasos de los vuelos en un intervalo de tiempo.

  1. Haz clic en "Add element" (Agregar elemento).
  2. Selecciona “Time Filter” (Filtro de tiempo).

Observa que el elemento métrico ahora muestra un símbolo de advertencia. Esto sucede porque el filtro de tiempo afecta inmediatamente a todos los elementos en el panel de trabajo, pero el filtro de tiempo no está configurado correctamente todavía.

  1. Mueve el filtro de tiempo a una ubicación vacía en el panel de trabajo.
  2. El campo de tiempo predeterminado por el elemento filtro de tiempo es @timestamp, que no es correcto en este caso. En el panel de edición del filtro de tiempo, configura el valor de la columna para que sea:timestamp (p. ej., borra el símbolo @).
  3. Haz clic en “Set” (Configurar).
  4. Haz clic en el filtro de tiempo y selecciona los siguientes intervalos:
    • Últimas 24 horas
    • Últimos 7 días
    • Últimas 2 semanas

Nota: Hay un total de 4 semanas de datos de muestra. 2 semanas de datos “pasados” y 2 semanas de datos “futuros”, siendo el punto medio la fecha de instalación de los datos de muestra.

blog04.gif

Conocimiento más avanzado

Ahora intentemos obtener el promedio de los retrasos de los vuelos. Esto nos exigirá que personalicemos un poco el código detrás de escena para que luzca bien.

  1. Asegúrate de que la primera métrica que creamos esté seleccionada.
  2. En la esquina superior derecha de la pantalla, haz clic en el botón “Duplicate” (Duplicar).
  3. Mueve el nuevo elemento métrico a una ubicación vacía en el panel de trabajo
  4. Cambia la etiqueta de la métrica a: “Average Delay in Minutes” (Promedio de retraso en minutos).
  5. Selecciona la pestaña “Data” (Datos).
  6. Escribe lo siguiente en el editor de búsqueda SQL:
SELECT
    AVG(FlightDelayMin) AS delay
FROM
    kibana_sample_data_flights
  1. Haz clic en "Save" (Guardar).
  2. Expande el elemento métrico para que puedas ver el número completo.
    • Deberías ver algo así: 47.33517114633586
    • Por supuesto, sería agradable si pudiéramos redondear este número
  3. En la esquina inferior derecha, haz clic en “Expression editor” (Editor de expresiones). Esto abre un editor de códigos que nos permite modificar el código que impulsa el elemento seleccionado.
  4. En el editor de expresiones en la tercera línea del código, deberías ver la función “math” (cálculo). Esta es la línea del código que queremos modificar:

blog03.png

  1. En la documentación de Canvas, Elastic proporciona una lista de funciones matemáticas que podemos usar.
  2. Queremos usar la función round(a,b).
    • a es el valor que se redondeará
    • b es la cantidad de decimales
  3. En el editor de expresiones, cambia la línea 3 para incluir la función de redondeo, como se muestra a continuación:
    1. Línea 3: | math "round(delay,0)"
  4. En la esquina inferior derecha del editor de expresiones, haz clic en “Run” (Ejecutar).

blog05.gif

Trabajo con reducciones

Inicio básico

Averigüemos el número total de vuelos y mostremos el resultado en un elemento de reducción. Para hacerlo, vamos a ejecutar un comando SQL en el campo FlightNum de nuestro conjunto de datos de muestra.

  1. Haz clic en “Add Element” (Agregar elemento).
  2. Selecciona “Markdown” (Reducción).
    1. SUGERENCIA: Cuando se crea un elemento por primera vez, se completa con datos de demostración para que puedas comenzar a probarlo de inmediato.
  3. En el panel de edición de la derecha, selecciona la pestaña "Data" (Datos).
  4. Haz clic en "Change your data source" (Cambiar la fuente de datos).
  5. Selecciona “Elasticsearch SQL”.
  6. Escribe lo siguiente en el editor de búsqueda SQL:
SELECT
    FlightNum
FROM
    kibana_sample_data_flights
  1. Haz clic en "Save" (Guardar).
  2. Haz clic en la pestaña “Display” (Pantalla).
  3. Borra todo del editor de “Markdown content” (Contenido de reducción), excepto:
**{{rows.length}} rows**

Nota: El elemento de reducción, como lo indica su nombre, soporta completamente la sintaxis de reducción: p. ej., **, ##, ```, etc. Para quienes no estén familiarizados con la sintaxis de reducción, en el ejemplo de arriba hemos rodeado el texto con ** para colocarlo en negrita.

  1. Haz clic en “Apply” (Aplicar).
  2. El elemento de reducción ahora nos muestra el total de filas en el conjunto de datos, que es el número total de vuelos. Actualiza el texto para que se vea así:
Total number of flights: **{{rows.length}}**
  1. Haz clic en “Apply” (Aplicar).
  2. Haz clic en el signo “+” en el editor de reducción en la esquina superior derecha de la pantalla.
  3. En el menú desplegable, selecciona “Text Settings” (Configuración de textos).
  4. En la configuración de textos, ajusta lo siguiente:
    1. Tamaño de fuente: 36
    2. Alineación: Centrada
  5. Cambia el tamaño del elemento de reducción para que se ajuste mejor al texto.

blog06.gif

Personalización de objetos

Ahora averigüemos cuántos vuelos estuvieron retrasados y por qué. Para hacerlo, vamos a usar el campo FlightDelayType.

  1. Haz clic en “Add Element” (Agregar elemento).
  2. Selecciona “Markdown” (Reducción).
  3. En el panel de edición de la derecha, selecciona la pestaña "Data" (Datos).
  4. Haz clic en "Change your data source" (Cambiar la fuente de datos).
  5. Selecciona “Elasticsearch SQL”.
  6. Escribe lo siguiente en el editor de búsqueda SQL:
SELECT
    FlightDelayType,
    COUNT(FlightDelayType) AS count
FROM
    kibana_sample_data_flights
GROUP BY
    FlightDelayType
  1. Haz clic en "Save" (Guardar).
  2. Haz clic en la pestaña “Display” (Pantalla).
  3. Borra todo del editor de “Markdown content” (Contenido de reducción), excepto:
{{#each columns}}
 **{{name}}**
{{/each}}
  1. Profundicemos:
  2. Esta es la sintaxis de handlebar.js. Para cada columna obtenida de la búsqueda SQL, imprimimos el nombre de la columna. Sin embargo, necesitamos imprimir el valor de cada fila en la columna FlightDelayType. Así, resolveremos cosas en el siguiente paso.
  1. En el editor “Markdown content” (Contenido de reducción), reemplaza:
    • columns con rows
    • name con FlightDelayType
  2. Haz clic en “Apply” (Aplicar).
  3. Ahora tenemos una lista de los tipos de retraso. Agreguemos la cuenta para cada uno. En el editor de “Markdown content” (Contenido de reducción), reemplaza el contenido actual con el siguiente código:
{{#each rows}}
- {{FlightDelayType}} -- {{count}}
{{/each}}
  1. Explicación del código anterior:
  2. Línea 1: Para cada fila...
  3. Línea 2: Imprime "-" para indicar que este es un objeto de la lista, luego, imprime las dos variables separadas por "--".
  4. Línea 3: Imprime una nueva línea.
  5. Línea 4: Finaliza el bucle.
  1. Haz clic en “Apply” (Aplicar).

blog07.gif

Conocimiento más avanzado

En el elemento de reducción que acabamos de crear, observa que una de las filas es:

No Delays -- 2856

Esto realmente no nos dice nada sobre los retrasos; de hecho, todo lo contrario, nos dice cuáles son los vuelos que salieron a tiempo. Vamos a deshacernos de esa fila para que solo se muestren los vuelos que realmente se retrasaron. Lo lograremos usando una función de Canvas llamada filterrows.
blog02.7.png
  1. Asegúrate de que el elemento de reducción que acabamos de crear (ese que muestra todos los tipos de retrasos) esté seleccionado.
  2. En la esquina inferior derecha de la pantalla, haz clic en “Expression editor” (Editor de expresiones). Esto abre un editor de código que nos permite modificar el código que impulsa el elemento seleccionado.
  3. En el editor de expresiones, deberías ver algo similar a lo siguiente:
filters
| essql 
  query="SELECT
    FlightDelayType,
    COUNT(FlightDelayType) AS count
FROM
    kibana_sample_data_flights
GROUP BY
    FlightDelayType"
| markdown "{{#each rows}}
- {{FlightDelayType}} -- {{count}}
{{/each}}"
  1. Vamos a canalizar los datos a través de la función de filterrows antes de que los canalicemos hacia el elemento de reducción. Insertemos una línea nueva en la línea 10 y agreguemos la función de filterrows justo arriba de la función | markdown. No olvides el símbolo| al inicio de cada línea.
...
GROUP BY
    FlightDelayType"
<b style="background-color:#ffae5b"><i>| filterrows {}</i></b>
| markdown "{{#each rows}}
- {{FlightDelayType}} -- {{count}}
...
  1. Queremos filtrar las filas basadas en los valores contenidos en la columna FlightDelayType. Para hacerlo, necesitamos usar otra función llamada getCell, que nos da el valor de cada fila de una columna establecida (documentos de la función “getCell”).
| filterrows { <b style="background-color:#ffae5b"><i>getCell “FlightDelayType”</i></b> }
  1. Luego, vamos a canalizar el valor de cada fila en una función llamada any que resulta verdadera o falsa según la condición de revisión (documentos para la función "any").
| filterrows {getCell “FlightDelayType” <b style="background-color:#ffae5b"><i>| any {}</i></b> }
  1. Por último, para la condición de revisión, vamos a asegurarnos de que los valores no sean iguales a “No Delay” usando una función llamada neq (documentos para la función "neq").
| filterrows {getCell “FlightDelayType” | any { <b style="background-color:#ffae5b"><i>neq “No Delay”</i></b> }}
  1. En la esquina inferior derecha del editor de expresiones, haz clic en “Run” (Ejecutar). La fila que contiene ““No Delay -- 2856” debería desaparecer.

blog08.gif

Enlaces a otros recursos útiles

¡Terminamos! Acabas de trabajar con varios ejemplos de uso de los elementos de métrica y reducción en Canvas. Intenta agregar otros elementos a tu panel de trabajo y experimentar con todas las funciones de Canvas.

Además, consulta otros tutoriales de Canvas aquí: