RUM データに編集が必要な機密情報が含まれている場合は、RUM を初期化するときに beforeSend コールバックを使用して、機密シーケンスを編集するか選択した RUM イベントを破棄するように Browser SDK を構成します。
このコールバック関数を使用すると、RUM SDK によって収集されたすべてのイベントにアクセスしてから Datadog に送信できます。
たとえば、Web アプリケーションの URL からメールアドレスを編集します。
import { datadogRum } from '@datadog/browser-rum';
datadogRum.init({
...,
beforeSend: (event) => {
// ビューの URL からメールを削除します
event.view.url = event.view.url.replace(/email=[^&]*/, "email=REDACTED")
},
...
});
DD_RUM.onReady(function() {
DD_RUM.init({
...,
beforeSend: (event) => {
// ビューの URL からメールを削除します
event.view.url = event.view.url.replace(/email=[^&]*/, "email=REDACTED")
},
...
})
})
window.DD_RUM &&
window.DD_RUM.init({
...,
beforeSend: (event) => {
// ビューの URL からメールを削除します
event.view.url = event.view.url.replace(/email=[^&]*/, "email=REDACTED")
},
...
});
次のイベントプロパティを更新できます。
| 属性 | タイプ | 説明 |
|---|---|---|
view.url | 文字列 | アクティブな Web ページの URL。 |
view.referrer | 文字列 | 現在リクエストされているページへのリンクがたどられた前のウェブページの URL。 |
action.target.name | 文字列 | ユーザーが操作した要素。自動的に収集されたアクションの場合のみ。 |
error.message | 文字列 | エラーについて簡潔にわかりやすく説明する 1 行メッセージ。 |
error.stack | 文字列 | スタックトレースまたはエラーに関する補足情報。 |
error.resource.url | 文字列 | エラーをトリガーしたリソース URL。 |
resource.url | 文字列 | リソースの URL。 |
注: RUM SDK は、上記にリストされていないイベントプロパティに加えられた変更を無視します。すべてのイベントプロパティについては、Browser SDK リポジトリを参照してください。
beforeSend API で、false を返し RUM イベントを破棄します。
import { datadogRum } from '@datadog/browser-rum';
datadogRum.init({
...,
beforeSend: (event) => {
if (shouldDiscard(event)) {
return false
}
...
},
...
});
DD_RUM.onReady(function() {
DD_RUM.init({
...,
beforeSend: (event) => {
if (shouldDiscard(event)) {
return false
},
...
},
...
})
})
window.DD_RUM &&
window.DD_RUM.init({
...,
beforeSend: (event) => {
if (shouldDiscard(event)) {
return false
}
...
},
...
});
RUM セッションにユーザー情報を追加すると、次のことが簡単になります。
次の属性はオプションですが、少なくとも 1 つを指定することをお勧めします。
| 属性 | タイプ | 説明 |
|---|---|---|
| usr.id | 文字列 | 一意のユーザー識別子。 |
| usr.name | 文字列 | RUM UI にデフォルトで表示されるユーザーフレンドリーな名前。 |
| usr.email | 文字列 | ユーザー名が存在しない場合に RUM UI に表示されるユーザーのメール。Gravatar をフェッチするためにも使用されます。 |
注: 推奨される属性に加えてさらに属性を追加することで、フィルタリング機能を向上できます。たとえば、ユーザープランに関する情報や、所属するユーザーグループなどを追加します。
ユーザーセッションを識別するには、setUser API を使用します。
datadogRum.setUser({
id: '1234',
name: 'John Doe',
email: 'john@doe.com',
plan: 'premium',
...
})
DD_RUM.onReady(function() {
DD_RUM.setUser({
id: '1234',
name: 'John Doe',
email: 'john@doe.com',
plan: 'premium',
...
})
})
window.DD_RUM && window.DD_RUM.setUser({
id: '1234',
name: 'John Doe',
email: 'john@doe.com',
plan: 'premium',
...
})
removeUser API で、以前に設定されたユーザーを消去します。この後に収集されたすべての RUM イベントにユーザー情報は含まれません。
datadogRum.removeUser()
DD_RUM.onReady(function() {
DD_RUM.removeUser()
})
window.DD_RUM && window.DD_RUM.removeUser()
デフォルトでは、収集セッション数にサンプリングは適用されていません。収集セッション数に相対サンプリング (% 表示) を適用するには、RUM を初期化する際に sampleRate パラメーターを使用します。下記の例では、RUM アプリケーションの全セッションの 90% のみを収集します。
import { datadogRum } from '@datadog/browser-rum';
datadogRum.init({
applicationId: '<DATADOG_APPLICATION_ID>',
clientToken: '<DATADOG_CLIENT_TOKEN>',
site: '<DATADOG_SITE>',
sampleRate: 90,
});
<script>
(function(h,o,u,n,d) {
h=h[d]=h[d]||{q:[],onReady:function(c){h.q.push(c)}}
d=o.createElement(u);d.async=1;d.src=n
n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
})(window,document,'script','https://www.datadoghq-browser-agent.com/datadog-rum.js','DD_RUM')
DD_RUM.onReady(function() {
DD_RUM.init({
clientToken: '<CLIENT_TOKEN>',
applicationId: '<APPLICATION_ID>',
site: '<DATADOG_SITE>',
sampleRate: 90,
})
})
</script>
window.DD_RUM &&
window.DD_RUM.init({
clientToken: '<CLIENT_TOKEN>',
applicationId: '<APPLICATION_ID>',
site: '<DATADOG_SITE>',
sampleRate: 90,
});
注: サンプルとして抽出したセッションでは、すべてのページビューとそのセッションに紐付くテレメトリーは収集されません。
リアルユーザーモニタリング (RUM) を初期化したら、addRumGlobalContext(key: string, value: any) API を使用してアプリケーションから収集したすべての RUM イベントにコンテキストを追加します。
import { datadogRum } from '@datadog/browser-rum';
datadogRum.addRumGlobalContext('<CONTEXT_KEY>', <CONTEXT_VALUE>);
// コード例
datadogRum.addRumGlobalContext('activity', {
hasPaid: true,
amount: 23.42
});
DD_RUM.onReady(function() {
DD_RUM.addRumGlobalContext('<CONTEXT_KEY>', '<CONTEXT_VALUE>');
})
// コード例
DD_RUM.onReady(function() {
DD_RUM.addRumGlobalContext('activity', {
hasPaid: true,
amount: 23.42
});
})
window.DD_RUM && window.DD_RUM.addRumGlobalContext('<CONTEXT_KEY>', '<CONTEXT_VALUE>');
// コード例
window.DD_RUM && window.DD_RUM.addRumGlobalContext('activity', {
hasPaid: true,
amount: 23.42
});
注: 製品全体でデータの相関を高めるには Datadog の命名規則に従ってください。
リアルユーザーモニタリング (RUM) を初期化したら、setRumGlobalContext(context: Context) API を使用してすべての RUM イベントのデフォルトコンテキストを置換します。
import { datadogRum } from '@datadog/browser-rum';
datadogRum.setRumGlobalContext({ '<コンテキストキー>', <コンテキスト値>' });
// Code example
datadogRum.setRumGlobalContext({
codeVersion: 34,
});
DD_RUM.onReady(function() {
DD_RUM.setRumGlobalContext({ '<CONTEXT_KEY>': '<CONTEXT_VALUE>' });
})
// コード例
DD_RUM.onReady(function() {
DD_RUM.setRumGlobalContext({
codeVersion: 34,
})
})
window.DD_RUM &&
DD_RUM.setRumGlobalContext({ '<コンテキストキー>', <コンテキスト値>' });
// Code example
window.DD_RUM &&
DD_RUM.setRumGlobalContext({
codeVersion: 34,
});
注: 製品全体でデータの相関を高めるには Datadog の命名規則に従ってください。
リアルユーザーモニタリング (RUM) を初期化したら、getRumGlobalContext() API を使用してグローバルコンテキストを読み取ります。
import { datadogRum } from '@datadog/browser-rum';
const context = datadogRum.getRumGlobalContext();
DD_RUM.onReady(function() {
var context = DD_RUM.getRumGlobalContext();
});
var context = window.DD_RUM && DD_RUM.getRumGlobalContext();
