Zum Hauptinhalt springen

7. Structured Data IDs (Strukturierte Daten-IDs)

Dieser Abschnitt definiert eine Liste von SD-IDs zusammen mit ihren PARAM-NAMEs und zugehöriger Semantik. Weitere SD-IDs KÖNNEN gemäß Abschnitt 6.3 definiert werden. Um Kollisionen zu vermeiden, ist die IANA für die Registrierung von SD-IDs verantwortlich. Abschnitt 9.1 behandelt die Details der Registrierung der hier definierten SD-IDs.

SD-IDs aus diesem Abschnitt DÜRFEN Herstellern als Vorlage dienen, um ihre eigenen strukturierten Datenelemente nach dem Schema in Abschnitt 6.3.2 zu definieren.

7.1. timeQuality (Zeitqualität)​

Die "timeQuality" SD-ID MAY (KANN) verwendet werden, um die Qualität des in der Nachricht enthaltenen TIMESTAMP zu beschreiben. Dies ist nützlich für Log-Analyzer, die versuchen, eine genaue Zeit von Quellen zu ermitteln, die keinen Zugriff auf eine zuverlässige Zeitquelle haben. Die Informationen liefern auch eine Möglichkeit, die Genauigkeit von Zeitstempeln auf Log-Analyzern zu korrelieren.

Wenn eine syslog-Anwendung keine genaue Zeit hat, SOLLTE sie die qualifizierende Information in einem timeQuality SD-ELEMENT bereitstellen.

Die folgenden optionalen PARAM-NAMEs sind definiert. Es kann null, einen oder mehrere dieser Parameter in einem timeQuality SD-ELEMENT geben.

  • "tzKnown" - Ein einzelnes Zeichen - entweder '0' oder '1'. Wenn auf '1' gesetzt, zeigt der Originator an, dass er über genaue Informationen über die Zeitzone für das angegebene TIMESTAMP verfügt. Wenn auf '0' gesetzt, zeigt er an, dass er sich der Zeitzone nicht sicher ist. Wenn dieser PARAM-NAME fehlt, kann diese Information nicht bestimmt werden.

  • "isSynced" - Ein einzelnes Zeichen - entweder '0' oder '1'. Wenn auf '1' gesetzt, zeigt der Originator an, dass seine Systemzeit mit einer zuverlässigen externen Zeitquelle synchronisiert ist, z.B. über NTP, GPS oder ähnliche Mechanismen. Wenn auf '0' gesetzt, zeigt er an, dass er nicht mit einer solchen Quelle synchronisiert ist. Wenn dieser PARAM-NAME fehlt, kann diese Information nicht bestimmt werden. Ein Originator, dessen Systemzeit nicht über eine zuverlässige externe Zeitquelle synchronisiert ist, sollte als nicht synchronisiert betrachtet werden. Bitte beachten Sie, dass selbst wenn ein Originator zeigt, dass seine Uhr synchronisiert ist, ein Relay, der diese Nachricht weiterleitet, möglicherweise den TIMESTAMP geändert haben könnte, was dazu führen könnte, dass der TIMESTAMP nicht mehr synchronisiert ist.

  • "syncAccuracy" - Die Genauigkeit der mit einer zuverlässigen externen Zeitquelle synchronisierten Systemzeit in Millisekunden, wie ein dezimaler Integer-Wert dargestellt. Dies ist eine positive Zahl. Der Wert "0" (Null) zeigt an, dass die Systemzeit auf weniger als 1 Millisekunden genau ist. Der Wert "60000" zeigt an, dass die Systemzeit auf etwa eine Minute innerhalb der zuverlässigen externen Zeitquelle genau ist. Wenn dieser PARAM-NAME fehlt, kann die syncAccuracy nicht bestimmt werden. Wenn der isSynced-Parameter auf '0' gesetzt ist, sollte ein syncAccuracy-Wert, falls vorhanden, ignoriert werden.

7.2. origin (Ursprung)​

Die "origin" SD-ID MAY (KANN) verwendet werden, um systemspezifische Informationen über den Ursprung der Nachricht bereitzustellen. Dies kann genutzt werden, um Nachrichten aus verschiedenen Ursprüngen besser zu verarbeiten. Es ist nützlich für Entwickler, die Log-Analyser oder andere spezielle Anwendungen entwickeln. Die "origin" SD-ID kann ebenfalls als Vorlage für andere strukturierte Daten genutzt werden.

Die folgenden optionalen PARAM-NAMEs sind definiert. Es kann null, einen oder mehrere dieser Parameter in einem "origin" SD-ELEMENT geben.

  • "ip" - Die IPv4- oder IPv6-Adresse, die mit der Generierung der Nachricht verbunden ist.

  • "enterpriseId" - Die zugewiesene private Unternehmensnummer als dezimale Integer-Zahl. Siehe Abschnitt 7.2.2.

  • "software" - Der Softwarename und die Version des Originators, Relays oder Collectors, der die Nachricht generiert hat. Dies kann eine beliebige druckbare USASCII-Zeichenkette sein.

  • "swVersion" - Wenn der Software-Parameter eine versionierte Software-Release identifiziert, KANN der Originator zusätzlich diesen Parameter verwenden, um die Softwareversion anzugeben.

7.2.1. Example (Beispiel)​

In diesem Beispiel ist nur der enterpriseId-Parameter vorhanden:

[origin enterpriseId="32473"]

7.2.2. Zuweisungsmethode für Private Enterprise Numbers​

Private Enterprise Numbers werden von der IANA wie unter http://www.iana.org/ beschrieben zugewiesen. Für syslog-Nachrichten werden die privaten Unternehmensnummern wie unter SMI Network Management Private Enterprise Codes definiert verwendet [ENTERPRISE-NUMBERS].

7.3. meta (Meta)​

Die "meta" SD-ID MAY (KANN) verwendet werden, um Meta-Informationen über die Nachricht zu transportieren. Es ist nützlich für Relays, die Nachrichten empfangen und zusätzliche Meta-Informationen über die Nachricht hinzufügen möchten. Diese Meta-Informationen können vom Collector oder einem nachgeschalteten Relay genutzt werden.

Die folgenden optionalen PARAM-NAMEs sind definiert. Es kann null, einen oder mehrere dieser Parameter in einem "meta" SD-ELEMENT geben.

  • "sequenceId" - Eine eindeutige Ganzzahl, die eine aufsteigende Sequenz-ID für die Nachricht identifiziert. Der Wert MUSS für jeden Originator erhöht werden. Die sequenceId MAY (KANN) um mehr als eins erhöht werden. Dies kann verwendet werden, um verlorene Nachrichten zu erkennen. Wenn eine sequenceId bereitgestellt wird, sollte sie in allen Nachrichten enthalten sein, die vom Originator erzeugt werden.

  • "sysUpTime" - Der Wert der System-Uptime des Originators, seit das System zuletzt neu gestartet wurde. Die Werte sind in Hundertstelsekunden. Der Wert MUSS eine positive Ganzzahl sein. sequenceId und sysUpTime können zusammen verwendet werden, um zu erkennen, ob der Originator neu gestartet wurde.

  • "language" - Der natürlichsprachliche Tag der Nachricht. Die Werte sind die aus [RFC5646] definierten Language Tags.

Letztes Update am