Cargar mapas fuente a través de API

Cada vez que el agente captura un error en su código, se asocia con la URL del JavaScript en el que ocurrió. Este es el atributo src de la etiqueta script en su HTML. Esta URL de JavaScript completa es necesaria al enviar mapas de origen al browser.

Puede encontrar la URL del archivo JavaScript de un error en browser, en la página JS errors. Consulte monitoreo de mapas fuente del navegador para obtener más información sobre cómo encontrar estos errores en la UI.

Muchas organizaciones incluyen un número de versión o hash en la URL de JavaScript. Esto generalmente se agrega a los cachés "destruidos" para garantizar que su usuario obtenga la versión más reciente de su código. Este tipo de URL podría verse así:

• 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 las URL de su aplicación tienen automáticamente la información de la versión adjunta, el agente del navegador tiene todo lo que necesita para hacer coincidir los errores con su código. Puede continuar y generar mapas fuente.

  Si esto doesn't se aplica a usted y las URL de JS no tienen información de versión adjunta, deberá ayudar al agente especificando un nombre de versión y un ID con la API.

Si está interesado en monitorear el rendimiento de su código desde su IDE usando New Relic CodeStream, se requiere la URL del repositorio. Si también desea investigar errores de su IDE, se recomienda el hash de confirmación de compilación, pero no es obligatorio.

Obtenga más información sobre el monitoreo del desempeño incorporando la observabilidad al IDE.

No hay límite para la cantidad total de mapas fuente que puede cargar. Sin embargo, la API tiene una tasa limitada por cuenta:

• Puede cargar un máximo de 1000 mapas fuente por minuto.

• Solo se puede cargar o publicar un mapa de origen por solicitud de API.

  Los archivos de mapas de origen pueden tener un tamaño máximo de 50 MB.

Tanto YOUR_NEW_RELIC_APP_ID como YOUR_APP_ID son valores válidos para applicationId.

A continuación se muestra un ejemplo de cómo cargar mapas fuente usando el módulo npm a través de la línea de comando. Tenga en cuenta que el mapa fuente puede provenir de un archivo local o de una URL remota.

$
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

A continuación se muestra un ejemplo de cómo enumerar mapas fuente publicados:

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

A continuación se muestra un ejemplo de cómo eliminar un mapa de origen:

$
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

A continuación se muestra un ejemplo de publicación de un mapa fuente mediante 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'); });

A continuación se muestra un ejemplo de cómo enumerar todos los mapas fuente publicados:

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

A continuación se muestra un ejemplo de cómo eliminar un archivo de mapa fuente mediante 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 ejemplo del uso de API mediante curl para publicar mapas en el 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

A continuación se muestra un ejemplo de cómo obtener una lista de mapas fuente previamente cargados en New Relic a través de curl. New Relic devuelve el SOURCEMAP_ID único del mapa fuente y sus componentes:

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

De forma predeterminada, se recuperan 20 mapas de origen. Para recuperar una cantidad diferente de mapas de origen, agregue ?limit=<NEW-LIMIT> al final de la URL, donde <NEW-LIMIT> es el límite deseado. Puede recuperar hasta 500 mapas de origen a la vez.

Para eliminar un mapa de origen:

1. Utilice el extremo GET para enumerar los mapas fuente existentes y localizar el SOURCEMAP_ID.

2. Ejecute el siguiente comando mediante curl:

   bash

   Copia

   $
   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