Apache Camel: Control de Trazas con Zipkin

Hoy vamos a ver posiblemente uno de los post más sencillos que hemos hecho de Apache Camel. En el veremos como integrarlo con Zipkin. 

Zipkin es una herramienta distribuida de instrumentación y monitorización que nos permitirá recopilar información de servicios y realizar búsquedas sobre la misma. Con el objetivo de hallar problemas en la latencia de los mismos, a través principalmente de evaluar cuanto tiempo ha tardado en la ejecución del servicio. 

Ya vimos hace tiempo un ejemplo de Apache Camel con Jaeger, aquí. Y esta es otra herramienta pero con un objetivo similar. Por lo que nos servirá refrescar conceptos que vimos en el anterior post:

• Distributed Tracing: Es un método utilizado para perfilar y supervisar las aplicaciones. Nos ayuda a señalar dónde ocurren los fallos y qué es lo que causa el mal funcionamiento.
• Span: Es el principal componente de una traza distribuida, que representa una unidad individual de trabajo realizada en un sistema distribuido. Estos encapsulan información de la aplicación.
• Traza: Es un gráfico acíclico de Span. 

Camel Zipkin es un componente que nos permitirá rastrear los mensajes de entrada y salida a Camel y su tiempo asociado. Los span serán capturado y enviados a Zipkin. 

Uno de los puntos importantes, es que se cree un mapeo de los endpoints de Apache Camel para que se pueda realizar mejores búsquedas en Zipkin. Asociando cada span a un servicio concreto y no a toda la aplicación. 

El mapeo de los servicios se puede realizar con el uso de wildcards o expresiones regulares. Si no se indica nada, Camel mandará por defecto la URL de las invocaciones. 

Pero empecemos con el ejemplo, el cual podremos ver en marcha facilmente. El primer paso será levantar un docker con zipkin. Lo cual podemos hacer en una sola linea. 

docker run -d -p 9411:9411 openzipkin/zipkin

Y el siguiente paso será configurar nuestra aplicación. Como efecto diferenciador a cualquier otra aplicación de Apache camel tendremos que añadir la dependencia para hacer uso de Zipkin. Como nosotros utilizamos Apache Camel con Spring, solo necesitaremos el starter. 

<dependency>
	<groupId>org.apache.camel.springboot</groupId>
	<artifactId>camel-zipkin-starter</artifactId>
</dependency>

Lo siguiente será configurar la aplicación para el envío de información a Zipkin a través de la anotación @CamelZipkin que pondremos en la clase principal de arranque. Y en el fichero de configuración indicaremos la URL donde se enviarán los spans.

camel.zipkin.endpoint=http://localhost:9411/api/v2/spans

Ahora ya podremos realizar invocaciones a los métodos de nuestros servicios y veremos dichas invocaciones en la interfaz gráfica de Zipkin. 

Como se puede apreciar en la captura, se indica el tiempo de ejecución de ejecución del método. Pero como no hemos configurado nada, vemos simplemente la URL de la invocación que hemos hecho. 

Si pulsamos en el botón show, podremos ver más detalle del span, las etiquetas asociadas y la traza asociada a la misma. 

La información que vemos es un poco escueta, porque no hemos realizado ningún tipo de configuración ni mapeo de los servicios. A continuación veremos como podemos personalizar la medición de las invocaciones a los métodos. 

En el fichero application.properties podemos indicar dos tipos de configuración. Son incompatibles, si se marca el mapeo individual, los servicios que nos se encuentren mapeados no se enviarán a zipkin. 

• camel.zipkin.service-name: Nos permite indicar un nombre para el mapeo de todos los servicios de la aplicación y que no se muestre únicamente la URL. 
• camel.zipkin.server-service-mappings.{serviceId}: Nos permite indicar un mapeo específico a un servicio concreto. Este servicio se puede identificar por el routeId del mismo en Camel. 

Si indicamos la siguiente configuración, tendremos la salida que mostramos más abajo. 

camel.zipkin.server-service-mappings.mockClientGetAll=getAll
camel.zipkin.server-service-mappings.mockGetById=getById

Como veis, ha sido realmente sencillo comunicar nuestros servicios de Apache Camel con una plataforma tan útil como Zipkin e instrumentalizar y monitorizar el funcionamiento de vuestros micro-servicios. 

Como siempre todo el código podéis verlo aquí.