Topicos
Recomendaciones para el nombrado de topics segun recomendaciones generales y buenas practicas.
Los nombres de los topicos deben estar completamente en minúsculas y seguir la siguiente expresión regular: [a-z0-9.-]. Todos los temas deben seguir kebab-base, como my-awesome-topic-name.
La legibilidad y la facilidad de comprensión son muy importante en la denominación adecuada de los topicos. Los nombres de los topicos en minúsculas son fáciles de leer y kebab-case ayuda a separar las palabras; evitamos el uso de guiones bajos debido a que los mismos son usados por las metricas. Además, los puntos constituyen un gran separador entre secciones en el nombre de un topico, que se describe a continuación.
Naming Structure¶
Seguir la siguiente recomendacion.
<domain>.<classification>.<description>
Domain¶
Un dominio para los datos es un nombre permanente y bien entendido para el área del sistema con la que se relacionan los datos. Estos no deben incluir nombres de productos, nombres de equipos o nombres de servicios.
Algunos ejemplos que ya estamos utilizando:
- envios: Eventos relacionados a envios.
- pedidos: Eventos relacionados a pedidos.
Classification¶
La clasificación de datos dentro de un tema de Kafka le dice al usuario final cómo debe interpretarse o usarse. Esto no debería informarnos sobre el formato o el contenido de los datos.
Ejemplos:
- traza: Eventos relacionados a la traza del envio.
- info: Eventos relacionados con informacion del envio.
Description¶
La descripción es posiblemente la parte más importante del nombre y es el nombre del evento que describe el tipo de datos que contiene el tema. Este es el tema de los datos.
Ejemplos:
- Visita
- Envio Entregado
Ejemplos¶
Ejemplos usando la siguiente nomenclatura:
envios.traza.visitaenvios.traza.envio-entregado