{"id":14996,"date":"2023-10-30T12:43:23","date_gmt":"2023-10-30T19:43:23","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=14996"},"modified":"2023-12-18T12:31:06","modified_gmt":"2023-12-18T20:31:06","slug":"scraping-database-metrics-from-couchbase-capella-with-prometheus","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/scraping-database-metrics-from-couchbase-capella-with-prometheus\/","title":{"rendered":"Raspado de m\u00e9tricas de base de datos desde Couchbase Capella con Prometheus"},"content":{"rendered":"

En esta entrada de blog, la primera de una serie, vamos a mostrarte c\u00f3mo configurar un servidor Prometheus y conectarlo a tu base de datos Couchbase Capella para recopilar m\u00e9tricas.<\/span><\/p>\n

\u00bfQu\u00e9 es Prometeo?<\/span><\/h2>\n

Prometeo<\/span><\/a> es un conjunto de herramientas de supervisi\u00f3n y alerta de sistemas de c\u00f3digo abierto muy popular, con una comunidad de desarrolladores y usuarios muy activa. Se cre\u00f3 originalmente en <\/span>SoundCloud<\/span><\/a>pero ahora es un proyecto independiente de c\u00f3digo abierto, mantenido con independencia de cualquier empresa, y se uni\u00f3 a la iniciativa <\/span>Fundaci\u00f3n para la Computaci\u00f3n Nativa en la Nube<\/span><\/a> en 2016 como segundo proyecto acogido, tras <\/span>Kubernetes<\/span><\/a>.<\/span><\/p>\n

\u00bfQu\u00e9 es Couchbase Capella?<\/span><\/h2>\n

Couchbase Capella<\/span><\/a> es nuestra oferta de base de datos como servicio (DBaaS) totalmente gestionada, la forma m\u00e1s f\u00e1cil y r\u00e1pida de empezar con Couchbase y eliminar los esfuerzos continuos de gesti\u00f3n de bases de datos. Su base de datos Capella contiene un objetivo de raspado Prometheus nativo, lo que le permite conectar sus sistemas de monitoreo Prometheus (o compatibles con Prometheus) para recopilar m\u00e9tricas.<\/span><\/p>\n

Requisitos previos<\/span><\/h2>\n

Para seguir los pasos de esta gu\u00eda, necesitar\u00e1 una instalaci\u00f3n Docker en funcionamiento (que utilizaremos para desplegar Prometheus), una base de datos Capella y algunas utilidades shell comunes.<\/span><\/p>\n

Nota: Queda fuera del alcance de este post mostrar c\u00f3mo instalar y configurar <\/span><\/i>Docker<\/span><\/i><\/a>. Existen muchos tutoriales, incluido el propio de Docker <\/span><\/i>Introducci\u00f3n a Docker<\/span><\/i><\/a>. En este punto, supondremos que lo ha instalado y probado correctamente (por ejemplo, con <\/span><\/i>Hola, mundo.<\/span><\/i><\/a>).<\/span><\/i><\/p>\n

En el momento de escribir esto, la \u00faltima versi\u00f3n de Prometheus era la 2.46. Los pasos aqu\u00ed se llevaron a cabo utilizando Rancher Desktop 1.9.1, con el motor de contenedores establecido en dockerd (moby) y utilizando la CLI de docker proporcionada. La expectativa es que los pasos deber\u00edan funcionar tal cual en cualquier instalaci\u00f3n actual de Docker, o una pila equivalente como containerd con la CLI nerdctl.<\/span><\/i><\/p>\n

Por \u00faltimo, los comandos compartidos aqu\u00ed son adecuados para entornos de desarrollo aut\u00f3nomos de corta duraci\u00f3n; por supuesto, debes seguir tus mejores pr\u00e1cticas locales de red y seguridad cuando proceda.<\/span><\/i><\/p>\n

Ejecutar un servidor Prometheus en Docker<\/span><\/h2>\n

Vamos a ejecutar el \u00faltimo contenedor Prometheus (<\/span>prom\/prometheus<\/span><\/a>) con su configuraci\u00f3n por defecto.<\/span><\/p>\n

En <\/span>docker run<\/span> tiene muchas opciones, pero para este ejemplo s\u00f3lo usaremos una <\/span>-p<\/em> \/ -publicar<\/em><\/span> para exponer el puerto Prometheus (que por defecto es 9090<\/em>) para que podamos acceder a \u00e9l desde nuestro navegador local, y un <\/span>-rm<\/span><\/em> para asegurarse de que el contenedor se limpia al salir.<\/span><\/p>\n

Por defecto, el contenedor en ejecuci\u00f3n permanecer\u00e1 \"conectado\", transmitiendo los registros a la salida est\u00e1ndar (en este caso, su terminal). Vamos a hacer eso para la primera ejecuci\u00f3n para que podamos asegurarnos de que se inicia correctamente:<\/span><\/p>\n

docker run --rm --publish 9090:9090 prom\/prometheus<\/pre>\n
A menos que vea alg\u00fan error en la salida de la consola, ahora deber\u00eda tener un servidor Prometheus ejecut\u00e1ndose en <\/span>https:\/\/localhost:9090\/<\/em><\/span><\/a>. \u00c1brelo en una ventana del navegador y ver\u00e1s algo parecido a esto:<\/span><\/p>\n
\"\"<\/a><\/p>\n
Ahora vuelve a tu ventana de terminal y pulsa Ctrl+C<\/em> para matar el contenedor en ejecuci\u00f3n, luego lo iniciaremos de nuevo, pero esta vez utilizando un <\/span>-d<\/em> \/ -detach<\/em><\/span> para ponerlo en segundo plano y liberar nuestro terminal:<\/span><\/p>\n
docker run --detach --rm --publish 9090:9090 prom\/prometheus<\/pre>\n
En caso de \u00e9xito, Docker imprimir\u00e1 el ID del contenedor, y tambi\u00e9n se puede encontrar con <\/span>docker ps<\/em>.<\/span>\u00a0Como de todas formas lo necesitar\u00e1s para algunos de los pasos posteriores, vamos a filtrar (con <\/span>-f<\/em> \/ -filtro<\/em><\/span>) la salida de <\/span>docker ps<\/span><\/em> para mostrar s\u00f3lo el ID de contenedor que queremos, bas\u00e1ndonos en los puertos de red que estamos utilizando (en este caso estamos publicando el puerto 9090<\/em>):<\/span><\/p>\n
docker ps --filter publish=9090<\/pre>\n
Podemos a\u00f1adir un <\/span>-q<\/em> \/ -silencio<\/em><\/span> a <\/span>s\u00f3lo<\/span><\/i> obtenga el ID del contenedor y utilice el resultado en otro comando. Por ejemplo, para ver los registros del contenedor Prometheus que acaba de iniciar:<\/span><\/p>\n
docker logs $(docker ps --quiet --filter publish=9090)<\/pre>\n
Ese comando mostrar\u00e1 algo similar a cuando arranc\u00f3 el servidor Prometheus la primera vez, cuando el contenedor a\u00fan estaba conectado al terminal. Puede utilizar la misma t\u00e9cnica con (por ejemplo) <\/span>docker exec<\/span><\/em> (si desea iniciar un shell en un contenedor en ejecuci\u00f3n), o bien <\/span>docker kill<\/span><\/em> (para enviar una se\u00f1al al contenedor).<\/span><\/p>\n
Echemos un vistazo m\u00e1s profundo al servidor Prometheus en el que se est\u00e1 ejecutando <\/span>https:\/\/localhost:9090\/<\/span><\/a><\/em>. Si navega a Estado -> Objetivos<\/strong>puede ver que ya hay un trabajo en ejecuci\u00f3n:<\/span><\/p>\n
\"\"<\/a><\/span><\/p>\n
Este servidor Prometheus ha sido configurado para raspar <\/span>s\u00ed mismo<\/span><\/i> como objetivo, lo que puede confirmar viendo su configuraci\u00f3n (Estado -> Configuraci\u00f3n<\/strong>):<\/span><\/p>\n
\"\"<\/a><\/p>\n
Puede ver en la imagen de arriba que hay un trabajo llamado <\/span>prometheus<\/span><\/em>cuyo objetivo es <\/span>localhost:9090\/m\u00e9tricas<\/span><\/em> (<\/span>targets + metrics_path<\/span><\/em>). V\u00e9ase <\/span>Configurar Prometheus para que se supervise a s\u00ed mismo<\/span><\/a> para ver un ejemplo de configuraci\u00f3n.<\/span><\/p>\n
Antes de volver a nuestro terminal, echemos un vistazo r\u00e1pido a las m\u00e9tricas que se est\u00e1n raspando en el trabajo anterior. Si hace clic en Gr\u00e1fico, encontrar\u00e1 el icono <\/span>Navegador de expresiones<\/span><\/a>que permite introducir expresiones PromQL (v\u00e9ase <\/span>Consulta a Prometheus<\/span><\/a> para obtener una visi\u00f3n general), y ver los resultados.<\/span><\/p>\n
Tenga en cuenta la Navegador de expresiones<\/strong> es s\u00f3lo para uso ad hoc - la recomendaci\u00f3n es utilizar <\/span>Grafana<\/span><\/a> como una soluci\u00f3n de gr\u00e1ficos completa, y lo veremos en un pr\u00f3ximo post. Mientras tanto, como ejemplo r\u00e1pido, este es el n\u00famero de series temporales almacenadas actualmente en su propia base de datos (<\/span>prometheus_tsdb_head_series<\/span><\/em>):<\/span><\/p>\n
\"\"<\/a><\/p>\n
Si queremos a\u00f1adir nuestra base de datos Capella como un Scrape Job en nuestro servidor Prometheus, esto significa que tenemos que hacer cambios en la configuraci\u00f3n que vimos anteriormente, pero la configuraci\u00f3n se hornea en nuestra imagen de contenedor. Una vez que tengamos una configuraci\u00f3n final podemos reconstruir la imagen, pero por ahora ser\u00eda mucho m\u00e1s conveniente si pudi\u00e9ramos aplicar nuevas opciones de configuraci\u00f3n y probar sin tener que hacer tanto esfuerzo.<\/span><\/p>\n
Hagamos uso de Docker's<\/span> -v<\/em> \/ -volumen<\/em><\/span> que permite montar un archivo o directorio local en el contenedor. El archivo de configuraci\u00f3n de Prometheus en el contenedor es <\/span>\/etc\/prometheus\/prometheus.yml<\/span><\/em> - Si ese fuera el \u00fanico archivo que necesitamos, podr\u00edamos montarlo directamente, pero necesitaremos algunos m\u00e1s, as\u00ed que montaremos un directorio en su lugar.<\/span><\/p>\n
En su directorio de trabajo, cree un subdirectorio que utilizaremos para guardar nuestra configuraci\u00f3n (<\/span>prometheus.yml<\/span><\/em>) y otros archivos asociados.<\/span><\/p>\n
mkdir prometheus<\/pre>\n
Ahora necesitamos una copia del archivo de configuraci\u00f3n con la que podamos trabajar. Como siempre, hay m\u00e1s de una manera de hacer esto, pero con mucho, la m\u00e1s sencilla es utilizar el comando <\/span>docker cp<\/span> para copiar <\/span>\/etc\/prometheus\/prometheus.yml<\/span><\/em> de su contenedor en ejecuci\u00f3n, a un archivo local:<\/span><\/p>\n
docker cp $(docker ps --quiet --filter publish=9090):\/etc\/prometheus\/prometheus.yml prometheus\/<\/pre>\n
Ahora mata tu contenedor en ejecuci\u00f3n:<\/span><\/p>\n
docker kill $(docker ps --quiet --filter publish=9090)<\/pre>\n
A continuaci\u00f3n, inicie un nuevo contenedor, esta vez montando su local <\/span>prometheus<\/span><\/em> directorio como <\/span>\/etc\/prometheus\/<\/span><\/em> en el contenedor:<\/span><\/p>\n
docker run --detach --rm --publish 9090:9090 --volume $(pwd)\/prometheus\/:\/etc\/prometheus\/ prom\/prometheus<\/pre>\n
Si, como el autor, se pregunta c\u00f3mo saber si el servidor Prometheus est\u00e1 utilizando realmente su copia de <\/span>prometheus.yml<\/span><\/em> o no, puede comprobar los montajes dentro del contenedor para asegurarse de que <\/span>\/etc\/prometheus\/ <\/span><\/em>se monta espec\u00edficamente con:<\/span><\/p>\n
docker exec $(docker ps --quiet --filter publish=9090) mount | grep '\/etc\/prometheus'<\/pre>\n
Tambi\u00e9n puede hacer un peque\u00f1o cambio en la configuraci\u00f3n (por ejemplo, el nombre del trabajo de raspado existente), y esto deber\u00eda reflejarse en la consola (en <\/span>https:\/\/localhost:9090\/config<\/span><\/a>).<\/span><\/p>\n
Por \u00faltimo para esta secci\u00f3n, como vamos a hacer algunos cambios en nuestro archivo de configuraci\u00f3n, ser\u00eda bueno si no tuvi\u00e9ramos que volver a crear el contenedor para aplicar los cambios. Prometheus tiene un m\u00e9todo integrado en la API para esto, discutido en <\/span>Configuraci\u00f3n<\/span><\/a>pero el <\/span>-web.enable-lifecycle<\/span><\/em> no est\u00e1 activada por defecto en el contenedor oficial. Afortunadamente (al menos para los usuarios de MacOS y Linux), existe la opci\u00f3n de enviar un SIGHUP con <\/span>docker kill<\/span><\/em> (aparece el mensaje \"Cargando archivo de configuraci\u00f3n\" en los registros):<\/span><\/p>\n
docker kill --signal SIGHUP $(docker ps --quiet --filter publish=9090)<\/pre>\n
En resumen, ahora tenemos un servidor Prometheus en funcionamiento, sabemos c\u00f3mo comprobar sus registros, explorar las m\u00e9tricas que est\u00e1 explorando y c\u00f3mo actualizar y recargar su configuraci\u00f3n, lo que nos facilita la tarea de a\u00f1adir nuestra base de datos Capella como objetivo de exploraci\u00f3n.<\/span><\/p>\n
A\u00f1adir una base de datos Capella a su servidor Prometheus<\/span><\/h2>\n
Ahora que tenemos un servidor Prometheus, vamos a echar un vistazo a la adici\u00f3n de una base de datos Couchbase Capella.<\/span><\/p>\n
Requisitos previos<\/span><\/h3>\n
Para cada base de datos de la que quieras recoger m\u00e9tricas, vas a necesitar:<\/span><\/p>\n