Variables de Plantilla

Resumen

Las variables de plantilla le permiten filtrar o agrupar dinámicamente los widgets en un tablero. Cree vistas guardadas a partir de sus selecciones de variables de plantilla para organizar y navegar por sus visualizaciones mediante las selecciones desplegables.

Una variable de plantilla se define por:

  • Tag or Attribute:
  • Name: Un nombre único para la variable de plantilla que aparece en las consultas del tablero. Las variables de plantilla se nombran automáticamente según la etiqueta o atributo seleccionado.
  • Default Value: El valor de la etiqueta o atributo que aparece automáticamente cuando se carga el tablero. Por defecto es *.
  • Available Values: Los valores de la etiqueta o atributo disponibles para selección en el menú desplegable. Por defecto es (all). La lista de valores disponibles siempre incluye *, que consulta todos los valores de la etiqueta o atributo.

Valores de variables de plantilla

Los valores de las variables de plantilla (valores disponibles mediante los menús desplegables de variables de plantilla) se completan según las fuentes que utilizan los widgets en el tablero. Por ejemplo, si su tablero tiene widgets que consultan registros, solo se muestran los valores de los registros. Si su tablero tiene widgets que consultan registros, métricas y RUM, se muestran los valores de registros, métricas y RUM.

Para la mayoría de las fuentes, los valores de las variables de plantilla son relevantes para el marco de tiempo global de su tablero. Por ejemplo:

  • Si el marco de tiempo de su tablero está configurado para los últimos 15 minutos, solo se muestran los valores de las variables de plantilla de los últimos 15 minutos.
  • Si el marco de tiempo de su tablero está configurado para el 15 de agosto pasado de 12:00 a.m. a 11:59 p.m., solo se muestran los valores de ese marco de tiempo.
Fuente de datosPeríodo de consulta de datos
MétricasAhora - 48 horas
Costo en la nubeAhora - 48 horas
Todas las demás fuentesMarco de tiempo del tablero

Nota: Si no ve la etiqueta o atributo que está buscando, puede ser porque esos datos no se han reportado a Datadog recientemente. Además, todos los datos consultados para las variables de plantilla están sujetos a la política de retención de datos. Para más información, consulte Datos Históricos.

Diseño del tablero

Para evitar que las variables saturen el encabezado, el panel muestra un pequeño subconjunto. Puede hacer clic en el botón + N para ver las N variables adicionales presentes en su tablero.

Si necesita ver todas las variables a la vez mientras se desplaza, haga clic en Expandir variables de plantilla.

Agregue una variable de plantilla

Para agregar una variable de plantilla en un tablero:

  1. Haga clic en Add Variable (o en + si ya existen variables de plantilla)
  2. Seleccione de una lista de variables de plantilla recomendadas o busque la etiqueta específica que tenga en mente.
  3. Seleccione los widgets a los que se aplicará esta variable de plantilla.
  4. Haga clic en Save.

Configure la variable de plantilla

Cuando el panel lateral de la variable de plantilla esté abierto, puede:

  • Aplique (o quite) esta variable a los widgets seleccionados (note las opciones Select All o Deselect All)
  • Alterne entre filtrar y agrupar
  • Cambie el nombre de visualización de la variable (mostrado en el encabezado y en la consulta del widget)
  • Seleccione un valor predeterminado del menú desplegable
  • Previsualice los valores del menú desplegable y configúrelos más a fondo con una consulta de búsqueda

Edite una variable de plantilla

  1. Pase el cursor sobre la variable de plantilla en el encabezado del tablero y haga clic en Editar. El panel lateral de la variable de plantilla aparece.
  2. Utilice las opciones del panel para personalizar la variable o aplicarla a más widgets.

Vistas guardadas

Cree

  1. Haga clic en el menú desplegable Saved Views a la izquierda de las variables de plantilla en su tablero. Cuando actualiza el valor de una variable de plantilla, el valor no se guarda automáticamente en una vista.
  2. Para guardar los valores actuales de sus variables de plantilla en una vista, seleccione Save selections as view del menú desplegable Saved Views.
  3. Ingrese un nombre único para la vista con una descripción opcional.
  4. Haga clic en Save.
Cree vistas guardadas seleccionando guardar selecciones como vista

Su vista guardada aparece en el menú desplegable. Haga clic en la vista para recuperar los valores de variables de plantilla que guardó previamente.

Elimine

  1. Haga clic en el menú desplegable de vistas guardadas y pase el cursor sobre la vista guardada deseada.
  2. Haga clic en Delete View.

Modifique

El Default view solo puede ser editado cambiando los valores predeterminados de las variables de plantilla. Para editar la Vista Predeterminada:

  1. Pase el cursor sobre las plantillas.
  2. Haga clic en Edit cuando aparezca el botón. Haga clic en para guardar.
  3. Haga clic en Done para guardar.

Para modificar los valores de las variables de plantilla para otras vistas guardadas:

  1. Seleccione la vista guardada deseada del menú desplegable. Edite las variables de plantilla para tener los nuevos modelos deseados. Abra el menú desplegable nuevamente. Haga clic en .
  2. Edite las variables de plantilla para tener los nuevos modelos deseados.
  3. Abra el menú desplegable nuevamente.
  4. Haga clic en Save Changes.
Modifique las variables de plantilla de sus vistas guardadas

Para editar el título y la descripción:

  1. Pase el cursor sobre la vista guardada deseada del menú desplegable.
  2. Haga clic en Edit.
  3. Modifique el título o la descripción.
  4. Haga clic en Save.

Uso

Las variables de plantilla se utilizan en widgets y superposiciones de eventos.

Registros, consultas de APM y RUM

Las variables de plantilla funcionan con widgets de registros, APM y RUM porque comparten las mismas etiquetas. Puedes definir variables de plantilla de registros, APM y RUM basadas en facetas. Estas variables comienzan con @, por ejemplo: @http.status_code.

En widgets de registros, APM y RUM, puedes usar comodines en medio de un valor (por ejemplo, eng*@example.com) o usar múltiples comodines en un valor (por ejemplo, *prod*).

Nota: Usar Add to all para este tipo de variable de plantilla agrega la variable a todos los widgets de log, APM y RUM.

Widgets

Al crear o editar un widget, las variables de plantilla de filtro existentes se muestran como opciones en el campo from, y las variables de plantilla de agrupación existentes se muestran como opciones después del campo by. Por ejemplo, si configuras la variable de plantilla environment, la opción $environment está disponible como una variable dinámica en el widget.

La variable de plantilla se puede establecer dinámicamente en los widgets.

Al seleccionar producción para el valor environment, se limitan dinámicamente los widgets con la variable $environment al entorno de producción.

Cuando cambia el valor de una variable de plantilla, la URL del tablero se actualiza para reflejar el valor de la variable de plantilla con el formato &tpl_var_<TEMPLATE_VARIABLE_NAME>=<TEMPLATE_VARIABLE_VALUE>. Por ejemplo, un tablero con la variable de plantilla $env cambiada a prod tendría el parámetro de URL &tpl_var_env=prod.

Para incluir el valor en la consulta, añádalo con la sintaxis $<TEMPLATE_VARIABLE_NAME>.value. Por ejemplo, con una variable de plantilla llamada service, use env:staging-$service.value.

Pase el cursor sobre los campos de la variable de plantilla para ver de un vistazo los widgets que utilizan esa variable resaltados en el tablero.

Variables de plantilla asociadas

Al seleccionar un valor de variable de plantilla, los valores asociados se muestran en la parte superior del selector. Los valores asociados se calculan a partir de otros valores de variables de plantilla seleccionados en la página, e identifican sin problemas los valores relacionados sin ninguna configuración.

Texto

Para widgets basados en texto, puede mostrar la etiqueta/atributo y el valor de una variable de plantilla con $<TEMPLATE_VARIABLE_NAME>, su clave con $<TEMPLATE_VARIABLE_NAME>.key, o su valor con $<TEMPLATE_VARIABLE_NAME>.value. Esto puede venir después de cualquier carácter no alfanumérico, y puede ser seguido por un espacio en blanco o cualquiera de los siguientes caracteres: #, $, %, =, ;, ", (, ), [, ], {, }, ^, *, +, |, y ?.

Nota: La sintaxis de comodín no es compatible después de una variable de plantilla.

Por ejemplo, con una variable de plantilla llamada env, con etiqueta/atributo environment, y con un valor seleccionado de dev:

  • $env muestra environment:dev
  • $env.key muestra environment
  • $env.value muestra dev
  • $env* busca el valor exacto dev* NO dev{dynamic-wildcard-value}

Superposición de eventos

Utilice la búsqueda de superposición de eventos con variables de plantilla para encontrar eventos que compartan ciertas etiquetas con las métricas en su tablero. La búsqueda de superposición de eventos se aplica a través de un gráfico individual.

Los valores de las variables de plantilla del tablero pueden ser capturados directamente utilizando la sintaxis $<TEMPLATE_VARIABLE_KEY>.value en el campo de búsqueda de eventos.

Nota: Las variables de plantilla del tablero deben ser etiquetas de métricas, no etiquetas de eventos.

Tablero

Desde su tablero, busque eventos con variables de plantilla utilizando el formato:

<TAG_KEY>:$<TEMPLATE_VARIABLE_NAME>.value

Por ejemplo, buscar region:$region.value con un valor de us-east1 para la variable de plantilla region muestra eventos etiquetados con region:us-east1. Además, el tiempo de los eventos está marcado por barras rosas en los gráficos.

Utilice comas para buscar utilizando múltiples variables de plantilla, por ejemplo: role:$role.value,env:$env.value

Nota: Una vez que presione enter para buscar, $region.value se actualiza al valor en el menú desplegable de la variable de plantilla.

Widgets

Desde sus widgets, superponga el tiempo de los eventos utilizando variables de plantilla con el formato:

$<TEMPLATE_VARIABLE_NAME>

Por ejemplo, ingrese $region en el cuadro de búsqueda de superposición de eventos. Esto busca eventos con el valor en el menú desplegable de la variable de plantilla region.

Lectura adicional