7. Structured Data IDs (構造化データ ID)
この文書は 3 つの SD-ID を定義します: timeQuality, origin, および meta。他の SD-ID は他の文書によって定義される可能性があります。
7.1. timeQuality
SD-ID "timeQuality" はオリジネーターがシステム時刻の概念を説明するために使用してもかまいません (MAY)。この SD-ID は, オリジネーターが信頼できる外部時刻ソースと適切に同期されていない場合, またはそのタイムゾーンオフセットが正しいかどうかわからない場合に書き込まれるべきです (SHOULD)。これは TIMESTAMP が正しくない可能性があることをコレクターまたはリレーに示します。
この SD-ID のパラメーターは:
7.1.1. tzKnown
"tzKnown" パラメーターはオリジネーターがそのタイムゾーンを知っているかどうかを示すために使用してもかまいません (MAY)。これはタイムゾーン情報が不明な場合は "0", 既知の場合は "1" のいずれかの単一文字を含む PARAM-VALUE です。このパラメーターが存在しないか "0" に設定されている場合, オリジネーターはそのタイムゾーンを知りません。"1" の場合, オリジネーターのタイムゾーンオフセットの概念は TIMESTAMP に含まれています。
7.1.2. isSynced
"isSynced" パラメーターはオリジネーターのローカルクロックが信頼できる時刻ソース (例: Network Time Protocol [RFC5905] 経由) と同期されているかどうかを示すために使用してもかまいません (MAY)。これは同期されていない場合は "0", 同期されている場合は "1" のいずれかの単一文字を含む PARAM-VALUE です。このパラメーターが存在しない場合, オリジネーターはそのローカルクロックが同期されているかどうかを知りません。
7.1.3. syncAccuracy
"syncAccuracy" パラメーターはオリジネーターのシステム時刻の概念の精度を示すために使用してもかまいません (MAY)。これは権威ある時刻ソースからの最大オフセットをマイクロ秒単位で記述する整数を含む PARAM-VALUE です。値 "60000000" は 1 分の精度を示し, "2000" は 2 ミリ秒を示します。この数値は予想される最大誤差を表します。これはクロックがどのくらいの頻度で同期されるかの知識から導出される可能性があります。これはオプションです (OPTIONAL)。
パラメーターが存在しない場合, 権威ある時刻ソースからの最大偏差は不明です。
7.1.4. Examples (例)
例 1
[timeQuality tzKnown="1" isSynced="1" syncAccuracy="60000"]
この STRUCTURED-DATA は, オリジネーターが権威ある時刻ソースと同期されていることを示しています。オリジネーターは提供する時刻情報が 60 ミリ秒以内で正確であると信じています。オリジネーターはそのタイムゾーンを知っています。
例 2
[timeQuality tzKnown="1" isSynced="0"]
この STRUCTURED-DATA は, オリジネーターが権威ある時刻ソースと同期されていないことを示しています。ただし, そのタイムゾーンオフセットは知っています。
例 3
[timeQuality tzKnown="0" isSynced="1" syncAccuracy="60000"]
この STRUCTURED-DATA は, オリジネーターが権威ある時刻ソースと同期されているが, そのタイムゾーンオフセットを知らないことを示しています。
7.2. origin
SD-ID "origin" はオリジネーター, リレー, またはコレクターがその識別とエンクレーブ境界を示すために使用してもかまいません (MAY)。この SD-ID は連鎖されることを意図しているため, それを追加する各リレーまたはコレクターはすでに存在するものにその情報を追加できます。
この SD-ID のパラメーターは:
7.2.1. ip
"ip" パラメーターはメッセージを生成したデバイスを識別するために使用してもかまいません (MAY)。値はセクション 6.2.4 で説明されている形式の有効な IP アドレスです。匿名化されたアドレスは有用なトラブルシューティング情報を提供しないため, 送信すべきではありません (SHOULD NOT)。そうすることは同様に匿名化された他のデバイスとの競合を引き起こす可能性もあります。匿名化が必要な場合, メッセージは代わりにリレーまたはコレクターで匿名化されるべきです。
7.2.2. enterpriseId
"enterpriseId" パラメーターは "SMI Network Management Private Enterprise Code" でなければならず (MUST), これは IANA によって維持され, そのプレフィックスは iso.org.dod.internet.private.enterprise (1.3.6.1.4.1) です。後に続く番号は一意でなければならず (MUST), [RFC5226] に従って IANA に登録されなければなりません (MUST)。このパラメーターの存在はオリジネーターのタイプを識別するのに役立ちます。オリジネーターはこのパラメーターを含めるべきです (SHOULD)。
リレーはメッセージの意味を大幅に変更する場合, このパラメーターを含めるべきです (SHOULD)。特に, 非 syslog プロトコルからのメッセージを syslog に変換するリレーはこのパラメーターを含めるべきです (SHOULD)。
このパラメーターが存在するメッセージを読むとき, 人間のユーザーは IANA の "SMI Network Management Private Enterprise Codes" の登録情報を参照することにより, メッセージジェネレーターを作成した組織を調べることができます。
7.2.3. software
"software" パラメーターはメッセージを生成したソフトウェア製品を識別するために使用されます。これは製品名を含むべきですが (SHOULD), 他の情報を含んでもかまいません (MAY)。リレーはこのパラメーターを変更すべきではありません (SHOULD NOT)。
7.2.4. swVersion
"swVersion" パラメーターはメッセージを生成したソフトウェア製品のバージョンを識別するために使用されます。リレーはこのパラメーターを変更すべきではありません (SHOULD NOT)。
7.2.5. Example (例)
[origin ip="192.0.2.1" enterpriseId="32473" software="su" swVersion="1.2.3"]
この例では, メッセージを生成したソフトウェア製品は "su", バージョン "1.2.3" として識別され, プライベートエンタープライズ番号は 32473 です。メッセージを生成したデバイスは IP アドレス 192.0.2.1 を持ちます。
7.3. meta
SD-ID "meta" はメッセージに関するメタ情報を提供するために使用してもかまいません (MAY)。これは QoS 情報など様々な目的に使用される可能性があり, またはメッセージを分類または強化することが望ましい他のケースでも使用されます。
この SD-ID のパラメーターは:
7.3.1. sequenceId
"sequenceId" パラメーターはメッセージを識別するための一意のシーケンス番号を提供するために使用すべきです (SHOULD)。このシーケンス番号は失われたメッセージを検出するため, または順序を保証するために使用できます。シーケンス ID は単調増加すべきです (SHOULD)。これの正確なアルゴリズムは実装固有です。この PARAM-VALUE は 1 つ以上の 10 進整数であるべきです (SHOULD)。送信者が再起動する場合, 最初から折り返しまたはやり直してもかまいません (MAY)。
7.3.2. sysUpTime
"sysUpTime" パラメーターはシステムがどのくらいの期間稼働しているかに関する情報を提供するために使用してもかまいません (MAY)。送信者が再起動する場合, これはゼロにリセットされるべきです (SHOULD)。これは特定のデバイス実行とメッセージのシーケンスを関連付けるのに有用である可能性があります。このパラメーターの値はシステム起動からの秒数を数える 10 進整数です。
7.3.3. language
"language" パラメーターは MSG 部分で使用される言語を指定するために使用されます。この PARAM-VALUE は [RFC5646] で定義されている言語タグでなければなりません (MUST)。
MSG の言語が既知でないか識別できない場合, このパラメーターは使用すべきではありません (SHOULD NOT)。