Tipos de variables

Grafana utiliza varios tipos de variables.

Adición de una variable de consulta

Al usar variables de consulta, puede escribir una consulta de origen de datos que devuelve una lista de nombres de métricas, valores de etiquetas o claves. Por ejemplo, una variable de consulta puede devolver una lista de nombres de servidores, ID de sensores o centros de datos. Los valores de las variables cambian a medida que buscan opciones de forma dinámica con una consulta a un origen de datos.

Las expresiones de consulta pueden contener referencias a otras variables y, de hecho, crear variables vinculadas. Grafana lo detecta y actualiza automáticamente una variable cuando cambia una de sus variables vinculadas.

Expresiones de consulta

Las expresiones de consulta son diferentes para cada origen de datos. Para obtener más información, consulte la documentación del origen de datos en Conexión con orígenes de datos.

Introducción de opciones generales

Introducción de opciones de consulta

Adición de una variable personalizada

Use una variable personalizada para los valores que no cambien. Pueden ser números, cadenas o incluso otras variables.

Por ejemplo, si tiene nombres de servidores o nombres de regiones que nunca cambian, puede crearlos como variables personalizadas en lugar de como variables de consulta. Como no cambian, puede utilizarlos en variables encadenadas en lugar de en otras variables de consulta. Eso reduciría la cantidad de consultas que Grafana debe enviar cuando se actualizan las variables encadenadas. Para obtener más información acerca de las variables encadenadas, consulte Variables encadenadas.

Introducción de opciones generales

Introducción de opciones personalizadas

Adición de una variable de cuadro de texto

Las variables de cuadro de texto muestran un campo de entrada de texto con un valor predeterminado opcional. Es la variable más flexible, ya que puede ingresar cualquier valor. Utilice este tipo de variable si tiene métricas con una cardinalidad alta o si desea actualizar varios paneles de un panel de control al mismo tiempo.

Introducción de opciones generales

Introducción de opciones de texto

Adición de una variable constante

Para definir una constante oculta, utilice variables de constante. Las variables de constante son útiles para los prefijos de las rutas métricas de los paneles de control que desee compartir. Al exportar un panel de control, las variables constantes se convierten en opciones de importación.

Las variables constantes no son flexibles. Cada variable de constante contiene solo un valor. Para actualizarlo, debe actualizar la configuración de las variables.

Las variables de constante son útiles cuando tiene valores complejos que debe incluir en las consultas, pero no quiere volver a escribirlos en cada una de las consultas. Por ejemplo, si tuviera una ruta de servidor llamada i-0b6a61efe2ab843gg, podría reemplazarla por una variable llamada $path_gg.

Introducción de opciones generales

Introducción de opciones de constante

Adición de una variable de origen de datos

Para cambiar el origen de datos de un panel de control completo, puede usar las variables de origen de datos. Son útiles si tiene varias instancias de un origen de datos, quizás en entornos diferentes.

Introducción de opciones generales

Introducción de opciones de origen de datos

Adición de una variable de intervalo

Utilice una variable de intervalo para representar intervalos de tiempo, como 1m, 1h o 1d. Puede considerarlos como un comando agrupar por tiempo que abarca todo el panel de control. Las variables de intervalo cambian la forma en que se agrupan los datos en la visualización. También puede utilizar la opción automática para devolver un número determinado de puntos de datos por intervalo de tiempo.

Puede usar una variable de intervalo como parámetro para agruparla por tiempo (para InfluxDB), intervalo de histograma de fecha (para OpenSearch) o como parámetro de la función de resumen (para Graphite).

Introducción de opciones generales

Introducción de opciones de intervalo

Ejemplos de variables de intervalo

Ejemplo con la variable de plantilla myinterval en una función de Graphite:

summarize($myinterval, sum, false)

Un ejemplo de Graphite más complejo:

groupByNode(summarize(movingAverage(apps.$app.$server.counters.requests.count, 5), '$interval', 'sum', false), 2, 'sum')

Adición de filtros ad hoc

Puede utilizar filtros de un solo uso o ad hoc para agregar filtros clave-valor que se agregan automáticamente a todas las consultas de métricas que utilizan el origen de datos especificado. A diferencia de otras variables, en las consultas no se utilizan filtros de un solo uso. En su lugar, se utilizan para escribir filtros para las consultas existentes.

Introducción de opciones generales

Introducción de opciones

Creación de filtros ad hoc

Los filtros ad hoc son una de las opciones de variables más complejas y flexibles disponibles. En lugar de una lista normal de opciones de variables, esta variable le permite compilar una consulta ad hoc que abarque todo el panel de control. Los filtros que aplique de esta manera se aplican a todos los paneles del panel de control.

Variables encadenadas

Las variables encadenadas, también denominadas variables enlazadas o variables anidadas, son variables de consulta con una o más variables adicionales en su consulta de variables. En esta sección se explica cómo funcionan las variables encadenadas y se proporcionan enlaces a ejemplos de paneles de control que las utilizan.

Las consultas de variables encadenadas son diferentes para cada origen de datos, pero la premisa es la misma para todas. Puede utilizar consultas de variables encadenadas en cualquier origen de datos que las permita.

Puede compilar paneles de control complejos vinculados y con plantillas, de 5 o 10 niveles de profundidad. Técnicamente, no hay límite en cuanto a la profundidad o complejidad que pueda tener, pero cuantos más enlaces tenga, mayor será la carga de consultas.

Prácticas recomendadas y consejos

Las siguientes prácticas harán que los paneles de control y las variables sean más fáciles de usar.

Creación de nuevas variables encadenadas

Orden de las variables

Para cambiar el orden de las variables en la lista de variables del panel de control, seleccione las flechas arriba y abajo situadas a la derecha de cada entrada. El espacio de trabajo de Grafana muestra las listas desplegables de variables de izquierda a derecha según esta lista, con la variable de la parte superior de la lista en el extremo izquierdo.

Consideraciones sobre la complejidad

Cuantos más niveles de dependencia haya en las variables, más tiempo tarda en actualizar los paneles de control después de cambiar las variables.

Por ejemplo, si tiene una serie de cuatro variables vinculadas (país, región, servidor y métrica) y cambia el valor de una variable raíz (país), el espacio de trabajo de Grafana debe ejecutar consultas para todas las variables dependientes antes de actualizar las visualizaciones en el panel de control.

Variables globales

Grafana tiene variables integradas que se pueden utilizar en expresiones del editor de consultas. En este tema se enumeran en orden alfabético y se definen. Estas variables son útiles en consultas, enlaces de panel de control y enlaces de datos.

$__dashboard

Esta variable es el nombre del panel de control actual.

$__from y $__to

Grafana tiene dos variables de intervalo de tiempo integradas: $__from y $__to. Actualmente, siempre se interpolan como milisegundos de Epoch de forma predeterminada, pero puede controlar el formato de la fecha.

La sintaxis anterior también funciona con ${__to}.

También puede usar esta variable en las URL. Por ejemplo, para enviar a un usuario final a un panel de control que muestre un intervalo de tiempo desde hace 6 horas hasta ahora, utilice la siguiente URL: https://play.grafana.org/d/000000012/grafana-play-home?viewPanel=2&orgId=1?from=now-6h&to=now

$__interval

Puede usar la variable $__interval como parámetro para agrupar por tiempo (para InfluxDB, Myself, Postgres y MSSQL), intervalo de histograma de fecha (para OpenSearch) o como parámetro de la función de resumen (para Graphite).

El espacio de trabajo de Grafana calcula automáticamente un intervalo que se puede utilizar para agrupar por tiempo en las consultas. Cuando hay más puntos de datos de los que se pueden mostrar en un gráfico, las consultas se pueden hacer más eficientes al agruparlas por un intervalo mayor. Por ejemplo, es más eficiente agrupar por 1 día que por 10 segundos cuando se analizan datos de 3 meses. El gráfico tendrá el mismo aspecto y la consulta será más rápida. $__interval se calcula con el intervalo de tiempo y el ancho del gráfico (el número de píxeles).

Cálculo aproximado: (from - to) / resolution

Por ejemplo, si el intervalo de tiempo es de 1 hora y el gráfico está en pantalla completa, el intervalo podría calcularse en 2m: los puntos se agrupan en intervalos de 2 minutos. Si el intervalo de tiempo es de 6 meses y el gráfico es de pantalla completa, el intervalo puede ser 1d (1 día): los puntos se agrupan por día.

En el origen de datos de InfluxDB, la variable heredada $interval es la misma variable. En su lugar, use $__interval.

Los orígenes de datos de InfluxDB y OpenSearch tienen campos Group by time interval que se utilizan para hacer una codificación rígida del intervalo o para establecer el límite mínimo de la variable $__interval mediante la sintaxis > -> >10m.

$__interval_ms

Esta variable es la variable $__interval en milisegundos, no una cadena con formato de intervalo de tiempo. Por ejemplo, si $__interval es 20m, $__interval_ms es 1200000.

$__name

Esta variable solo está disponible en el panel de una sola estadística y se puede utilizar en los campos de prefijo o sufijo de la pestaña Opciones. La variable se sustituirá por el nombre o el alias de la serie.

$__org

Esta variable es el identificador de la organización actual. La variable ${__org.name} es el nombre de la organización actual.

$__user

La variable ${__user.id} es el identificador del usuario actual. La variable ${__user.login} es el identificador de inicio de sesión del usuario actual. La variable ${__user.email} es el correo electrónico del usuario actual.

$__range

Actualmente esta variable solo es compatible con los orígenes de datos de Prometheus. Esta variable representa el intervalo del panel de control actual. Se calcula mediante to - from. Tiene representaciones de segundos y milisegundos llamadas $__range_ms y $__range_s.

$timeFilter o $__timeFilter

La variable $timeFilter devuelve el intervalo de tiempo seleccionado actualmente como una expresión. Por ejemplo, la expresión Last 7 days del intervalo de tiempo es time > now() - 7d.

Esta variable se usa en varios lugares, entre ellos: