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://sdk.rum.aliyuncs.com/v1/bl.js","__bl");
  </script>                    

• ページの初期化後、JavaScript コードで setConfig メソッドを呼び出して設定項目を変更します。

  __bl.setConfig(next) メソッドは、次のパラメーターを受け入れます。

  パラメーター	タイプ	説明	必須	デフォルト値
  next	Object	変更したい設定項目とその値。	はい	なし

pid

[トップに戻る]

uid

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

__bl.setConfig({
    uid: 12345
});        

[トップに戻る]

tag

[トップに戻る]

page

[トップに戻る]

setUsername

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

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

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

[トップに戻る]

enableSPA

[トップに戻る]

parseHash

シングルページアプリケーション (SPA) のシナリオ (「SPA のページデータレポート」をご参照ください) で、enableSPA が true に設定されている場合、hashchange イベントが発生すると、parseHash パラメーターが URL ハッシュを Page フィールドに解析します。

Default value

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

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 メソッドを呼び出して SDK 設定項目を変更します。
    __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 のような重要でない文字をフィルタリングできます。

Default value

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

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

デフォルトでは、この設定はパスセグメントに続く数値識別子を置き換えます。たとえば、xxxx/00001 と xxxx/00002 は、元の URL xxxx/123456 と同様に、xxxx/** になります。

値のタイプ

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

• String または RegExp (正規表現)：URL 文字列の一致した部分を削除します。

• Object<rule, target>： rule キーと target キーを持つオブジェクトです。これらは、JavaScript の String.prototype.replace() メソッドに引数として渡されます。詳細については、 String.prototype.replace() のドキュメントをご参照ください。

• Function：元の URL 文字列を引数として受け入れる関数です。その戻り値が最終的なページ値として使用されます。

• Array：複数のルールを含む配列で、各ルールは上記のいずれかのタイプになります。

[トップに戻る]

apiHelper

このパラメーターは、API オペレーションに関するページ固有のデータが自動的にレポートされる際に、ページ URL 内の重要でない文字を削除するために使用されます。このパラメーターの使用法と機能は、urlHelper と同じです。

Default value

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

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

このデフォルト設定は、xxxx/123456 のように、API URL パス内の末尾の数字をフィルタリングします。

https://arms.console.alibabacloud.com/apm?pid=fr6fbgbeot の pid パラメーターのように、クエリ文字列 (API URL の ? の後の部分) からパラメーターをレポートする必要がある場合は、手動レポートを使用する必要があります。

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

• api() メソッドを呼び出して、API オペレーションに関するページ固有のデータを手動でレポートします。詳細については、「api()」をご参照ください。

[トップに戻る]

parseResponse

この設定項目は、API オペレーションのページ固有のデータが自動的にレポートされる際に返されるデータを解析するために使用されます。

Default value

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

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 パラメーターの値は、ignoreUrls、ignoreApis、ignoreErrors、および ignoreResErrors の 4 つのプロパティを含むオブジェクトです。パラメーター値の 1 つ以上のプロパティを設定できます。

Default value

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

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

ignoreUrls

ignoreUrls プロパティは、無視する URL を指定します。指定されたパターンに一致する URL からのログはレポートされません。値は、string、正規表現、関数、またはこれらのタイプを含む配列にすることができます。例：

__bl.setConfig({
                ignore: {
                    ignoreUrls: [
                    'http://host1/',  // 文字列
                    /.+?host2.+/,     // 正規表現
                    function(str) {   // 関数
                        if (str && str.indexOf('host3') >= 0) {
                            return true;   // レポートしない
                        }
                        return false;      // レポートする
                    }]
                }
            });                    

ignoreApis

ignoreApis プロパティは、無視する API を指定します。指定されたパターンに一致する API への呼び出しは監視されません。値は、string、正規表現、関数、またはこれらのタイプを含む配列にすることができます。例：

__bl.setConfig({
                ignore: {
                    ignoreApis: [
                    'api1','api2','api3', // 文字列
                    /^random/,  // 正規表現
                    function(str) { // 関数
                        if (str && str.indexOf('api3') >= 0) return true;   // レポートしない
                        return false;   // レポートする
                    }]
                }
            });                    

ignoreErrors

ignoreErrors プロパティは、無視する JS エラーを指定します。指定されたパターンに一致する JS エラーはレポートされません。値は、string、正規表現、関数、またはこれらのタイプを含む配列にすることができます。例：

__bl.setConfig({
                ignore: {
                    ignoreErrors: [
                    'test error', // 文字列
                    /^Script error\.?$/, // 正規表現
                    function(str) { // 関数
                        if (str && str.indexOf('Unknown error') >= 0) return true;   // レポートしない
                        return false;   // レポートする
                    }]
                }
            });            

ignoreResErrors

ignoreResErrors プロパティは、無視するリソースエラーを指定します。指定されたパターンに一致するリソースエラーはレポートされません。値は、string、正規表現、関数、またはこれらのタイプを含む配列にすることができます。例：

__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 がバックグラウンドでレポートされたログを処理する際、ARMS はサンプリング設定に基づいてデータを復元します。このようにして、JS エラー率や API 失敗率などのメトリックはサンプリングの影響を受けず、正確なままです。ただし、このパラメーターを設定すると、API の詳細などの詳細データが取得できなくなる場合があります。

• sample のデフォルト値は 1 です。有効値は 1 から 100 までの整数です。サンプリングレートは 1/sample です。たとえば、1 は 100% のサンプリング、10 は 10% のサンプリング、100 は 1% のサンプリングを意味します。

[トップに戻る]

pvSample

メリット：

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

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

説明：

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

• pvSample のデフォルト値は 1 です。サンプリングレートは 1/pvSample です。たとえば、値 1 は 100% のサンプリング、 10 は 10% のサンプリング、 100 は 1% のサンプリングを意味します。

[トップに戻る]

sendResource

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

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

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

[トップに戻る]

useFmp

[トップに戻る]

enableLinkTrace

[トップに戻る]

release

[トップに戻る]

environment

[トップに戻る]

behavior

[トップに戻る]

autoSendPerf

[トップに戻る]

c1\c2\c3

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

[トップに戻る]