FAQ¶
接続後にデータがない¶
次の順序で確認すると、設定、サンプリング、ネットワークの問題を通常すばやく特定できます。
- SDK が初期化済みであることを確認する:初期化コードはビジネスイベントが発生する前に実行する必要があり、同じページでは
init()を 1 回だけ呼び出します。Browser SDK3.3.25以降のバージョンでは、onInitSuccessで準備完了を確認するか、onInitErrorのcodeに基づいて失敗原因を調べられます。リモート設定を有効にしている場合、fallbackはローカル設定で起動済みであることを示します。詳細は初期化結果を参照してください。 - 接続パラメータが完全であることを確認する:
applicationIdは必須です。パブリックネットワークの OpenWay ではsiteとclientTokenを使用し、DataKit に直接接続する場合はdatakitOriginを使用します。2 つの送信方式を混在させないでください。 - Session がサンプリング対象になっていることを確認する:初回の切り分けでは
sessionSampleRateを100に設定し、サンプリング対象外による誤判定を避けます。 - ブラウザの Console を確認する:次の初期化エラーに特に注意してください。
| エラーメッセージ | 対応方法 |
|---|---|
Application ID is not configured |
コンソールで生成された applicationId を設定する |
datakitOrigin or site is not configured |
現在の送信方式に対応するアドレスを設定する |
Allowed Tracing URLs should be an array |
allowedTracingUrls を配列に変更する |
- Network を確認する:
/v1/write/rumでフィルタリングします。リクエストがない場合は、初期化のタイミング、サンプリング、CSP を確認します。リクエストが失敗する場合は、アドレス、Token、CORS、プロキシ、DataKit への到達性を確認します。 - コンソールのフィルター条件を確認する:正しいアプリケーションが選択されていることを確認し、
service、env、version、時間範囲を確認します。
基本的なトラブルシューティング方法については、Web アプリケーションの接続 > 接続の検証 も参照してください。
allowedTracingUrls を設定した後に非同期リクエストがクロスオリジンになる¶
アプリケーションパフォーマンスモニタリング(APM)ツールを使用して、フロントエンドからバックエンドまでの完全な追跡(一般にリアルユーザーモニタリング(RUM)と呼ばれます)を実現するには、フロントエンドとバックエンドでそれぞれ設定を行う必要があります。主な手順と注意事項は次のとおりです。
フロントエンド設定¶
-
RUM SDK をインストールして設定する:
-
Web フロントエンドアプリケーションに、APM ツールが提供する RUM SDK をインストールします。
-
SDK を設定します。これには、
allowedTracingUrls(Trace Header の注入を許可するリクエスト URL のマッチリスト)とtraceType(分散型トレーシングのタイプ)の設定が含まれます。NPM + TypeScript で接続する場合はTraceType列挙型を使用します(例:TraceType.DDTRACE)。対応する実行時の値はddtraceです。 -
トレース情報を送信する:
- RUM SDK は
traceTypeに応じて対応するリクエストヘッダーを自動的に追加します。DDTrace の場合は、x-datadog-parent-id、x-datadog-origin、x-datadog-sampling-priority、x-datadog-trace-idなどが含まれます。
バックエンド設定¶
-
CORS ポリシーを設定する:
-
バックエンドサーバーで CORS(クロスオリジンリソース共有)ポリシーを設定し、フロントエンドのドメインからのリクエストを許可します。特に、必要なトレース情報ヘッダーをすべて含めるように
Access-Control-Allow-Headersを指定します。 - たとえば、バックエンドで Node.js と Express フレームワークを使用している場合は、CORS ミドルウェアを追加し、
allowedHeadersプロパティにこれらのトレース情報ヘッダーを含めます。
const cors = require('cors')
app.use(
cors({
origin: 'https://your-frontend-domain.com', // フロントエンドアプリケーションのドメインに置き換えてください
allowedHeaders: [
'x-datadog-parent-id',
'x-datadog-origin',
'x-datadog-sampling-priority',
'x-datadog-trace-id',
// 他に必要なヘッダーがある場合があります
],
})
)
- リクエストを処理する:
- バックエンドサービスがこれらのトレース情報ヘッダーを受信し、正しく処理できることを確認します。これらの情報は通常、バックエンドサービス内でリクエストを関連付け、追跡するために使用されます。
検証とテスト¶
-
設定をテストする:
-
フロントエンドからバックエンドへのリクエストを送信し、ネットワークリクエストの HTTP ヘッダーを確認して、トレース情報が正しく送信されていることを確かめます。
-
バックエンドサーバーのログを確認し、トレース情報が正しく処理されていることを確認します。
-
デバッグと修正:
- 問題が発生した場合(CORS エラー、ヘッダーが送信されないなど)は、フロントエンドとバックエンドの設定を確認し、必要に応じて調整してください。
注意事項¶
- 安全性:
allowedTracingUrlsが信頼されたリクエスト URL のみに一致するようにし、想定外の対象に Trace Header が注入されないようにしてください。 - パフォーマンス: トレース情報はパフォーマンスモニタリングにとって重要ですが、アプリケーションのパフォーマンスに悪影響を与えないようにしてください。
以上の手順により、APM ツールを設定してフロントエンドからバックエンドまでの完全な追跡をサポートし、Web アプリケーションのパフォーマンスをより効果的に監視・最適化できます。
Script error が発生する¶
Guance Web RUM SDK を使用して Web 側のエラー収集を行う際、js_error に Script error が表示されることがよくあります。このようなエラーメッセージには詳細情報が含まれていません。
上記の問題が発生する原因として、次のことが考えられます。
- ユーザーが使用しているブラウザがエラーのキャプチャに対応していない(可能性は極めて低い)。
- エラーが発生したスクリプトファイルがクロスオリジンでページに読み込まれている。
ユーザーのブラウザが対応していない場合は、こちらでは対処できません。ここでは主に、クロスオリジンスクリプトのエラーを収集できない原因と解決方法について説明します。
通常、スクリプトファイルは <script> タグを使用して読み込まれます。同一オリジンのスクリプトでエラーが発生した場合、ブラウザの GlobalEventHandlers API を使用すると、収集されるエラー情報には詳細なエラー情報が含まれます。異なるオリジンのスクリプトでエラーが発生した場合、収集されるエラー情報は Script error. というテキストのみになります。これはブラウザの同一オリジンポリシーによって制御される正常な動作です。クロスオリジンのスクリプトについては、クロスオリジンリソース共有(HTTP アクセス制御 / CORS とも呼ばれます)を設定するだけで対応できます。
解決方法:
スクリプトファイルをサーバーに直接配置する場合:
サーバーで静的ファイルを出力する際に次のヘッダーを追加します:
クロスオリジンスクリプトの <script> タグに crossorigin="anonymous" 属性を追加します:
スクリプトファイルを CDN に配置する場合:
CDN 設定で次のヘッダーを追加します:
クロスオリジンスクリプトの <script> タグに crossorigin="anonymous" 属性を追加します:
スクリプトファイルをサードパーティから読み込む場合:
クロスオリジンスクリプトの <script> タグに crossorigin="anonymous" 属性を追加します:
Resource データの収集が不完全¶
次のような現象は、リソースデータが完全に収集されていないと見なされる場合があります。
-
リソースサイズ関連のデータが 0 になる
resource_transfer_size、resource_decode_size、resource_encode_size、resource_sizeなどのフィールドが含まれます。 -
時間関連のデータが収集されない
resource_dns、resource_tcp、resource_ssl、resource_ttfb、resource_trans、resource_first_byte、resource_dns_time、resource_download_time、resource_first_byte_time、resource_connect_timeなどのフィールドが含まれます。
考えられる原因¶
-
接続の再利用(Keep-Alive)
リソースリクエストがkeep-alive方式で接続を維持する場合、DNS クエリと TCP 接続の処理は初回リクエスト時のみ発生し、以降のリクエストは同じ接続を再利用します。そのため、関連データが記録されない、または 0 になる可能性があります。 -
クロスオリジンでのリソース読み込み
リソースがクロスオリジンで読み込まれ、関連するヘッダー情報が設定されていない場合、ブラウザは完全なパフォーマンスデータを収集できません。これがデータ欠落の主な原因です。 -
ブラウザの互換性
ごくまれに、一部のブラウザがPerformance APIに対応していないため、リソース関連のパフォーマンスデータを取得できない場合があります。
クロスオリジンリソースによるデータ欠落の解決方法¶
1. リソースファイルをサーバーに配置する場合
サーバー上でリソースファイルに次の HTTP ヘッダーを追加します:
2. リソースファイルを CDN に配置する場合
CDN 設定でリソースファイルに次の HTTP ヘッダーを追加します:
Resource resource_status データが収集されない¶
状況によっては、resource_status データが欠落する場合があります。原因は次のとおりです。
-
クロスオリジンでのリソース読み込み
リソースがクロスオリジンで読み込まれ、クロスオリジンアクセスの権限が設定されていない場合、ブラウザはリソースのステータス情報を取得できません。 -
ブラウザの互換性
一部のブラウザがPerformance APIに対応しておらず、関連データを収集できない場合があります(ごくまれです)。
クロスオリジンリソースによる resource_status データ欠落の解決方法¶
1. リソースファイルをサーバーに配置する場合
サーバー設定でリソースファイルに次の HTTP ヘッダーを追加します:
2. リソースファイルを CDN に配置する場合
CDN 設定でリソースファイルに次の HTTP ヘッダーを追加します:
上記の設定により、クロスオリジンリソースによるデータ収集の問題を効果的に解決し、ブラウザがパフォーマンスデータを正しく取得できるようになります。 参考ドキュメント。
検索エンジンボットを識別する¶
Web サイトの活動を分析する際は、実際のユーザー活動と検索エンジンを区別する必要があります。次のサンプルスクリプトを使用して、ボットによるセッションを除外できます。
// 既知のボットインスタンスを識別するための正規表現パターン:
let botPattern = "(googlebot\/|bot|Googlebot-Mobile|Googlebot-Image|Google favicon|Mediapartners-Google|bingbot|slurp|java|wget|curl|Commons-HttpClient|Python-urllib|libwww|httpunit|nutch|phpcrawl|msnbot|jyxobot|FAST-WebCrawler|FAST Enterprise Crawler|biglotron|teoma|convera|seekbot|gigablast|exabot|ngbot|ia_archiver|GingerCrawler|webmon |httrack|webcrawler|grub.org|UsineNouvelleCrawler|antibot|netresearchserver|speedy|fluffy|bibnum.bnf|findlink|msrbot|panscient|yacybot|AISearchBot|IOI|ips-agent|tagoobot|MJ12bot|dotbot|woriobot|yanga|buzzbot|mlbot|yandexbot|purebot|Linguee Bot|Voyager|CyberPatrol|voilabot|baiduspider|citeseerxbot|spbot|twengabot|postrank|turnitinbot|scribdbot|page2rss|sitebot|linkdex|Adidxbot|blekkobot|ezooms|dotbot|Mail.RU_Bot|discobot|heritrix|findthatfile|europarchive.org|NerdByNature.Bot|sistrix crawler|ahrefsbot|Aboundex|domaincrawler|wbsearchbot|summify|ccbot|edisterbot|seznambot|ec2linkfinder|gslfbot|aihitbot|intelium_bot|facebookexternalhit|yeti|RetrevoPageAnalyzer|lb-spider|sogou|lssbot|careerbot|wotbox|wocbot|ichiro|DuckDuckBot|lssrocketcrawler|drupact|webcompanycrawler|acoonbot|openindexspider|gnam gnam spider|web-archive-net.com.bot|backlinkcrawler|coccoc|integromedb|content crawler spider|toplistbot|seokicks-robot|it2media-domain-crawler|ip-web-crawler.com|siteexplorer.info|elisabot|proximic|changedetection|blexbot|arabot|WeSEE:Search|niki-bot|CrystalSemanticsBot|rogerbot|360Spider|psbot|InterfaxScanBot|Lipperhey SEO Service|CC Metadata Scaper|g00g1e.net|GrapeshotCrawler|urlappendbot|brainobot|fr-crawler|binlar|SimpleCrawler|Livelapbot|Twitterbot|cXensebot|smtbot|bnf.fr_bot|A6-Indexer|ADmantX|Facebot|Twitterbot|OrangeBot|memorybot|AdvBot|MegaIndex|SemanticScholarBot|ltx71|nerdybot|xovibot|BUbiNG|Qwantify|archive.org_bot|Applebot|TweetmemeBot|crawler4j|findxbot|SemrushBot|yoozBot|lipperhey|y!j-asr|Domain Re-Animator Bot|AddThis)";
let regex = new RegExp(botPattern, 'i');
// ユーザーエージェントがボットパターンに一致する場合は、トレースヘッダーの注入を無効にする
const allowedTracingUrls = regex.test(navigator.userAgent)
? []
: ['https://api.example.com']
window.DATAFLUX_RUM.init({
// ... 設定オプション
allowedTracingUrls
})