ContacteEstàndard de Naming a EventHub
Navegació
| ⬅️ Criteris | ➡️ Consumer Groups |
|---|
Quan he de consultar aquest estàndard?
Consulta aquest document quan:
- defineixes noms de topics, schemas, clients o consumer groups,
- prepares una fitxa de sol·licitud,
- una sol·licitud ha estat retornada per errors de naming.
L’incompliment d’aquest estàndard implica denegació automàtica.
Estàndard de Naming a EventHub
Canigó – Estàndard obligatori
Aquesta pàgina defineix les regles obligatòries de nomenclatura per als recursos d’EventHub.
L’incompliment d’aquestes regles implica denegació automàtica de la sol·licitud.
1. Objectiu de l’estàndard
El naming correcte permet:
- Identificar clarament l’owner del recurs.
- Facilitar l’operació i el suport.
- Evitar col·lisions i ambigüitats.
- Mantenir la homogeneïtat de la plataforma.
2. Regles generals (apliquen a tots els recursos)
- ✅ Només lletres minúscules.
- ✅ Separador obligatori: guionet (-).
- ❌ Sense espais.
- ❌ Sense caràcters especials.
- ❌ Sense accents.
- ✅ Longitud màxima: 90 caràcters.
Exemples vàlids:
a2345-espaicentral-alta-clienta1020-notificacions-canvi-estat
Exemples no vàlids:
AltaClientea2345_espaicentrala2345-clientes@alta
3. Entorns
L’entorn s’indica només quan aplica:
- INT → sufix
-int - PRE → sufix
-pre - PRO → sense sufix
Exemples:
a2345-espaicentral-alta-client-inta2345-espaicentral-alta-client-prea2345-espaicentral-alta-client
4. Naming de Clients Kafka (aplicacions)
Els Clients Kafka identifiquen les aplicacions productores/consumidores.
Format obligatori
a-<codi-aplicació>-<descripció>
Regles:
- Prefix fix
a. - Codi d’aplicació obligatori.
- Descripció curta i representativa.
- Un client per aplicació i entorn.
Exemples:
a2345-espaicentrala1020-notificacions
❌ No permès:
- Reutilitzar clients entre aplicacions.
- Utilitzar un client genèric per a diversos projectes.
5. Naming de Topics
Els topics representen esdeveniments, no sistemes ni APIs.
Format recomanat
a-<codi-aplicació>-
Regles:
- El nom ha de descriure l’esdeveniment de negoci.
- No incloure:
- tipus de dada,
- productor/consumidor,
- tecnologia,
- versionat explícit.
Exemples correctes:
a2345-espaicentral-alta-clienta1020-notificacions-canvi-estat
Exemples incorrectes:
clientes_v1kafka-clientesa2345-espaicentral-topic-test
6. Naming de Consumer Groups
Els consumer groups:
- Han d’identificar clarament l’aplicació consumidora.
- Es validen conjuntament amb els permisos (ACLs).
Format recomanat: a-<codi-aplicació>-cg-<ús>
Exemple:
a2345-espaicentral-cg-backoffice
7. Validació i control
L’Oficina EventHub valida el naming en:
- Altes.
- Canvis.
- Revisions periòdiques.
❌ Naming incorrecte → sol·licitud rebutjada
❌ Reintents sense correcció → tancament de la sol·licitud
8. Errors habituals (evita’ls)
- Utilitzar majúscules o guions baixos.
- No indicar l’entorn en INT o PRE.
- Utilitzar noms genèrics (
test,events,data). - No reflectir l’owner real del recurs.
- Versionar en el nom del topic.