Upload source maps via API

Every time the agent captures an error in your code, it's associated with the URL of the JavaScript in which it occurred. This is the src attribute of the script tag in your HTML. This full JavaScript URL is required when sending source maps to browser.

You can find the URL for an error's JavaScript file in browser, on the JS errors page. See Browser monitoring source maps for more on finding these errors in the UI.

Many organizations include a version number or hash in the JavaScript URL. This is generally added to "bust" caches to ensure your users get the most recent version of your code. This type of URL might look something like:

• 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

  If your app's URLs automatically have the version info appended to it, the browser agent has everything it needs in order to match errors with your code. You can move ahead to generating source maps.

  If this doesn't apply to you, and JS URLs do not have version info appended, you’ll have to assist the agent by specifying a release name and ID with the API.

If you're interested in monitoring the performance of your code from your IDE using New Relic CodeStream, repository URL is required. If you'd like to investigate errors from your IDE as well, the build commit hash is recommended, but not required.

Learn more about monitoring performance by bringing observability into the IDE.

There is no limit to the overall number of source maps you can upload. However, the API is rate-limited per account:

• You can upload a maximum of 1000 source maps per minute.

• Only one source map can be uploaded or published per API request.

  Source map files can be a maximum of 50Mb in size.

Both YOUR_NEW_RELIC_APP_ID and YOUR_APP_ID are valid values for applicationId.

Here's an example of uploading source maps using the npm module via the command line. Note that the source map can come from a local file or a remote 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

Here's an example of listing published source maps:

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

Here's an example of deleting a source map:

$
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

Here's an example of publishing a source map via a Node.js script:

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'); });

Here's an example of listing all published source maps:

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); });

Here's an example of deleting a source map file via a Node.js script:

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'); });

An example of using API via curl to publish maps to browser:

$
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

Below is an example of how to get a list of source maps previously uploaded to New Relic via curl. New Relic returns the source map's unique SOURCEMAP_ID and its components:

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

By default, 20 source maps are retrieved. To retrieve a different number of source maps, append ?limit=<NEW-LIMIT> to the end of the URL, where <NEW-LIMIT> is your desired limit. You can retrieve up to 500 source maps at a time.

To delete a source map:

1. Use the GET endpoint to list existing source maps and locate the SOURCEMAP_ID.

2. Run the following command via curl:

   bash

   Copy

   $
   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