:SDK メソッド

このトピックのメソッド

• データレポート用のメソッド: api()、error()、sum()、avg()、reportBehavior()、および performance()。

• SDK 設定変更用のメソッド: setConfig()、setPage()、setCommonInfo()、および addBehavior()。

api()

ページ上の API 呼び出しの成功率をレポートするために、api() メソッドを呼び出すことができます。

デフォルトでは、SDK はページ上の Asynchronous JavaScript and XML (AJAX) リクエストをリッスンし、このメソッドを呼び出してデータをレポートします。ページ上のデータが JSON with Padding (JSONP) またはクライアント SDK などの他のカスタムツールを使用してリクエストされた場合は、データリクエストで api() メソッドを呼び出して手動でレポートできます。

api() の構文:

__bl.api(api, success, time, code, msg, begin, traceId, sid)

または

__bl.api({api: xxx, success: xxx, time: xxx, code: xx, msg: xx, begin: xx, traceId: xx, sid: xx})

api() の例:

var begin = Date.now(),
    url = '/data/getTodoList.json',
    traceId = window.__bl && __bl.getTraceId('EagleEye-TraceID'),
    sid = window.__bl && __bl.getSessionId('EagleEye-SessionID');
// リクエストヘッダーで EagleEye-TraceID と EagleEye-SessionID を指定します。
fetch(url, {
    headers: {
        'EagleEye-TraceID': traceId,
        'EagleEye-SessionID': sid
    }
}).then(function (result) {
    var time = Date.now() - begin;
    // 呼び出しが成功したことをレポートします。
    window.__bl && __bl.api(url, true, time, result.code, result.msg, begin, traceId, sid);
    // 何かを行う ....
}).catch(function (error) {
    var time = Date.now() - begin;
    // 呼び出しが失敗したことをレポートします。
    window.__bl && __bl.api(url, false, time, 'ERROR', error.message, begin, traceId, sid);
    // 何かを行う ...
});    

[トップに戻る]

error()

error() メソッドを呼び出して、ページでキャプチャしたい JavaScript (JS) エラーまたは例外をレポートできます。ブラウザ監視の JS エラー診断 ページで JS エラーの詳細を確認できます。

通常、SDK はページ上のグローバルエラーをリッスンし、このメソッドを呼び出して例外をレポートします。ただし、ブラウザの同一生成元ポリシーのため、エラーの詳細にアクセスできないことがよくあります。この場合、そのようなエラーを手動でレポートする必要があります。

__bl.error(error, pos)

window.addEventListener('error', function (ex) {
    // イベントパラメーターには通常、場所情報が含まれています。
    window.__bl && __bl.error(ex.error, ex);
});            

window.__bl && __bl.error(new Error('カスタムエラーが発生しました。'), {
    filename: 'app.js', 
    lineno: 10, 
    colno: 15
});            

__bl.error({name:'CustomErrorLog',message:'this is an error'}, {
    filename: 'app.js', 
    lineno: 10, 
    colno: 15
});           

[トップに戻る]

sum()

sum() の構文:

__bl.sum(key, value)

__bl.sum('event-a');
__bl.sum('event-b', 3);

[トップに戻る]

avg()

__bl.avg(key, value)

__bl.avg('event-a', 1);
__bl.avg('event-b', 3);

[トップに戻る]

reportBehavior()

reportBehavior() メソッドを呼び出して、現在の動作キューをすぐにレポートできます。

このメソッドを手動で呼び出さない場合、JS エラーが発生すると、現在の動作キューが自動的にレポートされます。キューの最大サイズは 100 です。キューに 100 を超える動作レコードが含まれている場合、動作レコードはキューの先頭から破棄されます。

reportBehavior() の構文:

__bl.reportBehavior()

reportBehavior() メソッドにはリクエストパラメーターがありません。

[トップに戻る]

performance()

onLoad メソッドが呼び出された後、performance() メソッドが呼び出され、デフォルトのパフォーマンスメトリック以外にカスタムパフォーマンスメトリックがレポートされます。

performance() メソッドの呼び出し方法:

1. autoSendPerf パラメーターを false に設定して、パフォーマンスメトリックの自動レポートを無効にし、手動レポートを待ちます。

2. __bl.performance(Object) メソッドを呼び出して、カスタムパフォーマンスメトリックを手動でレポートします。このプロセスでは、デフォルトのパフォーマンスメトリックが自動的にレポートされます。

performance() の例 1 (CDN を使用):

window.onload = () => {
 setTimeout(()=>{
  __bl.performance({cfpt:100, ctti:200, t1:300, …});
 }, 1000); // デフォルトのパフォーマンスデータが確実に収集されるように遅延を設定します。
};

performance() の例 2 (npm パッケージを使用):

const BrowserLogger = require('alife-logger');
const __bl = BrowserLogger.singleton({pid:'Unique site ID'});
window.onload = () => {
 setTimeout(()=>{
  __bl.performance({cfpt:100, ctti:200, t1:300, …});
 }, 1000); // デフォルトのパフォーマンスデータが確実に収集されるように遅延を設定します。
};

[トップに戻る]

setConfig()

SDK の初期化後に setConfig() メソッドを呼び出して、特定の設定項目を変更できます。詳細については、SDK リファレンスを参照してください。

setConfig() の構文:

__bl.setConfig(next)

setConfig() の例: disableHook パラメーターの値を変更して、自動 API レポートを無効にします。

__bl.setConfig({
    disableHook: true
});            

[トップに戻る]

setPage()

setPage() メソッドを呼び出して、ページのページ名をリセットできます。デフォルトでは、PV データが再レポートされます。 このメソッドは通常、シングルページアプリケーション（SPA）に使用されます。詳細については、SPA のページデータレポートを参照してください。

setPage() の構文:

__bl.setPage(page, sendPv)

現在のページの名前を現在の URL ハッシュに設定し、PV データを再レポートします。
__bl.setPage(location.hash);

// PV データレポートをトリガーせずに、現在のページの名前をホームページに設定します。
__bl.setPage('homepage', false);          

[トップに戻る]

setCommonInfo()

setCommonInfo() メソッドを呼び出して、共通フィールドを設定できます。

setCommonInfo() の構文:

__bl.setCommonInfo(obj)

__bl.setCommonInfo({
  name: 'xxx',
  common: 'xxx'
});          

[トップに戻る]

addBehavior()

addBehavior() メソッドを呼び出して、カスタムユーザー動作を現在の動作キューの末尾に追加できます。

SDK は、最大 100 レコードのユーザー動作キューを保持します。addBehavior() メソッドを呼び出して、カスタムユーザー動作を現在の動作キューの末尾に追加できます。JS エラーが発生すると、addBehavior() メソッドは現在の動作キューをレポートし、キューをクリアします。

JS エラー診断 ページでユーザーの動作を確認できます。詳細については、ユーザーの動作をバックトラックして JS エラーを診断するを参照してください。

addBehavior() の構文:

__bl.addBehavior(behavior)

addBehavior() の例:

_bl.addBehavior({
  data:{name:'string',message:'sting'},
  page:'string'
})

[トップに戻る]

複数のインスタンスを作成する

npm パッケージを使用して複数のインスタンスを作成します。公式 npm パッケージ alife-logger が公開されています。

Web ページ

• 例:

  const BrowerLogger = require('alife-logger');
  const bl2 = BrowerLogger.createExtraInstance(props); // createExtraInstance メソッドを使用してインスタンスを作成します。
  bl2.custom({
    key: 'biz',
    msg: 'msg info'
  });

  説明

  props パラメーターは Object タイプです。props パラメーターに含まれるパラメーターは、基本的に SDK 設定のパラメーターと同じです。

• 新しいインスタンスはカスタム情報のみをレポートします。

  var props = {
    pid: 'xxxx', // 新しいインスタンスがデータをレポートする必要があるサイトの ID。
    region: 'cn',
    page: '',
    uid: ''
  }

Weex ページ

• 例:

  const WeexLogger = require('alife-logger/weex');
  const wl2 = WeexLogger.createExtraInstance(props); // createExtraInstance メソッドを使用してインスタンスを作成します。
  wl2.custom({
    key: 'biz',
    msg: 'msg info'
  });

  説明

  props パラメーターは Object タイプです。props パラメーターに含まれるパラメーターは、基本的に SDK 設定のパラメーターと同じです。

• 新しいインスタンスはカスタム情報のみをレポートします。

  var props = {
    pid: 'xxxx', // 新しいインスタンスがデータをレポートする必要があるサイトの ID。
    region: 'cn',
    sendRequest: function(data, imgUrl) {
      // GET ログスキームを送信します。
    },
    postRequest: function(data, imgUrl) {
      // POST ログスキームを送信します。
    }
  }

ミニプログラム

import MiniProgramLogger from 'alife-logger/miniprogram'; // ミニプログラムのタイプ（DingTalk ミニプログラムや Alipay ミニプログラムなど）に基づいてパスを指定します。
const MiniInstance = MiniProgramLogger.createExtraInstance({
  pid: 'xxxinstance',
  uid: 'userxxx', // ユーザーの ID。UV データの収集に使用されます。
  region: 'cn', // ログのレポート先アプリケーションが中国またはシンガポールにデプロイされているかどうかを指定します。値 cn は中国を示し、値 sg はシンガポールを示します。このパラメーターを指定しない場合、値は cn に設定されます。
  // リモートプロシージャコール（RPC）メソッドをビジネスに基づいて指定して、ミニプログラムのブラウザ監視を実行します。
  sendRequest: (url, resData) => {
    // 送信方法。
  }
});