ContacteÚs de Topics a EventHub
Navegació
| ⬅️ Plataforma Eventhub | ➡️ Ús d’Esquemes |
|---|
Ús de Topics a EventHub
Canigó – Guia per a aplicacions
Aquesta pàgina explica què ha de fer una aplicació per crear, modificar o retirar un topic a EventHub.
No descriu el govern en detall: indica els passos pràctics i els artefactes a utilitzar.
1. Quan necessites un topic?
Crea un topic si:
- Has de publicar un esdeveniment de negoci.
- L’esdeveniment pot ser consumit per una o més aplicacions.
- Necessites integració asíncrona i desacoblada.
❌ No creïs un topic per:
- Proves exploratòries en PRE o PRO.
- Ús tècnic intern d’una única aplicació.
- Esdeveniments ja existents a la plataforma.
2. Alta d’un topic: què has de fer
Pas 1. Omplir la plantilla de sol·licitud (obligatori)
- Plantilla oficial: Plantillas_Solicitud_EventHub
- Primer, omplir la pestanya Datos_Proyecto (les dades comunes es propaguen automàticament).
- Després, una fila per topic a la pestanya Solicitud_Topic.
Camps que ha d’omplir l’aplicació:
| Camp | Descripció |
|---|---|
| Entorno | INT / PRE / PRO |
| Caso_Uso | Descripció funcional de l’esdeveniment |
| Dominio | Àrea funcional (CRM, Facturació…) — informatiu, no forma part del nom |
| Descripcion_Topic | Nom curt de l’esdeveniment (amb guions, sense espais) |
| Criticidad | Alta / Media / Baja |
| Volumen_MBs | Throughput mitjà en MB/s |
| Pico_MBs | Throughput pic en MB/s |
| Cuando_Pico | Quan es produeix el pic (text lliure) |
| Tamano_Medio_Msg_Bytes | Mida mitjana del value del missatge |
| Tamano_Medio_Key_Bytes | Mida mitjana del key del missatge |
| Requiere_Schema | SI / NO |
| Schema_Asociado | Nom del schema (si aplica) |
| Requiere_DLQ | SI / NO |
| Consumidores_Conocidos | Sistemes que consumiran aquest topic |
Camps automàtics (no modificar):
| Camp | Origen |
|---|---|
| Codigo_Aplicacion, Nombre_Aplicacion, JIRA_ID, Owner_Funcional, Owner_Tecnico | Heredats de Datos_Proyecto |
| Nombre_Topic_Generado | Fórmula: {codigo}-{descripcion}[-entorn] (sense sufix en PRO) |
Camps amb valors per defecte governats (no modificar excepte excepció justificada):
| Camp | Valor estàndard |
|---|---|
| Retention_Dias | 7 |
| Cleanup_Policy | delete |
| Compression_Type | producer |
| Max_Message_Bytes | 1048576 (1 MB) |
| Schema_Validation | No |
Si necessites un valor diferent, omplir Justificacion_Excepcion.
Sense la fitxa correctament omplerta no es valida la sol·licitud.
Pas 2. Obrir la sol·licitud
- Crear un tiquet JIRA ACOEVENT.
- Adjuntar la fitxa omplerta.
Pas 3. Validació
L’Oficina EventHub valida:
- Naming del topic (generat automàticament).
- Volumetria i dimensionament.
- Justificació d’excepcions (si n’hi ha).
- Coherència amb consumidors i schemas declarats.
Resultat:
- ✅ Aprovat → el topic es crea amb els paràmetres assignats per l’Oficina.
- 🔄 Retornat → cal corregir la fitxa.
Pas 4. Creació del topic
- INT / PRE: autoservei controlat o execució per l’Oficina EventHub.
- PRO: execució per Operacions mitjançant CRQ quan apliqui.
3. Què decideix la plataforma (no l’aplicació)
La plataforma defineix:
- Particions: 3 (PRO), 2 (PRE), 1 (INT) — assignades per l’Oficina.
- Replication Factor: 3 — fix.
- Min In-Sync Replicas: 2 — fix.
- Configuració tècnica final del topic.
- Si és necessària CRQ en PRE o PRO.
4. Convencions de naming
El nom del topic es genera automàticament a la plantilla:
| Entorn | Format | Exemple |
|---|---|---|
| INT | {codigo}-{descripcion}-int |
a1234-alta-client-int |
| PRE | {codigo}-{descripcion}-pre |
a1234-alta-client-pre |
| PRO | {codigo}-{descripcion} |
a1234-alta-client |
Regles:
- Només lletres minúscules i guions (-).
- Sense espais, accents ni caràcters especials.
- Màxim 90 caràcters.
- El dominio no forma part del nom (és un camp informatiu separat).
5. Canvis sobre un topic
Es consideren canvis:
- Modificar particions.
- Canviar la retenció.
- Canviar permisos.
Què cal fer:
- Actualitzar la fitxa.
- Obrir tiquet JIRA ACOEVENT.
- Tramitar CRQ si aplica (obligatòria en PRO).
6. Deprecació i baixa
Deprecació
- S’utilitza quan el topic serà substituït.
- L’Oficina EventHub coordina la comunicació amb els consumidors.
Baixa
- Confirmació formal de no ús.
- Anàlisi d’impacte.
- CRQ en PRO quan apliqui.
- Eliminació controlada del topic.
7. Errors habituals (evita’ls)
- Crear topics “per si de cas”.
- Sobre‑particionar sense volum real.
- Retencions llargues sense justificar.
- Topics sense owner.
- Duplicar esdeveniments ja existents.
- Utilitzar punts o guions baixos al nom del topic.
8. Documentació de referència
I ara què?
Data d'actualització:
01-01-0001