• ログイン無料アカウント

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

英語版と齟齬がある場合、英語版の定めが優先するものとします。より詳しい情報については、本リンクをご参照ください。

問題を作成する

addRelease(ブラウザエージェントAPI)

構文

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コードに関連付けられます。

パラメータ

パラメーター

説明

$release_name

文字列

必須。 コンポーネントの短い説明です。例えば、プロジェクト、アプリケーション、ファイル、ライブラリの名前などです。

$release_id

文字列

必須。 このリリースの ID またはバージョン。たとえば、バージョン番号、CI 環境からのビルド番号、GitHub SHA、GUID、またはコンテンツのハッシュなどです。New Relic はこの値を文字列に変換するため、必要に応じて nullundefined を使用することもできます。

$release_name$release_id の組み合わせは一意である必要があります。

  • 'signup', '2.4.0'

  • 'signup', '2.4.1'

    しかし、同じバージョンを異なるコンポーネントに使用することは可能です。例えば、次のようになります。

  • 'signup', '2.4.0'

  • 'logout', '2.4.0'

現在のショートSHA

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

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

newrelic.addRelease('jquery.min.js', 'v3.1.1')
Copyright © 2022 New Relic株式会社。