Skip to content

ログ：trace_id/span_idを推奨するキー名称にする出典を追記 #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ma91n merged 1 commit into from
Dec 24, 2025
Merged

ログ：trace_id/span_idを推奨するキー名称にする出典を追記 #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions documents/forLog/log_guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,8 @@ NewRelic、DataDogなども独自のキーがあるが、OTelのエクスポー
| | ロガーで自動付与 | service.name | システム内でサービスを識別する最も重要な属性 | "authentication-service" | OTel, ECS, DataDog, New Relic全てで中核 |
| | | service.version | リリースの追跡とリグレッション分析に不可欠 | "1.2.3" | OTel, ECS, DataDogで標準 |
| | | deployment.environment | 本番/ステージング環境のフィルタリングに必須 | "production" | OTel, DataDogで標準 |
| | 計装で自動付与 | trace_id | 分散トレースへの基本的なリンク | "a1b2c3d4e5f6..." | OTel, ECS, New Relicに準拠（DataDogはdd.trace_idにマッピング要） |
| | | span_id | トレース内の特定の操作へのリンク | "f1e2d3c4b5a6..." | OTel, ECS, New Relicに準拠（DataDogはdd.span_idにマッピング要） |
| | 計装で自動付与 | trace_id | 分散トレースへの基本的なリンク | "a1b2c3d4e5f6..." | OTel（[non-OTLP Log Formats](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)）, ECS, New Relicに準拠（DataDogはdd.trace_idにマッピング要） |
| | | span_id | トレース内の特定の操作へのリンク | "f1e2d3c4b5a6..." | OTel（[non-OTLP Log Formats](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)）, ECS, New Relicに準拠（DataDogはdd.span_idにマッピング要） |
| 拡張スキーマ | HTTP要求/応答 | http.request.method | HTTPメソッド | "GET" | OTelとECSのHTTP規約から規定 |
| | | http.response.status_code | HTTPステータスコード | 200 | |
| | | url.path | リクエストURL | "/users/123?query=abc" | OTelでは[url.path](https://opentelemetry.io/docs/specs/semconv/registry/attributes/url/#url-path) |
Expand All @@ -264,6 +264,8 @@ NewRelic、DataDogなども独自のキーがあるが、OTelのエクスポー

- RFC 8259で仕様が標準化されており、数値型や真偽値などのデータ型が利用できるため。幅広く利用されているため、CloudWatch LogsやBigQuery等の多くのサービスやツールでサポートされているため。
- Apache Combined FormatやLTSV（Labeled Tab-Separated Values）は信頼できる仕様が存在しない。
- OpenTelemetry Protocol(OTLP)のデータをJSON形式で表現したOTLP/JSONは採用しない。
- OTLP/JSONは深くネストされた複雑な構造を持っており、ログ分析性が下がるため。
Comment on lines +267 to +268
Copy link
Contributor Author

@MasatoYagi MasatoYagi Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non-OTLPであることを明記


## ローカル環境の場合

Expand Down
Loading