Application Real-Time Monitoring Service:SDK リファレンス

このトピックのメソッド

pid | uid | tag | page | setUsername | enableSPA | parseHash | disableHook | ignoreUrlCase | urlHelper | apiHelper | parseResponse | ignore | disabled | sample | pvSample | sendResource | useFmp | enableLinkTrace | release | environment | behavior | c1\c2\c3 | autoSendPerf

SDK 構成項目の使用

次のいずれかの方法で SDK 構成項目を使用できます。

• ブラウザモニタリングエージェントをページにインストールするときに、要件に基づいて config にパラメータを追加します。

  たとえば、次のサンプルコードでは、デフォルトの pid パラメータに加えて、シングルページアプリケーション (SPA) の enableSPA パラメータが config に追加されています。

  <script>
  !(function(c,b,d,a){c[a]||(c[a]={});c[a].config={pid:"xxxxxx",enableSPA:true};
  with(b)with(body)with(insertBefore(createElement("script"),firstChild))setAttribute("crossorigin","",src=d)
  })(window,document,"https://retcode.alicdn.com/retcode/bl.js","__bl");
  </script>                    

• ページが初期化された後、JavaScript コードで setConfig メソッドを呼び出して、構成項目を変更します。

  次の表は、__bl.setConfig(next) メソッドのパラメータを示しています。

  パラメータ	タイプ	説明	必須	デフォルト値
  next	オブジェクト	変更する構成項目とその値。	はい	なし

pid

[先頭に戻る]

uid

次のコードは、setConfig メソッドを呼び出して SDK 構成項目を変更する方法の例を示しています。

__bl.setConfig({
    uid: 12345
});        

[先頭に戻る]

tag

[先頭に戻る]

page

[先頭に戻る]

setUsername

この構成項目は、関数の作成に使用されます。この関数は、文字列としてユーザー名を取得するために使用されます。ユーザー名を取得した後、エンドツーエンドのセッショントレーシングを実装し、ユーザー名に基づいてセッションをクエリして問題をトラブルシューティングできます。

次のコードは、setConfig メソッドを呼び出して SDK 構成項目を変更する方法の例を示しています。

__bl.setConfig({
    setUsername: function () {
        return "username_xxx";
    }
});            

[先頭に戻る]

enableSPA

[先頭に戻る]

parseHash

SPA では、enableSPA パラメータが true に設定され、ページが hashchange イベントをトリガーすると、parseHash パラメータを使用して、URL ハッシュを [ページ] フィールドで示される ページ名 に解析します。SPA の詳細については、SPA のページデータレポート を参照してください。

デフォルト値

デフォルト値は、次の文字列処理メソッドを使用して取得されます。

function (hash) {
    var page = hash ? hash.replace(/^#/, '').replace(/\?.*$/, '') : '';
    return page || '[index]';
}           

通常、このパラメータを変更する必要はありません。ただし、カスタムページ名を使用してページ固有のデータを報告する場合、または URL ハッシュが複雑な場合は、この構成項目を変更できます。例：

// URL ハッシュとページ名のマッピングを定義します。
var PAGE_MAP = {
    '/': 'ホームページ',
    '/contact': 'お問い合わせ',
    '/list': 'データリスト',
    // ...
};
// ページの読み込み後に SDK メソッドを呼び出します。
window.addEventListener('load', function (e) {
    // setConfig メソッドを呼び出して parseHash 構成項目を変更します。
    __bl.setConfig({
        parseHash: function (hash) {
            key = hash.replace(/\?.*$/, '');
            return PAGE_MAP[key] || '不明なページ';
        }
    });
});

[先頭に戻る]

disableHook

[先頭に戻る]

ignoreUrlCase

[先頭に戻る]

urlHelper

ページ URL が http://example.com/projects/123456 の形式（projects の後に続く値はプロジェクト ID）の場合、ページ固有のデータはページ名 example.com/projects/123456 として報告されます。この場合、プロジェクトに関する類似ページのデータを集計することはできません。類似ページのデータを集計する場合は、urlHelper パラメータを設定して、この例のプロジェクト ID など、ページ URL から重要でない文字を削除します。

デフォルト値

この構成項目のデフォルト値は、次のサンプルコードの配列です。ほとんどの場合、値を変更する必要はありません。

[
    // URL のすべての数字をアスタリスク (*) に置き換えます。
    {rule: /\/([a-z\-_]+)?\d{2,20}/g, target: '/$1**'},
    // URL の末尾のスラッシュ (/) を削除します。
    /\/$/
]                    

このパラメータのデフォルト値は、xxxx/123456 などの文字列の数字をアスタリスク (*) に置き換えるために使用されます。たとえば、xxxx/00001 と xxxx/00002 は xxxx/** に変更されます。

値のタイプ

urlHelper パラメータの値は、次のタイプのいずれかになります。

• String または RegExp (正規表現)：一致する文字列が削除されます。

• Object<rule, target>：オブジェクトには、JavaScript 文字列の replace メソッドの入力パラメータである rule と target の 2 つのキーが含まれています。詳細については、関連する JavaScript チュートリアルで説明されている String::replace メソッドを参照してください。

• Function：元の文字列は、関数の作成のための入力パラメータとして使用されます。関数の戻り値はページ名として使用されます

• Array：この値のタイプは、ページ URL の重要でない文字を削除するための複数のルールを設定するために使用されます。各ルールの値は、上記のタイプのいずれかになります。

[先頭に戻る]

apiHelper

このパラメータは、API 操作に関するページ固有のデータが自動的に報告されるときに、ページ URL の重要でない文字を削除するために使用されます。このパラメータの使用方法と機能は、urlHelper と同じです。

デフォルト値

このパラメータのデフォルト値はオブジェクトであり、変更する必要はありません。

{rule: /(\w+)\/\d{2,}/g, target: '$1'}                    

このパラメータのデフォルト値は、xxxx/123456 などの URL 文字列の数字を削除するために使用されます。

API 操作のページ固有データ（例: https://arms.console.aliyun.com/apm?pid=fr6fbgbeot の pid パラメーター）で ? の後にパラメーターを報告する場合は、次の手順を実行して手動でデータを報告します。

• ignore メソッドを呼び出して、自動データレポートを無効にします。詳細については、ignore を参照してください。

• api() メソッドを呼び出して、API 操作に関するページ固有のデータを手動で報告します。詳細については、api() を参照してください。

[先頭に戻る]

parseResponse

この構成項目は、API 操作のページ固有のデータが自動的に報告されるときに返されたデータを解析するために使用されます。

デフォルト値

次のサンプルコードは、デフォルトの構成を示しています。

function (res) {
    if (!res || typeof res !== 'object') return {};
    var code = res.code;
    var msg = res.msg || res.message || res.subMsg || res.errorMsg || res.ret || res.errorResponse || '';
    if (typeof msg === 'object') {
        code = code || msg.code;
        msg = msg.msg || msg.message || msg.info || msg.ret || JSON.stringify(msg);
    }
    return {msg: msg, code: code, success: true};
}                    

上記のコードは、返されたデータを解析し、msg パラメータと code パラメータを抽出するために使用されます。通常、デフォルトの構成を変更する必要はありません。ビジネス要件に基づいて構成を変更することもできます。

[先頭に戻る]

ignore

ignore パラメータの値は、4 つのプロパティ（ignoreUrls、ignoreApis、ignoreErrors、ignoreResErrors）を含むオブジェクトです。パラメータ値の 1 つ以上のプロパティを設定できます。

デフォルト値

次のサンプルコードは、デフォルトの構成を示しています。

ignore: {
        ignoreUrls: [],
        ignoreApis: [],
        ignoreErrors: [],
        ignoreResErrors: []
    },                    

ignoreUrls

ignoreUrls プロパティは、指定したルールに準拠する URL を無視するために使用されます。これらの URL からのログは報告されません。このプロパティの値は、文字列（String 型で示されます）、正規表現（RegExp 型で示されます）、メソッド（Function 型で示されます）、または上記の型のデータを含む配列です。例：

__bl.setConfig({
                ignore: {
                    ignoreUrls: [
                    'http://host1/',  // 文字列を指定します。
                    /.+?host2.+/,     // 正規表現を指定します。
                    function(str) {   // メソッドを指定します。
                        if (str && str.indexOf('host3') >= 0) {
                            return true; // データは報告されません。
                        }
                        return false; // データは報告されます。
                    }]
                }
            });                    

ignoreApis

ignoreApis プロパティは、指定したルールに準拠する API を無視するために使用されます。このプロパティの値は、文字列（String 型で示されます）、正規表現（RegExp 型で示されます）、メソッド（Function 型で示されます）、または上記の型のデータを含む配列です。例：

__bl.setConfig({
                ignore: {
                    ignoreApis: [
                    'api1','api2','api3', // 文字列を指定します。
                    /^random/,  // 正規表現を指定します。
                    function(str) { // メソッドを指定します。
                        if (str && str.indexOf('api3') >= 0) return true; // データは報告されません。
                        return false; // データは報告されます。
                    }]
                }
            });                    

ignoreErrors

ignoreErrors プロパティは、指定したルールに準拠する JS エラーを無視するために使用されます。このプロパティの値は、文字列（String 型で示されます）、正規表現（RegExp 型で示されます）、メソッド（Function 型で示されます）、または上記の型のデータを含む配列です。例：

__bl.setConfig({
                ignore: {
                    ignoreErrors: [
                    'test error', // 文字列を指定します。
                    /^Script error\.?$/, // 正規表現を指定します。
                    function(str) { // メソッドを指定します。
                        if (str && str.indexOf('Unknown error') >= 0) return true;   // データは報告されません。
                        return false; // データは報告されます。
                    }]
                }
            });            

ignoreResErrors

ignoreResErrors プロパティは、指定したルールに準拠するリソースエラーを無視するために使用されます。このプロパティの値は、文字列（String 型で示されます）、正規表現（RegExp 型で示されます）、メソッド（Function 型で示されます）、または上記の型のデータを含む配列です。例：

__bl.setConfig({
                ignore: {
                    ignoreResErrors: [
                    'http://xx/picture.jpg', // 文字列を指定します。
                    /jpg$/, // 正規表現を指定します。
                    function(str) { // メソッドを指定します。
                        if (str && str.indexOf('xx.jpg') >= 0) return true;   // データは報告されません。
                        return false; // データは報告されます。
                    }]
                }
            });

[先頭に戻る]

disabled

[先頭に戻る]

sample

メリット:

• サンプリングされた API データのみを報告することでコストを削減します。 ignore パラメーターを設定して、監視が不要なデータを特定することをお勧めします。詳細については、ignore を参照してください。

• データ収集のパフォーマンスオーバーヘッドを削減します。

説明:

• この構成項目を設定すると、パフォーマンスログとAPI操作の成功に関するログをランダムに選択して報告できます。これにより、報告されるデータ量とワークロードが削減されます。ARMSは、バックグラウンドで報告されたログを処理する際に、サンプリング設定に基づいてデータを復元します。このように、JSエラー率やAPI失敗率などのメトリクスはサンプリングの影響を受けず、正確なままです。ただし、このパラメータを設定すると、APIの詳細などの詳細データを取得できない場合があります。

• sample パラメーターの既定値は 1 です。このパラメーターの有効な値は、1 から 100 までの整数です。サンプリングレートは、1/Value of sample という式を使用して計算できます。たとえば、パラメーター値 1、10、100 は、それぞれ 100%、10%、1% のサンプリングレートを示します。

[先頭に戻る]

pvSample

メリット:

• サンプリングされた PV データのみを報告することでコストを削減します。

• データ収集のパフォーマンスオーバーヘッドを削減します。

説明:

• この構成項目を設定して、PV ログをランダムに選択して報告することができます。これにより、報告されるデータの量とワークロードが削減されます。ARMS がバックグラウンドで報告されたログを処理するときに、ARMS はサンプリング構成に基づいてデータを復元します。このように、JS エラー率などのメトリックはサンプリングの影響を受けず、正確なままです。

• pvSample パラメーターのデフォルト値は 1 です。このパラメーターの有効な値は 1 から 100 までの整数です。サンプリングレートは、次の式を使用して計算できます。1/Value of pvSample。たとえば、パラメーター値 1、10、100 は、それぞれ 100%、10%、1% のサンプリングレートを示します。

[先頭に戻る]

sendResource

sendResource パラメーターが true に設定されている場合、ページの load イベントがトリガーされると、現在のページに読み込まれた静的リソースが報告されます。ページの読み込みが遅い場合は、[セッショントレース] ページで静的リソースのウォーターフォールチャートを表示して、原因を特定できます。

次のコードは、sendResource パラメーターを設定する方法の例を示しています。

<script>
!(function(c,b,d,a){c[a]||(c[a]={});c[a].config={pid:"xxxxxx",sendResource:true}; // pid を設定し、sendResource を true に設定します。
with(b)with(body)with(insertBefore(createElement("script"),firstChild))setAttribute("crossorigin","",src=d)
})(window,document,"https://retcode.alicdn.com/retcode/bl.js","__bl");
</script>            

[先頭に戻る]

useFmp

[先頭に戻る]

enableLinkTrace

[先頭に戻る]

リリース

[先頭に戻る]

環境

[先頭に戻る]

動作

[先頭に戻る]

autoSendPerf

[先頭に戻る]

c1\c2\c3

上記の構成項目に加えて、ARMS SDK は、ビジネス要件に合わせてフィールドを設定できる 3 つのカスタム構成項目を提供します。フィールドを設定すると、フィールド値は報告されるすべてのログに含まれます。

[先頭に戻る]