7. Structured Data IDs (ID di dati strutturati)
Questa sezione definisce un elenco di SD-ID insieme ai loro PARAM-NAME e alla semantica associata. SD-ID aggiuntivi POSSONO essere definiti in conformità con la Sezione 6.3. Per evitare collisioni, l'IANA è responsabile della registrazione degli SD-ID. La Sezione 9.1 tratta i dettagli della registrazione degli SD-ID definiti qui.
Gli SD-ID di questa sezione POSSONO servire come modello per i fornitori per definire i propri elementi di dati strutturati secondo lo schema della Sezione 6.3.2.
7.1. timeQuality (Qualità del tempo)
L'SD-ID "timeQuality" PUÒ essere utilizzato per descrivere la qualità del TIMESTAMP contenuto nel messaggio. Questo è utile per gli analizzatori di log che cercano di determinare un tempo accurato da sorgenti che non hanno accesso a una sorgente temporale affidabile. Le informazioni forniscono anche un modo per correlare la precisione dei timestamp sugli analizzatori di log.
Quando un'applicazione syslog non ha un tempo accurato, DOVREBBE fornire le informazioni qualificanti in un SD-ELEMENT timeQuality.
I seguenti PARAM-NAME opzionali sono definiti. Possono esserci zero, uno o più di questi parametri in un SD-ELEMENT timeQuality.
-
"tzKnown" - Un singolo carattere - '0' o '1'. Se impostato su '1', l'originator indica di avere informazioni accurate sul fuso orario per il TIMESTAMP dato. Se impostato su '0', indica che non è sicuro del fuso orario. Se questo PARAM-NAME è assente, queste informazioni non possono essere determinate.
-
"isSynced" - Un singolo carattere - '0' o '1'. Se impostato su '1', l'originator indica che il suo tempo di sistema è sincronizzato con una sorgente temporale esterna affidabile, ad esempio tramite NTP, GPS o meccanismi simili. Se impostato su '0', indica che non è sincronizzato con tale sorgente. Se questo PARAM-NAME è assente, queste informazioni non possono essere determinate. Un originator il cui tempo di sistema non è sincronizzato tramite una sorgente temporale esterna affidabile dovrebbe essere considerato non sincronizzato. Si prega di notare che anche se un originator indica che il suo orologio è sincronizzato, un relay che inoltra questo messaggio potrebbe aver modificato il TIMESTAMP, il che potrebbe far sì che il TIMESTAMP non sia più sincronizzato.
-
"syncAccuracy" - La precisione del tempo di sistema sincronizzato con una sorgente temporale esterna affidabile in millisecondi, rappresentata come valore intero decimale. Questo è un numero positivo. Il valore "0" (zero) indica che il tempo di sistema è accurato a meno di 1 millisecondo. Il valore "60000" indica che il tempo di sistema è accurato a circa un minuto rispetto alla sorgente temporale esterna affidabile. Se questo PARAM-NAME è assente, il syncAccuracy non può essere determinato. Se il parametro isSynced è impostato su '0', un valore syncAccuracy, se presente, dovrebbe essere ignorato.
7.2. origin (Origine)
L'SD-ID "origin" PUÒ essere utilizzato per fornire informazioni specifiche del sistema sull'origine del messaggio. Questo può essere utilizzato per elaborare meglio i messaggi da diverse origini. È utile per gli sviluppatori che sviluppano analizzatori di log o altre applicazioni speciali. L'SD-ID "origin" può anche essere utilizzato come modello per altri dati strutturati.
I seguenti PARAM-NAME opzionali sono definiti. Possono esserci zero, uno o più di questi parametri in un SD-ELEMENT "origin".
-
"ip" - L'indirizzo IPv4 o IPv6 associato alla generazione del messaggio.
-
"enterpriseId" - Il numero di impresa privata assegnato come intero decimale. Vedere Sezione 7.2.2.
-
"software" - Il nome del software e la versione dell'originator, relay o collector che ha generato il messaggio. Questa può essere qualsiasi stringa USASCII stampabile.
-
"swVersion" - Se il parametro software identifica un rilascio software versionato, l'originator PUÒ utilizzare inoltre questo parametro per indicare la versione del software.
7.2.1. Example (Esempio)
In questo esempio, è presente solo il parametro enterpriseId:
[origin enterpriseId="32473"]
7.2.2. Metodo di assegnazione per i numeri di impresa privata
I numeri di impresa privata sono assegnati dall'IANA come descritto su
http://www.iana.org/. Per i messaggi syslog, i numeri di impresa
privata vengono utilizzati come definito in SMI Network Management Private
Enterprise Codes [ENTERPRISE-NUMBERS].
7.3. meta (Meta)
L'SD-ID "meta" PUÒ essere utilizzato per trasportare meta-informazioni sul messaggio. È utile per i relay che ricevono messaggi e vogliono aggiungere ulteriori meta-informazioni sul messaggio. Queste meta-informazioni possono essere utilizzate dal collector o da un relay a valle.
I seguenti PARAM-NAME opzionali sono definiti. Possono esserci zero, uno o più di questi parametri in un SD-ELEMENT "meta".
-
"sequenceId" - Un intero univoco che identifica un ID di sequenza ascendente per il messaggio. Il valore DEVE essere incrementato per ogni originator. Il sequenceId PUÒ essere incrementato di più di uno. Questo può essere utilizzato per rilevare messaggi persi. Se viene fornito un sequenceId, dovrebbe essere incluso in tutti i messaggi prodotti dall'originator.
-
"sysUpTime" - Il valore dell'uptime del sistema dell'originator dall'ultimo riavvio del sistema. I valori sono in centesimi di secondo. Il valore DEVE essere un intero positivo. sequenceId e sysUpTime possono essere utilizzati insieme per rilevare se l'originator è stato riavviato.
-
"language" - Il tag della lingua naturale del messaggio. I valori sono i Language Tag definiti da [RFC5646].