Plugin de origen de datos de ClickHouse para Grafana

Introducción al uso de ClickHouse con Grafana

Con Grafana, puedes explorar y compartir todos tus datos a través de dashboards. Grafana requiere un plugin para conectarse a ClickHouse, que puede instalarse fácilmente desde su UI.

​

1. Recopila los datos de conexión

Para conectarse a ClickHouse con TCP nativo necesita esta información:

Parámetros	Descripción
HOST and PORT	Normalmente, el puerto es 9440 cuando se usa TLS, o 9000 cuando no se usa TLS.
DATABASE NAME	De forma predeterminada, existe una base de datos llamada default; use el nombre de la base de datos a la que quiere conectarse.
USERNAME and PASSWORD	De forma predeterminada, el nombre de usuario es default. Use el nombre de usuario adecuado para su caso de uso.

Los detalles de su servicio de ClickHouse Cloud están disponibles en la consola de ClickHouse Cloud. Seleccione el servicio al que se conectará y haga clic en Connect:

Seleccione Native; los detalles se muestran en un comando de ejemplo de clickhouse-client.

Si usa ClickHouse autogestionado, los detalles de la conexión los establece su administrador de ClickHouse.

​

2. Crear un usuario de solo lectura

Al conectar ClickHouse a una herramienta de visualización de datos como Grafana, se recomienda crear un usuario de solo lectura para proteger sus datos frente a modificaciones no deseadas.

Grafana no valida que las consultas sean seguras. Las consultas pueden contener cualquier sentencia SQL, incluidas DELETE e INSERT.

Para configurar un usuario de solo lectura, siga estos pasos:

1. Cree un perfil de usuario readonly siguiendo la guía Creación de usuarios y roles en ClickHouse.
2. Asegúrese de que el usuario readonly tenga los permisos necesarios para modificar la configuración max_execution_time que requiere el cliente clickhouse-go.
3. Si utiliza una instancia pública de ClickHouse, no es recomendable establecer readonly=2 en el perfil readonly. En su lugar, deje readonly=1 y establezca el tipo de restricción de max_execution_time en changeable_in_readonly para permitir modificar esta configuración.

​

3. Instala el plugin de ClickHouse para Grafana

Antes de que Grafana pueda conectarse a ClickHouse, debes instalar el plugin de Grafana correspondiente. Si ya has iniciado sesión en Grafana, sigue estos pasos:

1. En la página Connections de la barra lateral, selecciona la pestaña Add new connection.

2. Busca ClickHouse y haz clic en el plugin firmado por Grafana Labs:

3. En la siguiente pantalla, haz clic en el botón Install:

​

4. Defina un origen de datos de ClickHouse

1. Una vez completada la instalación, haga clic en el botón Add new data source. (También puede añadir un origen de datos desde la pestaña Data sources de la página Connections).

2. Desplácese hacia abajo hasta encontrar el tipo de origen de datos ClickHouse o búsquelo en la barra de búsqueda de la página Add data source. Seleccione el origen de datos ClickHouse y aparecerá la siguiente página:

3. Introduzca la configuración del servidor y las credenciales. Los ajustes clave son:

• Server host address: el hostname de su servicio de ClickHouse.
• Server port: el puerto de su servicio de ClickHouse. Variará según la configuración del servidor y el protocolo.
• Protocol el protocolo utilizado para conectarse a su servicio de ClickHouse.
• Secure connection actívelo si su servidor requiere una conexión segura.
• Username y Password: introduzca las credenciales de su usuario de ClickHouse. Si no ha configurado ningún usuario, pruebe con default como nombre de usuario. Se recomienda configurar un usuario de solo lectura.

Para ver más ajustes, consulte la documentación de configuración del plugin.

4. Haga clic en el botón Save & test para verificar que Grafana pueda conectarse a su servicio de ClickHouse. Si la conexión se realiza correctamente, verá el mensaje Data source is working:

​

5. Siguientes pasos

¡Su origen de datos ya está lista para usarse! Obtenga más información sobre cómo crear consultas con el generador de consultas.

Para más detalles sobre la configuración, consulte la documentación de configuración del plugin.

Si busca más información que no esté incluida en esta documentación, consulte el repositorio del plugin en GitHub.

​

Actualización de versiones del plugin

A partir de la versión 4, las configuraciones y las consultas pueden actualizarse a medida que se publican nuevas versiones.

Las configuraciones y consultas de la versión 3 se migran a la versión 4 al abrirse. Aunque las configuraciones y los paneles antiguos se cargarán en la versión 4, la migración no se guarda hasta que se vuelvan a guardar en la nueva versión. Si observas algún problema al abrir una configuración/consulta antigua, descarta los cambios y reporta el problema en GitHub.

El plugin no puede volver a versiones anteriores si la configuración/consulta se creó con una versión más reciente.