APIによるソースマップのアップロード

エージェントがコード内のエラーをキャプチャするたびに、それが発生したJavaScriptのURLに関連付けられます。これは、HTMLのスクリプトタグのsrc属性です。この完全なJavaScriptURLは、ソースマップをブラウザに送信するときに必要です。

ブラウザのエラーのJavaScriptファイルのURLは、 JS errors ページで確認できます。UIでこれらのエラーを見つける方法については、 ブラウザ監視ソースマップ を参照してください。

多くの組織では、JavaScriptのURLにバージョン番号やハッシュを入れています。これは通常、"バスト" のキャッシュに追加され、ユーザーが最新バージョンのコードを入手できるようにします。このタイプのURLは次のようなものです。

• https://example.com/assets/application-59.min.js

• https://example.com/assets/bundle-d6d031.min.js

• https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.js

  アプリの URL にバージョン情報が自動的に付加されていれば、ブラウザエージェントはコードのエラーを照合するために必要なものをすべて持っていることになります。 ソースマップの生成 に進むことができます。

  この が に該当せず、JS の URL に が のバージョン情報が付加されていない場合は、 のリリース名と ID を API で指定してエージェントを支援する必要があります。

New Relic CodeStream を使用して IDE からコードのパフォーマンスを監視することに関心がある場合は、リポジトリ URL が必要です。IDE からのエラーも調査する場合は、ビルド コミット ハッシュを使用することをお勧めしますが、必須ではありません。

IDE に可観測性を導入することによるパフォーマンスの監視について詳しく学習します。

アップロードできるソースマップの総数に制限はありません。ただし、APIはアカウントごとに料金制限があります。

• 1分間に最大1000枚のソースマップをアップロードできます。

• 1日あたり最大15,000枚のソースマップをアップロードできます。

• APIリクエストごとにアップロードまたは公開できるソースマップは1つだけです。

  ソースマップファイルのサイズは最大50MBです。

YOUR_NEW_RELIC_APP_IDとYOUR_APP_IDはどちらも{ applicationIdの有効な値です。

ここでは、コマンドラインからnpmモジュールを使ってソースマップをアップロードする例を紹介します。ソースマップは、ローカルファイルまたはリモートURLから来ることができることに注意してください。

$
npm install -g @newrelic/publish-sourcemap
$
publish-sourcemap PATH_TO_SOURCE_MAP_FILE (local or remote) PATH_TO_ORIGINAL_FILE --apiKey=YOUR_NEW_RELIC_USER_KEY --applicationId=YOUR_NEW_RELIC_APP_ID --repoUrl=GITHUB_REPOSITORY_URL --buildCommit=GIT_BUILD_COMMIT_HASH

ここでは、公開されたソースマップのリストアップの例を紹介します。

$
list-sourcemaps --applicationId=YOUR_APP_ID --apiKey=YOUR_NEW_RELIC_USER_KEY
Options:
  --applicationId  Browser application id
  --apiKey         New Relic user API key

ここでは、ソースマップを削除する例をご紹介します。

$
delete-sourcemap --applicationId=YOUR_APP_ID --apiKey=YOUR_NEW_RELIC_USER_API_KEY --sourcemapId=YOUR_SOURCE_MAP_ID
Options:
  --applicationId  Browser application id
  --apiKey         New Relic user API key
  --sourcemapId    Unique id generated for a source map

ここでは、Node.jsのスクリプトを使ってソースマップを公開する例をご紹介します。

var publishSourcemap = require('@newrelic/publish-sourcemap').publishSourcemap;

publishSourcemap({
  sourcemapPath: 'SOURCE_MAP_FULL_PATH',
  javascriptUrl: 'JS_URL',
  applicationId: YOUR_NEW_RELIC_APP_ID,
  apiKey: 'YOUR_NEW_RELIC_USER_API_KEY',
  repoUrl: 'GITHUB_REPOSITORY_URL',
  buildCommit: 'GIT_BUILD_COMMIT_HASH'
}, function(err) { console.log(err || 'Sourcemap upload done'); });

ここでは、公開されているすべてのソースマップをリストアップした例を紹介します。

var listSourcemaps = require('@newrelic/publish-sourcemap').listSourcemaps;;

listSourcemaps({
  applicationId: YOUR_NEW_RELIC_APP_ID,
  apiKey: 'YOUR_NEW_RELIC_USER_API_KEY',
  limit: MAX_NUMBER_OF_RESULTS_TO_RETURN || 20,
  offset: NUMBER_OF_RESULTS_TO_SKIP_BEFORE_RETURNING || 0,
}, function(err, res) { console.log(err || res.sourcemaps); });

ここでは、Node.jsのスクリプトを使ってソースマップファイルを削除する例を紹介します。

var deleteSourcemap = require('@newrelic/publish-sourcemap').deleteSourcemap;

deleteSourcemap({
  sourcemapId: 'SOURCE_MAP_ID',
  applicationId: YOUR_NEW_RELIC_APP_ID,
  apiKey: 'YOUR_NEW_RELIC_USER_API_KEY',
}, function(err) { console.log(err || 'Deleted source map'); });

curl経由でAPIを使用し、ブラウザにマップを公開する例です。

$
curl -H "Api-Key: YOUR_NEW_RELIC_USER_API_KEY" \ 
>
    -F "sourcemap=@SOURCE_MAP_PATH" \ 
>
    -F "javascriptUrl=JS_URL" \ 
>
    -F "releaseId=YOUR_RELEASE_ID" \ 
>
    -F "releaseName=YOUR_UI_PAGE" \
>

$
https://sourcemaps.service.newrelic.com/v2/applications/YOUR_NEW_RELIC_APP_ID/sourcemaps

$
curl -H "Api-Key: YOUR_NEW_RELIC_USER_API_KEY" \ 
>
    -F "sourcemap=@SOURCE_MAP_PATH" \ 
>
    -F "javascriptUrl=JS_URL" \ 
>
    -F "releaseId=YOUR_RELEASE_ID" \ 
>
    -F "releaseName=YOUR_UI_PAGE" \
>
    -F "repoUrl=GITHUB_REPOSITORY_URL" \
>
    -F "buildCommit=GIT_BUILD_COMMIT_HASH" \
>

$
https://sourcemaps.service.newrelic.com/v2/applications/YOUR_NEW_RELIC_APP_ID/sourcemaps

以下は、curlを介して以前にNewRelicにアップロードされたソースマップのリストを取得する方法の例です。 New Relicは、ソースマップの一意のSOURCEMAP_IDとそのコンポーネントを返します。

$
curl \ 
>
    -H "Api-Key: YOUR_NEW_RELIC_USER_API_KEY" \ 
>
https://sourcemaps.service.newrelic.com/v2/applications/YOUR_NEW_RELIC_APP_ID/sourcemaps

ソースマップを削除するには

1. GETエンドポイントを使用して、既存のソースマップを一覧表示し、 SOURCEMAP_IDを見つけます。

2. curlで以下のコマンドを実行します。

   bash

   コピー

   $
   curl -X DELETE \
   >
       -H "Api-Key: YOUR_NEW_RELIC_USER_API_KEY" \
   >
   https://sourcemaps.service.newrelic.com/v2/applications/YOUR_NEW_RELIC_APP_ID/sourcemaps/SOURCEMAP_ID