Merge pull request #30 from ingestly/internal-optimization-20200306

Optimization 20200306

Author: hjmsano

README-JP.md

@@ -71,6 +71,16 @@ npm run build
 
 追加の計測機能を有効化できます。
 
+### セッションIDサポート
+
+- 少なくないウェブアナリストがまだ「セッション」に基づく行動の集計をしており、もしレコードにセッションIDが無ければSQLで対処することになります。
+- このSDKは、 `options.session.enable` に `true` をセットすることで、セッションIDをセット・計測することができます。また、以下の追加オプションが利用できます：
+
+|変数|例|説明|
+|:---|:---|:---|
+|domain|`example.com`|Cookie発行元ドメイン。もしサブドメインを跨いでCookieを共有したい場合、親ドメインを指定します|
+|lifetime|`1800`|Cookieの有効期限の秒。もし訪問者がこの指定秒数以上ビーコンを送らないでいた場合、セッションは次のページで更新されます|
+
 ### リアルユーザーモニタリング
 
 - 各クライアントにおける実際のページロードの時間軸に基づくパフォーマンス情報、Real User Monitoringの計測ができます

README.md

@@ -70,6 +70,16 @@ Note: If you remove `eventName` and/or `eventFrequency`, or set `0` for `eventFr
 
 You can enable optional tracking features.
 
+### Session ID support
+
+- Not a few web analyst still uses "Session" based behavior aggregation, and it requires an SQL skills if records don't have a session ID.
+- This SDK can set a session ID and collect it by setting `true` to `options.session.enable`, and you can use additional options below:
+
+|variable|example|description|
+|:---|:---|:---|
+|domain|`example.com`|A domain name to be set as an issuer of the cookie. If you want to share the cookie across multiple sub-domains, set a parent domain.|
+|lifetime|`1800`|A cookie lifetime in seconds. If the visitor does not send beacons over this value, session will be renewd on the next page.|
+
 ### Real User Monitoring
 
 - You can measure the Real User Monitoring data which is the performance information based on timeline of page loading on each client.

example/page_code.js

@@ -11,6 +11,11 @@
             prefix: 'ingestly',
             targetWindow: 'self',
             options: {
+                session: {
+                    enable: true,
+                    domain: 'example.com',
+                    lifetime: 1800
+                },
                 rum: {
                     enable: true
                 },
@@ -31,15 +36,15 @@
                     enable: true,
                     threshold: 2,
                     granularity: 20,
-                    targets: [].slice.call(window.document.getElementsByTagName('article'))
+                    targets: window.document.getElementsByTagName('article')
                 },
                 media: {
                     enable: true,
                     heartbeat: 5
                 },
                 form: {
                     enable: true,
-                    targets: [].slice.call(window.document.getElementsByTagName('form'))
+                    targets: window.document.getElementsByTagName('form')
                 }
             }
         });