ドキュメント一覧 | 使用方法一覧

Boomerang 使用方法 #3:
ページの読み込み時間と一緒にユーザーの帯域幅や遅延を測定する

この要件の説明は ユースケース #3 と #5 をご覧ください。

初期状態では boomerang は常にユーザーの帯域幅と HTTP の遅延を測定し、それらの数値を送信するビーコンに追加します。実際には、帯域幅プラグイン（BOOMR.plugins.BW）がこれを行いますが、boomerang の中にバンドルされているもので、違いは単なる伝統的なものです。帯域幅を効率的に検出するためにいくつか知っておくべきことがあります。

まず JavaScript による帯域幅の検知は正確ではありません。もしユーザーのネットワークが損失が多かったり、他のユーザーと共有していたら、もしくはネットワークのトラフィックが集中的だったら。実際の帯域幅は時間の経過とともに変化します。私たちが測定するのは短時間のものを基準としたもののため、これが最善か最悪の代表的なケースにはならないかもしれません。帯域幅以外の測定もカバーしようとしますが、その測定でもエラーの値も返します。

帯域幅のテストを開始するには単純にページに boomerang を追加して init() メソッドを呼び出すだけで十分です。そうするとビーコンがサーバーに結果を送ります。このようなコードを使います: 

<script src="boomerang.js" type="text/javascript"></script>
<script type="text/javascript">
BOOMR.init({
	beacon_url: "http://yoursite.com/path/to/beacon.php",
	BW: {
		base_url: "http://base_url/to/bandwidth/images/"
	}
});
</script>

BW.base_url パラメーターの初期値は images/ です。もし帯域幅を検出する画像が現在のディレクトリーの images サブディレクトリーにある場合は、BW.base_url パラメーターを設定する必要はありません。複数のディレクトリーがあることもあるかもしれませんが、そのときは良い実践になるでしょう。

これが帯域幅と遅延を測定してビーコンを返すために必要となる最小限のコードです。あなたのユーザーにとっては最善のオプションではありません。テストはユーザーの帯域幅がほとんど変わっていないのにも関わらず、サイト上のページに訪れるたびに毎回実行されます。一定期間、帯域幅を Cookie に格納しておくとはるかに良くなり、もしその Cookie があればそこから取得します。現在、ユーザーは複数のネットワーク間を移動できます。例えばラップトップを自宅で使ったり、職場やコーヒーショップで使ったり。これらの帯域幅や遅延は場所によって異なるかもしれないため、これらを切り分けて測定することが大切です。私たちはユーザーの IP アドレスを通してネットワークの変更を判断し、Cookie にユーザーの帯域幅を格納するため、boomerang にユーザーの IP アドレスを伝える必要があります。これを user_ip パラメーターを使って行ないます。 

<script src="boomerang.js" type="text/javascript"></script>
<script type="text/javascript">
BOOMR.init({
	beacon_url: "http://yoursite.com/path/to/beacon.php",
	user_ip: "<user's ip>",
	BW: {
		base_url: "http://base_url/to/bandwidth/images/"
	}
});
</script>

私の知る限りでは、JavaScript でユーザーの IP アドレスを算出する方法はありません。これはサーバーサイドで行ってあなたのコードに記述しなければなりません。

IPv4 最適化

もしユーザーが IPv4 アドレスを持っていた場合、私たちは IP の最後の部分を除去して、完全な IP アドレスよりもそれを使用します。これはユーザーが同じ ISP 上の DHCP を使用している場合、IP アドレスは頻繁に変更されますが、同じサブネット内に留まるため効果がでます。もしユーザーが IPv6 アドレスを持っている場合はアドレス全体を使用します。

Cookie

帯域幅が格納される Cookie の名前をカスタマイズしたい場合もあると思います。初期値は BA になっていますが、これは BW.cookie パラメーターで変更することができます。 

<script src="boomerang.js" type="text/javascript"></script>
<script type="text/javascript">
BOOMR.init({
	beacon_url: "http://yoursite.com/path/to/beacon.php",
	user_ip: "<user's ip>",
	BW: {
		base_url: "http://base_url/to/bandwidth/images/",
		cookie: "BW"
	}
});
</script>

この Cookie は7日間有効です。BW.cookie_exp パラメーターを使って有効期限の変更もできます。値は秒です。その間、サーバーサイドで Cookie の値も取得することができます。フォーマットは以下の通りです: 

BA=ba=nnnnnnn&be=nnn.nn&l=nnnn&le=nn.nn&ip=iiiiii&t=sssssss;

定義されているパラメーター:

ba
[integer] [バイト/秒] あなたのサーバーにおけるユーザーの帯域幅
be
[float] [バイト/秒] 測定したユーザーの帯域幅からエラーを除いた95%信頼できる値
l
[float] [ミリ秒] ユーザーのコンピューターとあなたのサーバー間の HTTP 遅延
le
[float] [ミリ秒] 測定したユーザーの遅延からエラーを除いた95%信頼できる値
ip
[IP アドレス] init() メソッドに user_ip パラメーターとして渡されたユーザーの IPv4 アドレスまたは IPv6 アドレス
t
[タイムスタンプ] Cookie がセットされた時のブラウザーの時間（UNIX time）

これらのパラメーターはビーコンに送信されます（使用方法 #0 をご覧ください）が、Cookie にこれらを持っているということはリクエストを処理する前に帯域幅をもとにユーザーエクスペリエンスをカスタマイズできるということを意味します。

帯域幅のチェックを無効にする

最後に、帯域幅のテストを完全に無効にしたい場合があるかもしれません。おそらくあなたはユーザーが遅いネットワークを使っていたり、バイト単位で料金を払っていたり（帯域幅のテストはたくさんの帯域幅を使用します）、モバイルデバイスを使っていたりして読み込みきれないことを考えていると思います。その場合は2つの方法があります。

  1. boomerang.js のコピーから帯域幅プラグインを削除する
  2. BW.enabled パラメーターを false にする:
<script src="boomerang.js" type="text/javascript"></script>
<script type="text/javascript">
BOOMR.init({
	BW: { enabled: false  }
});
</script>

最新のソースコードとドキュメントは github.com/SOASTA/boomerang に公開されています。