重要
この API を使用するには、ブラウザ エージェントの Browser Pro または Pro+SPA エディションが必要です。
構文
newrelic.addRelease(string $release_name, string $release_id)
同一ページに複数のJavaScriptバンドルを使用したリリースを識別するために、一意の名前とIDを追加します。
要件
エージェントのバージョン nr-1016 以上。
説明
ブラウザモニタリングにおいて、リリースとは、アプリケーションのどのバージョンが現在実行されているかという情報をエラーにタグ付けする方法です。これは、共有コンポーネントが異なるチームによって所有されているサイトや、複数のアプリケーションが独立してデプロイされているが同じページで実行されているサイトなどで役立ちます。
最近のウェブアプリケーションは相互に関連する部分が多いため、1つのアプリケーションには、同じページの読み込みに関連する複数の(異なる名前の)リリースが存在する場合があります。例えば、リリースを使って次のようなことができます。
- キャッシュされた古いバージョンのアプリで発生したエラーと、新しいバージョンで発生したエラーの違いを確認できます。
- A/Bテスト、スローロールアウト、機能フラグ、その他の高度なデプロイメント方法で発見された問題を特定します。
- ブラウザのソースマップ のどのバージョンを使用するかを決定します。
JavaScriptのURLが一意でない場合は、ブラウザエージェントへのこのAPI呼び出しでリリース名と識別子を指定する必要があります。この情報は、ソースマップをストレージサービスに公開するときにも必要です。このAPIは、同じページに複数のJavaScriptバンドルがあるリリースを識別するためのブラウザー監視用のIDを追加します。
コードをデプロイするたびにアプリの JavaScript バンドルの URLが一意である場合、ブラウザーの監視では、リリースを識別するための追加情報は必要ありません。たとえば、一部のフロント エンド デプロイ ツールは、デプロイされたコードのファイル名に Jenkins ビルド番号またはgit commit sha
を使用します。これらは、エラーの原因となったリリースを一意に特定するのに十分です。
ページの読み込み後、できるだけ早くnewrelic.addRelease()
を呼び出します。ブラウザー エージェントが確認するすべてのエラーは、そのバージョンの JavaScript コードに関連付けられます。
パラメーター
パラメータ | 説明 |
---|---|
ストリング | 必須。 コンポーネントの短い説明です。例えば、プロジェクト、アプリケーション、ファイル、ライブラリの名前などです。 |
ストリング | 必須。このリリースの ID またはバージョン。たとえば、バージョン番号、CI 環境のビルド番号、GitHub SHA、GUID、コンテンツのハッシュなどです。New Relic はこの値を文字列に変換するため、必要に応じて
|
例
現在のショートSHA
newrelic.addRelease('checkout page', 'a818994')
セマンティック・バージョニング
newrelic.addRelease('jquery.min.js', 'v3.1.1')