OTEP-0091: ログ：語彙

このドキュメントは、OpenTelemetryプロジェクト全体で使用されるログの語彙を定義します。

動機

バベルの塔の建設者たちが経験した混乱を避けるために、私たちは共通言語と、私たちが使用する用語についての共通理解が必要です。

提案

OpenTelemetryの仕様には、トレース、メトリクス、その他の関連する概念についての語彙がすでに含まれています。

この提案は、以下の概念を語彙に追加するものです。

Log Record

イベントの記録です。 通常、この記録には、イベントが発生したときを示すタイムスタンプと、何が起きたか、どこで起きたかなどを説明するその他のデータが含まれます。

Log Entryとも呼ばれます。

Log

Log Record の集合を指すために使われることがあります。 人々は Log を単一の Log Record を指すために使うこともあるため、曖昧になる可能性があります。 したがって、この用語は慎重に使用すべきであり、曖昧さが生じうる文脈では、追加の修飾語（たとえば Log Record ）を使用すべきです。

Embedded Log

Span オブジェクトの中の、Events リストに埋め込まれた Log Record です。

Standalone Log

Span に埋め込まれておらず、別の場所に記録される Log Record です。

Log Attributes

Log Record に含まれるキーと値のペアです。

Structured Logs

Log Record の異なる要素（たとえばタイムスタンプ、属性など）を区別できる、明確に定義された構造を持つ形式で記録されるログです。 たとえば、Syslogプロトコル（RFC 5425）は structured-data 形式を定義しています。

Flat File Logs

テキストファイルに、多くの場合1つのログレコードにつき1行の形式で（複数行にわたるレコードも可能ですが）記録されるログです。 より構造化された形式（たとえばJSONファイル）でテキストファイルに書き込まれたログがFlat File Logsとみなされるかどうかについては、業界内で共通の合意はありません。 この区別が重要な場合は、明示的にそのことを言及することが推奨されます。