addRelease

構文

newrelic.addRelease(string $release_name, string $release_id)

同一ページに複数のJavaScriptバンドルを使用したリリースを識別するために、一意の名前とIDを追加します。

要件

• Browser Pro または Pro+SPA エージェント (v1016 以降)

• npm を使用してブラウザ エージェントをインストールしている場合は、 BrowserAgentクラスをインスタンス化するときにjserrors機能を有効にする必要があります。features配列に以下を追加します。

  import { JSErrors } from '@newrelic/browser-agent/features/jserrors';
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      JSErrors
    ]
  }

  コピー

  詳細については、 npm ブラウザのインストールに関するドキュメントを参照してください。

説明

ブラウザモニタリングにおいて、リリースとは、アプリケーションのどのバージョンが現在実行されているかという情報をエラーにタグ付けする方法です。これは、共有コンポーネントが異なるチームによって所有されているサイトや、複数のアプリケーションが独立してデプロイされているが同じページで実行されているサイトなどで役立ちます。

最近のウェブアプリケーションは相互に関連する部分が多いため、1つのアプリケーションには、同じページの読み込みに関連する複数の（異なる名前の）リリースが存在する場合があります。例えば、リリースを使って次のようなことができます。

• キャッシュされた古いバージョンのアプリで発生したエラーと、新しいバージョンで発生したエラーの違いを確認できます。
• A/Bテスト、スローロールアウト、機能フラグ、その他の高度なデプロイメント方法で発見された問題を特定します。
• ブラウザのソースマップ のどのバージョンを使用するかを決定します。

JavaScriptのURLが一意でない場合は、ブラウザエージェントへのこのAPI呼び出しでリリース名と識別子を指定する必要があります。この情報は、ソースマップをストレージサービスに公開するときにも必要です。このAPIは、同じページに複数のJavaScriptバンドルがあるリリースを識別するためのブラウザー監視用のIDを追加します。

コードをデプロイするたびにアプリの JavaScript バンドルの URL が 一意である 場合、ブラウザーの監視では、リリースを識別するための追加情報は必要ありません。たとえば、一部のフロントエンド デプロイ ツールは、デプロイされたコードのファイル名に Jenkins ビルド番号または git commit sha を使用します。これらは、エラーの原因となったリリースを一意に特定するのに十分です。

ページの読み込み後、できるだけ早くnewrelic.addRelease()を呼び出します。ブラウザー エージェントが確認するすべてのエラーは、そのバージョンの JavaScript コードに関連付けられます。

パラメーター

例

現在のショートSHA

newrelic.addRelease('checkout page', 'a818994')

セマンティック・バージョニング

newrelic.addRelease('jquery.min.js', 'v3.1.1')