Télécharger des cartes sources via API

Chaque fois que l'agent capture une erreur dans votre code, elle est associée à l'URL du JavaScript dans lequel elle s'est produite. Il s'agit de l'attribut de la src script tag dans votre HTML. Cette URL JavaScript complète est requise lors de l'envoi de cartes sources au navigateur.

Vous pouvez trouver l'URL du fichier JavaScript d'une erreur dans le navigateur, sur la page JS errors . Consultez monitoring des cartes sources des navigateurs pour en savoir plus sur la recherche de ces erreurs dans l'UI.

De nombreuses organisations incluent un numéro de version ou un hacher dans l'URL JavaScript. Ceci est généralement ajouté pour « éclater » les caches afin de garantir que votre utilisateur obtienne la version la plus récente de votre code. Ce type d'URL pourrait ressembler à ceci :

• 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

  Si les informations de version sont automatiquement ajoutées aux URL de votre application, l'agent du navigateur dispose de tout ce dont il a besoin pour faire correspondre les erreurs avec votre code. Vous pouvez passer à la génération de cartes sources.

  Si ce doesn't s'applique à vous et que les URL JS n'ont pas d'informations de version ajoutées, vous devrez aider l'agent en spécifiant un nom de sortie et un ID avec l'API.

Si vous souhaitez monitoring les performances de votre code depuis votre IDE à l'aide de New Relic CodeStream, l'URL du référentiel est requise. Si vous souhaitez également enquêter sur les erreurs de votre IDE, le build commit hacher est recommandé, mais pas obligatoire.

Apprenez-en davantage sur le monitoring des performances en intégrant l’observabilité dans l’IDE.

Il n'y a pas de limite au nombre total de cartes sources que vous pouvez télécharger. Cependant, l'API est limitée par compte :

• Vous pouvez télécharger un maximum de 1000 cartes sources par minute.

• Vous pouvez télécharger un maximum de 15 000 cartes sources par jour.

• Une seule carte source peut être téléchargée ou publiée par demande d'API.

  Les fichiers de carte source peuvent avoir une taille maximale de 50 Mo.

YOUR_NEW_RELIC_APP_ID et YOUR_APP_ID sont des valeurs valides pour applicationId.

Voici un exemple de téléchargement de cartes sources à l'aide du module npm via la ligne de commande. Notez que la carte source peut provenir d'un fichier local ou d'une URL distante.

$
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

Voici un exemple de liste de cartes sources publiées :

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

Voici un exemple de suppression d’une carte source :

$
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

Voici un exemple de publication d'une carte source via un script 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'); });

Voici un exemple de liste de toutes les cartes sources publiées :

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

Voici un exemple de suppression d'un fichier de carte source via un script 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'); });

Un exemple d’utilisation de l’API via curl pour publier des cartes dans le navigateur :

$
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

Vous trouverez ci-dessous un exemple montrant comment obtenir une liste des cartes sources précédemment téléchargées sur New Relic via curl. New Relic renvoie le SOURCEMAP_ID unique de la carte source et ses composants :

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

Pour supprimer une carte source :

1. Utilisez le point de terminaison GET pour répertorier les cartes sources existantes et localiser le SOURCEMAP_ID.

2. Exécutez la commande suivante via curl :

   bash

   Copier

   $
   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