Variables de plantilla: filtrar dinámicamente el panel

Para personalizar el panel, puede emplear template variables para filtrar dinámicamente gráficos y otros widgets. Las variables de plantilla hacen que su panel sea más útil y lo ayudan a crear más fácilmente un panel que puede reutilizar para diferentes casos de uso.

¿Por qué utilizar variables de plantilla?

Las variables de plantilla son una forma potente y dinámica de filtrar un dashboard completo en función de valores de metadatos específicos que elija el creador dashboard . Los beneficios de utilizar variables de plantilla son:

• Hacen que el panel de control sea más fácil de usar: el usuario no tiene que comprender la estructura de los datos; simplemente puede elegir entre las distintas opciones de filtro que configuró.

• Le permiten crear plantillas dashboard reutilizables que luego puede duplicar y personalizar para muchos otros usos.

A continuación se muestra un ejemplo de un dashboard con varias variables de plantilla, que puede ver en la parte superior del dashboard.

Con las variables de plantilla, puede configurar una amplia variedad de variables y filtros para crear la experiencia dashboard que necesita. Ejemplos de experiencias que puedes crear:

• Un menú desplegable para elegir el nombre de una aplicación
• Un menú desplegable para elegir regiones específicas
• Un menú desplegable para seleccionar duraciones específicas u otros valores numéricos
• Filtros que utilizan campos de texto libre para encontrar cadenas coincidentes

Además, ahora puedes decidir si quieres incluir la variable o no sin tener que modificar tu consulta. Consulte la sección Incluir variable para obtener más detalles.

Incluir y excluir variables

El botón Include variable le permite establecer un valor deseado e incluir o excluir ese valor en su panel. Consulte la sección de variables de plantilla para obtener más información.

Por ejemplo, es posible que esté investigando un problema que no sea específico de ningún valor particular dentro de una variable. En tales casos, los valores existentes de la variable podrían limitar los resultados de la consulta, incluso cuando se seleccionan todas las opciones posibles. Para solucionar esto, puede excluir la variable de la consulta. Esto elimina efectivamente la condición de la variable y la reemplaza con un valor booleano neutral (verdadero o falso), lo que garantiza la validez de la consulta y devuelve resultados completos.

Ejemplo

Considere una consulta que filtra resultados según una variable countryCode . Si desea ver datos de todos los países sin filtrar, puede excluir la variable:

Consulta original:

FROM PageAction 
SELECT count(*) AS 'views' 
WHERE countryCode IN ({{countryCode}}) and appName = 'Test App' FACET countryCode

Consulta con una variable excluida:

FROM PageAction 
  SELECT count(*) AS 'views' 
  WHERE true and appName = 'Test App' FACET countryCode

Esta característica es particularmente útil cuando:

• La variable tiene más valores que el máximo permitido (por ejemplo, 5000 resultados máximos para únicos de forma predeterminada) o una cantidad muy alta de valores. Elegir deshabilitar la variable de forma predeterminada generará mejoras considerables en el rendimiento.

• La fuente de datos de la variable difiere de la base de datos que estás consultando. En estos casos, seleccionar todos los valores de la base de datos mediante "Seleccionar todo" no es suficiente. Al excluir la variable, puede recuperar todos los valores de la base de datos.

Limitaciones en la variable de inclusión:

• Cuando se emplea en casos FACET, la condición se reemplaza con verdadero y la convierte en una condición siempre verdadera.

• Cuando se emplea en otros contextos, como funciones o con la declaración SELECT, obtendrá el siguiente error: "Unknown function Disable_variable()". Esto se debe a que la función de deshabilitar variable aún no está implementada para estos casos específicos.

Requisitos y limitaciones

Las variables de plantilla solo se pueden utilizar en el contexto de personalizar el widget para el panel de control. Consulte Variables NRQL para utilizar variables en una consulta NRQL.

La consulta con variables de plantilla solo se puede utilizar en el contexto de un dashboard. Por este motivo, algunas características relacionadas con la consulta no funcionan. Por ejemplo, la opción Export dashboard as PDF no admite widgets con variables.

Puntos importantes a tener en cuenta al agregar una consulta:

• La variable que definiste va dentro de los corchetes {{ … }} .

• La variable genera un valor de cadena.

• Para ayudarte cuando estás creando una consulta, hay un código de color:

  • Las cláusulas from, select, facet y where están en rosa.
  • Identificador están en negro.
  • Las funciones están en azul.
  • Las cadenas están en verde.
  • Los números enteros están en marrón.

• Consulte nuestra página Cómo utilizar NRQL: la mecánica de las consultas si desea obtener más información sobre cómo redactar consultas con NRQL.

Para conocer las restricciones relacionadas con la consulta de redacción, consulte Consulta de redacción.

Usar variables de plantilla

Lo guiaremos en la creación de una variable de plantilla y luego le daremos algunos ejemplos de diferentes tipos de variables de plantilla.

La creación de una variable de plantilla consta de dos pasos.

Cuando haya terminado de definir una variable de plantilla y agregar un widget que haga referencia a esa variable, puede verificar que esté funcionando como se esperaba eligiendo diferentes opciones en la barra de variables de plantilla y viendo si el widget cambia según su selección.

Aquí hay un ejemplo del widget resultante, a la derecha, con el menú desplegable country a la izquierda.

Reglas para escribir una variable de plantilla de tipo consulta

Como se analizó en la sección sobre la definición de variables de plantilla, existen tres tipos de variables: consulta, lista y campo de texto. La variable de tipo consulta es la más compleja de crear porque debe crear una consulta funcional que devuelva una lista de valores, que luego se emplean para completar el desplegable en la barra de variables de plantilla en la parte superior del dashboard.

Puede emplear casi cualquier consulta NRQL siempre que devuelva una lista de valores. Para eso, puede emplear las funciones uniques o keyset .

Con uniques:

From PageAction select uniques(countryCode)

-- you can use the second param to define the maximum number of results to be listed.
    From PageAction select uniques(countryCode, 10000) --> this will return up to 10k results

Con keyset:

-- with `keyset`, you'll get a list with all of the attributes from the table you're querying from
    From PageAction select keyset() SINCE 1 day ago

Tenga en cuenta que no se admiten variables anidadas ya que no puede haber variables dentro de variables.

Algunos ejemplos

A continuación se muestran algunos tipos diferentes de implementaciones de variables de plantilla.

Utilice la opción de valores múltiples

Puede habilitar la opción de valores múltiples desde la sección de opciones de visualización al crear una variable de tipo NRQL/ENUM.

A continuación se muestra un ejemplo de una consulta que crea una variable denominada {{MultiValue}} y devuelve una lista de todos los ID de evento únicos:

SELECT uniques(eventId) FROM AjaxRequest

Copia

Luego crearías un widget con la siguiente consulta:

SELECT count(*) FROM AjaxRequest WHERE eventId IN ({{MultiValue}})

Copia

Utilice múltiples variables para un widget

Sólo puede definir una variable de plantilla a la vez, pero puede utilizar más de una variable de plantilla en un único widget.

A continuación se muestra un ejemplo de una consulta que utiliza dos variables de plantilla. Tenga en cuenta que esto supone que las variables de plantilla countryCode y city ya se habrán creado y que tienen un valor único.

SELECT countryCode, city FROM PageAction WHERE countryCode = {{countryCode}} and city = {{city}}

Copia

Si tiene varios valores para sus variables, como Chicago, New York, Paris para su variable city , debe usar IN:

SELECT countryCode, city FROM PageAction WHERE countryCode IN ({{countryCode}}) and city IN ({{city}})

Copia

Usar variables y coincidencia parcial.

Usando variables y expresiones regulares, puede crear un filtro, siempre que esté seguro de que una parte del filtro es fija.

Debe utilizar esta coincidencia parcial si desea utilizar like.

Supongamos que desea filtrar por versión de lanzamiento. La consulta devuelve algo como: release-1234.

Puede crear una variable usando aparse para analizar el número de versión:

SELECT uniques(aparse(platformVersion , 'release-*')) FROM PageView

Copia

Luego cree un widget con la siguiente consulta:

SELECT count(*) FROM PageAction WHERE aparse(platformVersion, 'release-*') IN ({{releaseversion}}) facet platformVersion

Copia

O si lo prefieres, puedes usar el comando capture :

SELECT count(*) FROM PageAction WHERE capture(platformVersion, r'release-(?P<platformVersion>\d+)') IN ({{releaseversion}}) Facet platformVersion

Copia

Emplee variables y expresiones regulares con LIKE y RLIKE

Puede utilizar LIKE y RLIKE como variables de plantilla para filtrar datos en un dashboard. Para usar esta característica, el valor que agregue al crear la variable de plantilla debe usar los símbolos comodín % al inicio y al final del valor.

He aquí un ejemplo. Usted define una variable de cadena, como se muestra aquí:

Luego puedes crear un gráfico widget y usar tu variable de esta manera:

FROM NrdbQuery SELECT user WHERE user LIKE {{like_filter}}

Copia

o así:

FROM NrdbQuery SELECT user WHERE user RLIKE {{like_filter}}

Copia

Utilice la variable facet con una consulta NRQL

Puede crear una variable de tipo NRQL con un formato de salida de cadena y usarla después de una cláusula facet para agrupar por diferentes valores.

Por ejemplo, podrías crear una variable denominada {{userAgentName}} que tendría este aspecto:

SELECT uniques(userAgentName) FROM PageAction

Copia

Luego crearías un widget con la siguiente consulta:

SELECT count(*) FROM PageAction WHERE userAgentName={{userAgentName}} FACET userAgentName

Copia

Utilice variables para agrupación dinámica

Puede crear una variable con un formato de salida identifier y usarla después de una cláusula FACET para agruparla por diferentes valores.

Por ejemplo, puede crear una variable {{location}} de tipo lista con dos valores posibles: countryCode y city. Establecerías el formato de salida en identifier.

Luego crearías un widget con la siguiente consulta:

SELECT count(*) FROM PageAction FACET {{location}}

Copia

Utilice variables para cambiar dinámicamente el percentil.

Puede crear una variable con formato de salida number y usarla dentro de una función de percentil.

Por ejemplo, podría crear una variable {{percentile}} de tipo list con dos valores posibles: 55 y 90. Querrá establecer el formato de salida como number.

Luego crearías un widget con la siguiente consulta:

SELECT percentile(duration,{{percentile}}) FROM PageAction

Copia

Usar variables para filtrar

Para usar variables para filtrar solo necesita agregar la variable creada en el lado derecho de una cláusula WHERE , como esta:

SELECT countryCode, city FROM PageAction WHERE countryCode IN ({{countryCode}})

Copia

Utilice la opción ignorar selector de tiempo

De forma predeterminada, la opción "ignorar el selector de tiempo" está habilitada, lo que significa que la consulta siempre se ejecuta utilizando el valor de rango de tiempo predeterminado 1 HOUR, incluso si el selector de tiempo en el dashboard tiene un valor diferente seleccionado (por ejemplo, 5 minutos, 3 horas, etc.). La excepción para ese caso es cuando la consulta tiene un rango de tiempo explícito establecido con una cláusula SINCE , como por ejemplo:

SELECT uniques(eventId) 
FROM AjaxRequest 
SINCE 5 minutes ago

Copia

Los resultados estarán en el rango de los últimos 5 minutos.

Cuando la opción “ignorar selector de tiempo” está desactivada, la consulta se ejecutará con el valor seleccionado en el selector de tiempo. Por ejemplo, si configura el selector de tiempo en 30 minutos, como en la captura de pantalla siguiente, en el formulario para editar las variables, el campo "ignorar selector de tiempo" se desactivará.

Esto da como resultado los valores de los últimos 30 minutos. Cuando establece el valor del selector de tiempo en Default y su consulta tiene una cláusula SINCE , se utilizará el último valor para ejecutar la consulta.

Emplee variables para seleccionar su tipo de datos `FROM`

A veces hay consultas que aplican las mismas reglas a diferentes tipos de datos. A continuación se muestran ejemplos de dos widgets que son idénticos excepto por el tipo de datos:

• Widget 1:

  SELECT count(*) FROM DataType1 SINCE 1 day ago

  Copia

• Widget 2:

  SELECT count(*) FROM DataType2 SINCE 1 day ago

  Copia

  En lugar de crear dos widgets separados, puede crear un widget con una variable que tenga el Identifier para el Output format. Luego, puedes usarlo en una cláusula FROM para consultar diferentes tipos de datos.

  Por ejemplo, puede crear una variable {{dataType}} de tipo List con dos valores posibles: DataType1 y DataType2. Establecerías el Output Format en Identifier:

  

  Luego, crearías y ejecutarías el widget: