7. ID dei dati strutturati
Questo documento definisce tre SD-ID: timeQuality, origin e meta. Altri documenti possono definire ulteriori SD-ID.
7.1. timeQuality
L'SD-ID "timeQuality" PUÒ essere usato dall'originator per descrivere la propria nozione dell'ora di sistema. DOVREBBE essere scritto se l'originator non è correttamente sincronizzato con una fonte temporale esterna affidabile o se non sa se l'offset del proprio fuso orario sia corretto. Indica al collector o al relay che il TIMESTAMP potrebbe non essere corretto.
I parametri di questo SD-ID sono:
7.1.1. tzKnown
Il parametro "tzKnown" PUÒ indicare se l'originator conosce il proprio fuso orario. È un PARAM-VALUE costituito da un singolo carattere: "0" se l'informazione sul fuso è sconosciuta oppure "1" se è conosciuta. Se non è presente o vale "0", l'originator non conosce il proprio fuso. Se vale "1", la nozione dell'originator del proprio offset di fuso è contenuta nel TIMESTAMP.
7.1.2. isSynced
Il parametro "isSynced" PUÒ indicare se l'orologio locale dell'originator è sincronizzato con una fonte temporale affidabile, ad esempio tramite Network Time Protocol [RFC5905]. È un PARAM-VALUE formato da "0" se non sincronizzato o "1" se sincronizzato. Se non è presente, l'originator non sa se il proprio orologio locale sia sincronizzato.
7.1.3. syncAccuracy
Il parametro "syncAccuracy" PUÒ indicare la precisione della nozione dell'originator dell'ora di sistema. È un PARAM-VALUE contenente un intero che descrive, in microsecondi, l'offset massimo dalla fonte temporale autorevole. Il valore "60000000" indica una precisione di un minuto, mentre "2000" indica 2 millisecondi. Il numero rappresenta l'errore massimo atteso e può derivare dalla conoscenza della frequenza di sincronizzazione dell'orologio. È FACOLTATIVO.
Se il parametro non è presente, la deviazione massima dalla fonte temporale autorevole è sconosciuta.
7.1.4. Esempi
Esempio 1
[timeQuality tzKnown="1" isSynced="1" syncAccuracy="60000"]
Questo STRUCTURED-DATA mostra che l'originator è sincronizzato con una fonte temporale autorevole. L'originator ritiene che l'informazione temporale fornita sia precisa entro 60 millisecondi e conosce il proprio fuso orario.
Esempio 2
[timeQuality tzKnown="1" isSynced="0"]
Questo STRUCTURED-DATA mostra che l'originator non è sincronizzato con una fonte temporale autorevole, ma conosce il proprio offset di fuso orario.
Esempio 3
[timeQuality tzKnown="0" isSynced="1" syncAccuracy="60000"]
Questo STRUCTURED-DATA mostra che l'originator è sincronizzato con una fonte temporale autorevole, ma non conosce il proprio offset di fuso orario.
7.2. origin
L'SD-ID "origin" PUÒ essere usato da un originator, relay o collector per indicare la propria identità e i confini dell'enclave. È concepito per essere concatenato, in modo che ciascun relay o collector che lo aggiunge possa appendere le proprie informazioni a quelle già esistenti.
I parametri di questo SD-ID sono:
7.2.1. ip
Il parametro "ip" PUÒ identificare il dispositivo che ha originato il messaggio. Il valore è un indirizzo IP valido nel formato descritto nella sezione 6.2.4. Non DOVREBBERO essere inviati indirizzi anonimizzati, poiché non forniscono informazioni utili per la risoluzione dei problemi e possono creare conflitti con altri dispositivi anonimizzati in modo simile. Se è necessaria l'anonimizzazione, il messaggio dovrebbe invece essere anonimizzato presso un relay o un collector.
7.2.2. enterpriseId
Il parametro "enterpriseId" DEVE essere un "SMI Network Management Private Enterprise Code" gestito dall'IANA, con prefisso iso.org.dod.internet.private.enterprise (1.3.6.1.4.1). Il numero successivo DEVE essere univoco e DEVE essere registrato presso l'IANA secondo [RFC5226]. La presenza del parametro identifica il tipo di originator; gli originator DOVREBBERO includerlo.
Un relay DOVREBBE includerlo se altera significativamente il significato del messaggio. In particolare, i relay che trasformano messaggi da un protocollo non syslog in syslog DOVREBBERO includerlo.
Chi legge un messaggio che contiene questo parametro può consultare presso l'IANA le informazioni di registrazione degli "SMI Network Management Private Enterprise Codes" per individuare l'organizzazione che ha creato il generatore del messaggio.
7.2.3. software
Il parametro "software" identifica il prodotto software che ha generato il messaggio. DOVREBBE contenere il nome del prodotto, ma PUÒ contenere altre informazioni. Un relay NON DOVREBBE modificare questo parametro.
7.2.4. swVersion
Il parametro "swVersion" identifica la versione del prodotto software che ha generato il messaggio. Un relay NON DOVREBBE modificare questo parametro.
7.2.5. Example
[origin ip="192.0.2.1" enterpriseId="32473" software="su" swVersion="1.2.3"]
In questo esempio, il prodotto software che ha generato il messaggio è identificato come "su", versione "1.2.3", con il numero di impresa privata 32473. Il dispositivo che ha originato il messaggio ha l'indirizzo IP 192.0.2.1.
7.3. meta
L'SD-ID "meta" PUÒ fornire metainformazioni sul messaggio. Può essere usato per vari scopi, ad esempio informazioni sulla qualità del servizio, oppure quando è desiderabile classificare o arricchire il messaggio.
I parametri di questo SD-ID sono:
7.3.1. sequenceId
Il parametro "sequenceId" DOVREBBE fornire un numero di sequenza univoco per identificare un messaggio. Può essere usato per rilevare messaggi persi o garantire l'ordinamento. L'ID di sequenza DOVREBBE aumentare monotonicamente; l'algoritmo esatto dipende dall'implementazione. Questo PARAM-VALUE DOVREBBE essere uno o più interi decimali e PUÒ tornare al valore iniziale se un mittente viene riavviato.
7.3.2. sysUpTime
Il parametro "sysUpTime" PUÒ fornire informazioni sul tempo di attività del sistema. Se il mittente viene riavviato, DOVREBBE essere reimpostato a zero. Può essere utile per associare sequenze di messaggi a specifiche esecuzioni del dispositivo. Il valore è un intero decimale che conta i secondi dall'avvio del sistema.
7.3.3. language
Il parametro "language" specifica la lingua usata nella parte MSG. Questo PARAM-VALUE DEVE essere un tag di lingua come definito da [RFC5646].
Se la lingua della MSG non è nota o non può essere identificata, questo parametro NON DOVREBBE essere usato.