Mejores prácticas para los cuadros de mando

Este tema de documentación está diseñado para los espacios de trabajo de Grafana que admiten la versión 10.x de Grafana.

Para ver los espacios de trabajo de Grafana que admiten la versión 9.x de Grafana, consulte. Trabajando en Grafana versión 9

Para ver los espacios de trabajo de Grafana que admiten la versión 8.x de Grafana, consulte. Trabajando en Grafana versión 8

Esta sección proporciona información sobre las mejores prácticas para los administradores y usuarios de Grafana sobre cómo crear y mantener los paneles de Grafana.

Para obtener información sobre los diferentes tipos de paneles que puede crear, consulte la entrada de blog sobre los paneles de Grafana: una guía completa de los diferentes tipos que puede crear en el sitio web de Grafana Labs.

nota

Esta sección puede ayudarte a crear una estrategia para la supervisión y el mantenimiento de los paneles. Usted conoce mejor sus sistemas y debería utilizar esta sección como guía para su comprensión. En última instancia, es su responsabilidad crear la mejor estrategia para su sistema.

Estrategias de observabilidad comunes

Cuando tiene mucho que monitorear, como un conjunto de servidores, necesita una estrategia para decidir qué es lo suficientemente importante como para monitorear. En esta página se describen varios métodos comunes para elegir lo que se va a supervisar.

Una estrategia lógica le permite crear cuadros de mando uniformes y escalar su plataforma de observabilidad con mayor facilidad.

Directrices para las estrategias

• El método USE le indica qué tan felices están sus máquinas, el método RED le indica qué tan felices están sus usuarios.

• USE informa sobre las causas de los problemas.

• RED informa sobre la experiencia del usuario y es más probable que informe sobre los síntomas de los problemas.

• Monitorear ambos es importante para entender el sistema. Como práctica recomendada, preste atención a los síntomas y no a las causas. Por lo general, las alertas se configuran en los paneles de RED.

Método USE

USE son las siglas de:

• Utilización: porcentaje de tiempo que el recurso está ocupado, como el uso de la CPU del nodo.

• Saturación: cantidad de trabajo que debe realizar un recurso, que suele ser la longitud de la cola o la carga del nodo.

• Errores: recuento de eventos de error.

Este método es el mejor para los recursos de hardware de la infraestructura, como la CPU, la memoria y los dispositivos de red. Para obtener más información, consulte la entrada del blog The USE Method de Brendan Gregg.

Método RED

RED significa:

• Tarifa: solicitudes por segundo

• Errores: número de solicitudes que fallan.

• Duración: cantidad de tiempo que tardan estas solicitudes, distribución de las mediciones de latencia.

Este método es más aplicable a los servicios, especialmente a un entorno de microservicios. Para cada uno de sus servicios, instrumente el código para mostrar estas métricas para cada componente. Los paneles RED son buenos para las alertas y los acuerdos de nivel de servicio (SLA). Un panel RED bien diseñado es un indicador de la experiencia del usuario.

Para obtener más información, consulte la entrada del blog de Tom Wilkie El método RED: cómo instrumentar sus servicios.

Las cuatro señales doradas

Según el manual SRE de Google, si solo puedes medir cuatro métricas de tu sistema orientado al usuario, céntrate en estas cuatro.

Este método es similar al método RED, pero incluye la saturación.

• Latencia: tiempo que se tarda en atender una solicitud.

• Tráfico: cuánta demanda se impone a su sistema.

• Errores: tasa de solicitudes que no se reciben correctamente.

• Saturación: qué tan «lleno» está su sistema,

Modelo de madurez de la gestión del panel

La madurez de la gestión de los cuadros de mando se refiere a lo bien diseñado y eficiente que esté su ecosistema de cuadros de mando. Te recomendamos revisar periódicamente la configuración de tu panel de control para evaluar en qué punto te encuentras y cómo puedes mejorar.

En términos generales, la madurez del panel se puede definir como baja, media o alta.

Gran parte del contenido de este tema se extrajo de la charla de KubeCon 2019: Cuadros de mando de Kubernetes infalibles para personas con problemas de sueño.

Bajo: estado predeterminado

En este momento, no tiene una estrategia coherente de gestión de los cuadros de mando. Casi todo el mundo empieza aquí.

¿Cómo puedes saber que estás aquí?

• Todos pueden modificar sus cuadros de mando.

• Muchos paneles copiados y poca o ninguna reutilización de los mismos.

• Paneles únicos que perduran para siempre.

• Sin control de versiones (panel JSON en el control de versiones).

• Mucha navegación en busca de paneles, buscando el panel correcto. Esto significa perder mucho tiempo intentando encontrar el panel de control que necesita.

• No tener ninguna alerta que lo dirija al panel correcto.

Tamaño medio: paneles metódicos

En esta etapa, empezará a administrar el uso de los paneles con paneles metódicos. Puede que hayas diseñado una estrategia, pero hay algunas cosas que podrías mejorar.

¿Cómo puedes saber que estás aquí?

• Evite la expansión mediante el uso de variables de plantilla. Por ejemplo, no necesita un panel independiente para cada nodo, sino que puede utilizar variables de consulta. Y lo que es mejor, también puedes convertir la fuente de datos en una variable de plantilla, de modo que puedas reutilizar el mismo panel en distintos clústeres y sistemas de supervisión.

  Consulte la lista de ejemplos enVariables, para obtener ideas.

• Cuadros de mando metódicos según una estrategia de observabilidad.

• Paneles jerárquicos con desgloses para pasar al siguiente nivel.

• El diseño del panel refleja las jerarquías de servicios. Por ejemplo, puede utilizar el método RED con una fila por servicio. El orden de las filas podría reflejar el flujo de datos a medida que se desplaza hacia abajo en el panel.

• Compare entre sí: divida los paneles de servicio cuando la magnitud varíe. Asegúrese de que las métricas agregadas no oculten información importante.

• Gráficos expresivos con un uso significativo del color y ejes de normalización siempre que sea posible.

  • Ejemplo de color significativo: el azul significa que es bueno, el rojo significa que es malo. Los umbrales pueden ayudar con eso.

  • Ejemplo de normalización de ejes: al comparar el uso de la CPU, mida por porcentaje en lugar de por número bruto, ya que las máquinas pueden tener un número diferente de núcleos. La normalización del uso de la CPU en función del número de núcleos reduce la carga cognitiva, ya que el espectador puede confiar en que se están utilizando todos los núcleos al 100%, sin tener que saber el número de CPU.

• La navegación dirigida reduce las conjeturas.

  • Las variables de plantilla dificultan la navegación aleatoria o sin rumbo fijo.

  • La mayoría de los paneles deberían estar enlazados mediante alertas.

  • La navegación se realiza mediante enlaces. Para obtener más información, consulte Administrar los enlaces del panel.

• Panel de control de versiones JSON.

Uso altamente optimizado

En esta etapa, ha optimizado el uso de la administración de sus paneles de control con una estrategia coherente y bien pensada. Requiere mantenimiento, pero los resultados merecen la pena.

• Reducir activamente la expansión.

  • Revise periódicamente los cuadros de mando existentes para asegurarse de que siguen siendo relevantes.

  • Solo los paneles aprobados se agregan a la lista maestra de paneles.

  • Seguimiento del uso del panel de control. Puedes aprovechar la información sobre el uso.

• Consistencia por diseño.

• Utilice bibliotecas de secuencias de comandos para generar cuadros de mando y garantizar la coherencia en el diseño y el estilo.

  • grafonnet (Jsonnet)

  • grafanalib (Python)

• Sin edición en el navegador. Los visores del panel cambian las vistas con variables.

• La búsqueda de paneles es la excepción, no la regla.

• Realice la experimentación y las pruebas en una instancia de Grafana independiente dedicada a ese propósito, no en su instancia de producción. Cuando se demuestre que un panel en el entorno de prueba es útil, añada ese panel a su instancia principal de Grafana.

Mejores prácticas para crear paneles

En esta sección, se describen algunas de las mejores prácticas que se deben seguir al crear paneles de Grafana.

Antes de empezar

Estos son algunos principios que se deben tener en cuenta antes de crear un panel.

Un panel debe contar una historia o responder a una pregunta

¿Qué historia intentas contar con tu panel de control? Intenta crear una progresión lógica de los datos, por ejemplo, de grandes a pequeños o de generales a específicos. ¿Cuál es el objetivo de este panel? (Sugerencia: si el panel no tiene un objetivo, pregúntese si realmente lo necesita).

Mantén tus gráficos simples y céntrate en responder a la pregunta que te estás planteando. Por ejemplo, si su pregunta es «¿qué servidores tienen problemas?» , entonces quizás no necesites mostrar todos los datos del servidor. Simplemente muestre los datos de los que están en problemas.

Los cuadros de mando deberían reducir la carga cognitiva, no aumentarla

La carga cognitiva es básicamente la cantidad de esfuerzo que necesitas para pensar en algo para entenderlo. Haga que su panel de control sea fácil de interpretar. Otros usuarios y tú en el futuro (cuando intentes averiguar qué pasó a las 2 de la mañana) lo agradecerán.

Pregúntate a ti mismo:

• ¿Puedo decir qué representa exactamente cada gráfico? ¿Es obvio o tengo que pensarlo?

• Si se lo muestro a otra persona, ¿cuánto tardará en descubrirlo? ¿Se perderán?

¿Tienen una estrategia de monitoreo

Es fácil crear nuevos cuadros de mando. Es más difícil optimizar la creación de paneles y seguir un plan, pero vale la pena. Esta estrategia debería regir tanto el esquema general del panel como garantizar la coherencia en el diseño de los paneles individuales.

Consulte las estrategias de observabilidad comunes y los niveles de madurez de la gestión de los paneles para obtener más información.

Escríbalo

Una vez que tengas una estrategia o unas pautas de diseño, escríbelas para ayudar a mantener la coherencia a lo largo del tiempo.

Mejores prácticas a seguir

• Al crear un panel nuevo, asegúrese de que tenga un nombre significativo.

  • Si vas a crear un panel para jugar o experimentar, coloca la palabra TEST or TMP en el nombre.

  • Considere incluir su nombre o sus iniciales en el nombre del panel o como una etiqueta para que las personas sepan quién es el propietario del panel.

  • Elimine los paneles de experimentos temporales cuando haya terminado de usarlos.

• Si crea muchos paneles relacionados, piense en cómo hacer referencias cruzadas entre ellos para facilitar la navegación. Para obtener más información, consulte Prácticas recomendadas para la administración de paneles, más adelante en esta sección.

• Grafana recupera datos de una fuente de datos. Es importante tener una comprensión básica de Conexión con orígenes de datos sus fuentes de datos generales y específicas.

• Evite actualizar innecesariamente el panel de control para reducir la carga en la red o en el backend. Por ejemplo, si tus datos cambian cada hora, no necesitas establecer la frecuencia de actualización del panel en 30 segundos.

• Usa los ejes Y izquierdo y derecho al mostrar series temporales con diferentes unidades o rangos.

• Añada documentación a los cuadros de mando y paneles.

  • Para añadir documentación a un cuadro de mando, añada una visualización del panel de texto al cuadro de mando. Registre aspectos como el propósito del panel, los enlaces a recursos útiles y cualquier instrucción que los usuarios puedan necesitar para interactuar con el panel.

  • Para añadir documentación a un panel, edite la configuración del panel y añada una descripción. Cualquier texto que añadas aparecerá si pasas el cursor por encima de la letra pequeña i situada en la esquina superior izquierda del panel.

• Reutilice sus paneles y refuerce la coherencia mediante el uso de plantillas y variables.

• Tenga cuidado al apilar los datos de los gráficos. Las visualizaciones pueden ser engañosas y ocultar datos importantes. Recomendamos desactivarlo en la mayoría de los casos.

Prácticas recomendadas para administrar los paneles

Esta página describe algunas de las mejores prácticas a seguir al administrar los paneles de Grafana.

Antes de empezar

Estos son algunos principios que se deben tener en cuenta antes de empezar a gestionar los paneles.

Observabilidad estratégica

Existen varias estrategias de observabilidad comunes. Debes investigarlas y decidir si una de ellas funciona para ti o si quieres crear la tuya propia. De cualquier manera, ten un plan, escríbelo y cúmplelo.

Adapte su estrategia a las necesidades cambiantes según sea necesario.

Nivel de madurez

¿Cuál es el nivel de madurez de su panel de control? Analice la configuración actual de su panel de control y compárela con el modelo de madurez de la administración del panel de control. Entender dónde se encuentra puede ayudarle a decidir cómo llegar a donde quiere estar.

Mejores prácticas a seguir

• Evite la expansión de los cuadros de mando, es decir, el crecimiento descontrolado de los cuadros de mando. La dispersión de los cuadros de mando afecta negativamente al tiempo necesario para encontrar el cuadro de mando adecuado. Duplicar los paneles y cambiar «una cosa» (lo que es peor: conservar las etiquetas originales) es la forma más fácil de hacerlo de forma descontrolada.

  • Revise periódicamente los cuadros de mando y elimine los que no sean necesarios.

  • Si crea un panel temporal, tal vez para probar algo, añada el nombre al nombre como prefijo. TEST: Elimine el panel cuando haya terminado.

• Copiar los cuadros de mando sin cambios significativos no es una buena idea.

  • Te pierdes las actualizaciones del panel original, como los cambios en la documentación, las correcciones de errores o las adiciones a las métricas.

  • En muchos casos, las copias se realizan simplemente para personalizar la vista mediante la configuración de los parámetros de la plantilla. En su lugar, esto debería hacerse manteniendo un enlace al panel principal y personalizando la vista con los parámetros de la URL.

• Cuando deba copiar un panel, cámbiele el nombre claramente y no copie las etiquetas del panel. Las etiquetas son metadatos importantes para los paneles que se utilizan durante la búsqueda. Si se copian etiquetas, se pueden producir coincidencias falsas.

• Mantenga un panel de paneles o paneles de referencia cruzada. Esto se puede hacer de varias maneras:

  • Cree enlaces a cuadros de mando, paneles o enlaces de datos. Los enlaces pueden ir a otros paneles o a sistemas externos. Para obtener más información, consulte los enlaces a la sección Administrar los paneles de control.

  • Agregue un panel de lista de paneles. A continuación, puede personalizar lo que ve mediante búsquedas en etiquetas o carpetas.

  • Agrega un panel de texto y usa Markdown para personalizar la pantalla.