この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/resource/browser/
翻訳元: open-telemetry/semantic-conventions v1.44.0(コミット e10a930)
Browser
Status:
type: browser
Description: そのリソースが表すアプリケーションが実行されているWebブラウザー。browser.*属性は、(モバイルデバイスかデスクトップデバイスかにかかわらず)Webブラウザー内で実行されているアプリケーションを表すリソースにのみ使用しなければなりません(MUST)。
[!warning] このEntity定義には、roleを持たない属性が含まれています。 安定版のEntityは、roleが定義されていない属性を持ってはなりません(MUST NOT)。
Attributes:
| Role | Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|---|
| Other | browser.brands | Recommended | string[] | ブランド名とバージョンをスペースで区切った配列。[1] | [" Not A;Brand 99", "Chromium 99", "Chrome 99"] | |
| Other | browser.language | Recommended | string | ブラウザーを使用しているユーザーの優先言語。[2] | en; en-US; fr; fr-FR | |
| Other | browser.mobile | Recommended | boolean | ブラウザーがモバイルデバイス上で動作している場合にtrueとなるブール値。[3] | ||
| Other | browser.platform | Recommended | string | ブラウザーが動作しているプラットフォーム。[4] | Windows; macOS; Android | |
| Other | user_agent.original | Recommended | string | ブラウザーが提供する完全なUser-Agent文字列。[5] | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36 |
[1] browser.brands: この値は、UA client hints API(navigator.userAgentData.brands)から取得することを想定しています。
[2] browser.language: この値は、Navigator APIのnavigator.languageから取得することを想定しています。
[3] browser.mobile: この値は、UA client hints API(navigator.userAgentData.mobile)から取得することを想定しています。利用できない場合、この属性は未設定のままにすべきです(SHOULD)。
[4] browser.platform: この値は、UA client hints API(navigator.userAgentData.platform)から取得することを想定しています。利用できない場合、代わりにレガシーなnavigator.platform APIを使用すべきではなく(SHOULD NOT)、値の一貫性を保つためにこの属性は未設定のままにすべきです(SHOULD)。
取りうる値の一覧は、W3C User-Agent Client Hints仕様書で定義されています。これらの値の一部(すべてではありません)は、os.typeとos.name属性の値と重複することがある点に注意してください。しかし一貫性のため、browser.platform属性の値は、ユーザーエージェントが提供する値を正確に取得すべきです。
[5] user_agent.original: この値を取得するには、レガシーなnavigator.userAgent APIを使用できます。
これらの属性はすべて、ユーザーエージェント自身がHTTPヘッダー(Sec-CH-UA、Sec-CH-Platform、User-Agentなど)の形式で提供できます。しかし、これらのヘッダーはプロキシサーバーによって取り除かれる可能性があり、個々のクライアントからの呼び出しに結び付いています。Collectorのようなサービスを通じたバッチ処理をサポートし、(プロキシサーバーがヘッダーを取り除くことなどによる)データの損失を防ぐため、可能な場合はこれらの属性を使用すべきです。
type: browser.document
Status:
type: browser.document
Description: ブラウザーに読み込まれたWebページのドキュメント。
Attributes:
| Role | Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|---|
| Identity | browser.document.url.full | Recommended | string | RFC3986に基づく、現在のブラウザードキュメントの絶対URL。 | https://www.example.com/search?q=OpenTelemetry#SemConv |