Skip to content

ログ設計ガイドライン:トレースIDを添加する際、trace_idとすべき背景の出典を追加する #272

@arukiidou

Description

@arukiidou

https://future-architect.github.io/arch-guidelines/documents/forLog/log_guidelines.html
の改善提案です。

【OTel Semantic Conventions とECS 比較】では、
(OTel Semantic Conventionsの)トレースID:traceId (トップレベル)
として紹介されているところ、

推奨するキー名称では唐突に
trace_id:OTel, ECS, New Relicに準拠とされており、
出典がないためになぜtraceId ではなくtrace_idにすべきなのかのロジックがわかりにくいと思いました。

実際の出典

下記の通り、non-OTLPのログフォーマットにおいてtrace_idが推奨されている情報源は、下記にあります。
下記の出典を追加するほうが良いのではないでしょうか。

Trace Context in non-OTLP Log Formats

“trace_id” for [TraceId](https://opentelemetry.io/docs/specs/otel/logs/data-model/#field-traceid), lowercase and hex-encoded.
“span_id” for [SpanId](https://opentelemetry.io/docs/specs/otel/logs/data-model/#field-spanid), lowercase and hex-encoded.
“trace_flags” for [trace flags](https://opentelemetry.io/docs/specs/otel/logs/data-model/#field-traceflags), formatted according to W3C traceflags format.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions